Skip to content

Upgrading

Images are tagged with a semantic version (lukeacl/clacks:1.2.3) plus latest. Pin a version in production and upgrade deliberately.

Upgrade

sh
# with a pinned tag: bump the tag in docker-compose.yml first
docker compose pull
docker compose up -d

The database schema migrates automatically and forward-only on boot — the new version applies any pending migrations before serving. A large mailbox can take a few extra seconds on first start after an upgrade (e.g. search-index rebuilds); watch docker compose logs -f clacks.

Check what's running

sh
docker compose exec clacks clacks version

Logged-in webmail users can also see it at the bottom of the sidebar.

Before major upgrades

Take a backup first (it's one command, and you should have dailies anyway):

sh
docker compose exec clacks clacks backup

Rolling back

Schema migrations are not reversed. To roll back a version, restore the pre-upgrade backup on the older image using CLACKS_RESTORE_FROM — see Backups & restore.

Licensed under AGPL-3.0 · GNU Terry Pratchett