Update Ottertrail
Each release publishes a Docker image and a compose.yaml that runs it. To update, you replace compose.yaml and start the stack again.
Before you update
Section titled “Before you update”- Read the release’s notes. A release that adds a required setting names it there. Compose stops until
.envhas the setting. - Make a backup. See Backups and restore.
Update to the latest release
Section titled “Update to the latest release”-
Go to the instance’s folder.
-
Download the new release’s
compose.yamland backup scripts. They replace the old files:Terminal window curl -fLO https://github.com/ottertrail/ottertrail/releases/latest/download/compose.yamlcurl -fLO https://github.com/ottertrail/ottertrail/releases/latest/download/backup.shcurl -fLO https://github.com/ottertrail/ottertrail/releases/latest/download/restore.shchmod +x backup.sh restore.sh -
Download the new image:
Terminal window docker compose pull -
Start the stack:
Terminal window docker compose up -d
Compose runs migrate, then replaces the API and the worker. The API is not available for a few seconds while its container changes. The tracker sends again the events that it could not send.
Run a specific release
Section titled “Run a specific release”OTTERTRAIL_VERSION in .env selects the release, such as:
OTTERTRAIL_VERSION=0.2.0Then run docker compose pull and docker compose up -d.
This works only while the Compose file is the same in both releases. The release notes say when the Compose file changes. When it changes, download that release’s compose.yaml in place of setting the version.
Go back to an earlier release
Section titled “Go back to an earlier release”You can go back only when no migration ran between the two releases. The instance runs migrations forward only, and an older release may not work with a newer schema.
- Use the earlier release’s
compose.yaml, or set its version inOTTERTRAIL_VERSION. - Run
docker compose pullanddocker compose up -d.
If a migration ran, restore the backup that you made before the update.