Skip to content

Upgrade Guide

Grigory Efimov edited this page Nov 10, 2024 · 4 revisions

This document provides detailed instructions for upgrading between different versions of the project.

General Recommendations

  • Always back up data dir (./storage) and configuration (./etc) before starting the upgrade process.
  • Follow the instructions for the specific version you are upgrading to.

Generic Update Routine

Before the Upgrade

  1. Ensure you have a complete backup of your data and configuration.

Upgrade Process

  1. Update the Git version to a specific tag:
    git checkout <latest tag>
    or to the latest version in the main branch:
    git fetch -pP && git pull
  2. Run the command make update
  3. Optionally, in some cases, it may be necessary to run make upgrade

After the Upgrade

  1. Check logs for any errors. docker-compose logs -f
  2. Verify that all critical functionalities are working as expected.

Upgrading from v1.x.x to v2.x.x

Starting with version 2.0.1, we have switched from s3-emulator to MinIO for storing data uploaded via the any-sync-filenode daemon. To preserve your data, you will need to manually migrate it from s3-emulator to MinIO. For this You can use https://min.io/docs/minio/linux/reference/minio-mc/mc-mirror.html.

Upgrading from v2.x.x to v3.x.x

Starting with version 3.0.0, we have reduced mongo instances from 3 to 1. For correctly working You need reconfigure mongo cluster. After Upgrade please run:

docker compose exec mongo-1 mongosh --port 27001 --eval 'rs.reconfig({_id: rs.conf()._id, members: [{ _id: 0, host: "mongo-1:27001" }]}, {force: true});'

Upgrading from v3.x.x to v4.x.x

You need to transfer your modifications from the .env file to the .env.override file.

Upgrading from v4.x.x to v5.x.x

A new variable has been added to the .env.common file, so before restarting, you need to run make generate_env to regenerate the .env file.

git checkout v5.<X>.<X>
make generate_env
make restart