Skip to main content

How to Upgrade

info

These instructions are for users of our new Docker-based instance. If you run our older instances (or the old bootstrap script) check the legacy guide.

We recommended you upgrade your Fanar instance to the latest release so you can benefit from new features and bug fixes. This document assumes you used our images to set up your instance of Fanar.

For best results you should upgrade Fanar by one semantic version at a time. To move from V6 to V10, for example, you should upgrade V6 to V7 to V8 to V10.

During each migration, check the releases page for any special notices or breaking changes in the next version.

Below is a table of recent docker release images for your reference:

released_atversiondocker_image
2026-03-0226.3.0fanar/fanar:26.3.0
2025-08-0125.8.0fanar/fanar:25.8.0
2025-01-0825.1.0fanar/fanar:25.1.0
2021-12-2410.1.0fanar/fanar:10.1.0.b50633
2021-10-0210.0.0fanar/fanar:10.0.0.b50363
2019-10-278.0.0fanar/fanar:8.0.0.b32245
2019-03-177.0.0fanar/fanar:7.0.0.b18042
2018-12-176.0.0fanar/fanar:6.0.0.b8537
2018-10-185.0.2fanar/fanar:5.0.2.b5486
2018-09-275.0.1fanar/fanar:5.0.1.b4850
warning

If you are currently running an instance of Fanar prior to V7, do not upgrade directly to V8. Upgrade semantically to V7 first. Read more about this on our forum here.

Upgrade Process

  1. Make sure to backup your data. You need to backup Fanar's PostgreSQL database (the database Fanar stores metadata in, not the ones you might be querying) and your .env file (if it exists). The data in Redis is transient.
  2. Change directory to /opt/fanar.
  3. Update /opt/fanar/compose.yaml Fanar image reference to the one you want to upgrade to.
  4. Stop Fanar services: docker compose stop server scheduler scheduled_worker adhoc_worker (you might need to list additional services if you updated your configuration)
  5. Apply migration (if necessary): docker compose run --rm server manage db upgrade
  6. Start services: docker compose up -d

Done!

info

Getting an error when running docker or docker compose commands?

Make sure the ubuntu user is part of the docker group:

  1. Run sudo usermod -aG docker $USER to add current user to the docker group.
  2. Logout and login again.