Upgrade
Move an installation to a new Orlok version safely.
Upgrades replace the containers and keep the data: the database lives in the db-data volume and
migrations are applied automatically when the app starts.
Versioned releases with a changelog and guided upgrades are on the roadmap. Until then, new versions are delivered as an updated installation package.
Before you start
- Read the notes that come with the new version.
- Back up the database and make sure you have
ORLOK_SECRET_KEY. - Plan a short maintenance window: running conversations and jobs are interrupted while the app restarts.
Upgrade
Replace the files of the installation package with the new ones, keeping your .env.production. Then
compare it with the new .env.production.example: add any new setting before starting.
Rebuild and restart:
docker compose --env-file .env.production up -d --build
Watch the app start and apply migrations:
docker compose --env-file .env.production logs -f app
When the app answers again, sign in and check an office, a conversation and the wiki.
Upgrading from a version before 5 October 2026
That release made colleagues and credentials personal, and its migrations delete data that has no place in the new model. There is no rollback script: take the backup with the app stopped and keep the previous installation package, which together are the way back.
What changes:
- office credentials, the accesses and policies of colleagues, and the commands administrators allowed for everyone are removed;
- commands people allowed for good are removed too, because turned into command types they would allow more than each person approved;
- hosts stay, in one registry for the installation; a name used in two offices gets the office name added;
- existing colleagues pass to the first administrator, who is granted the profiles they use so they keep answering, and the conversations other people had with them are deleted.
After the upgrade, administrators grant profiles to people, and each person adds their own credentials and creates their own colleagues.
If something goes wrong
Migrations only move forward. To return to the previous version, stop the installation, restore the backup taken before the upgrade and start the previous installation package again.