Skip to content

Upgrade

Before upgrading, read the Brokerr changelog for breaking storage, bootstrap, OAuth, or provider behavior changes.

  1. Stop active batches and wait for writes to finish.
  2. Record the current Brokerr version and database schema shown in About/Diagnostics.
  3. Preserve config.yml, app.db, and the master key separately.
  4. Confirm enough free disk space for a replacement image and database migration.
  5. Pull the intended release commit or tag, not an arbitrary working branch.

SQLite must be copied only while Brokerr is stopped unless you use SQLite’s online backup API. Brokerr does not yet provide managed backup/restore.

Terminal window
docker compose down
git pull --ff-only
docker compose build --pull brokerr
docker compose up -d brokerr
docker compose logs -f brokerr

Verify login, Diagnostics, source/target reachability, OAuth identity, scheduler next-run previews, and a dry incremental sync before resuming live schedules.

Legacy split YAML configurations and incompatible legacy databases are rejected instead of being silently interpreted. Follow the release-specific migration instructions when the startup error identifies an unsupported schema.