Upgrading CompassDocs

Updated

Back up, read the version notes, and update a Docker Compose install of CompassDocs to the latest release.

CompassDocs updates its own database schema when it starts, so upgrading is usually just "get the new image and restart". Your data is kept.

1. Check whether an update is available

As an Admin, open Settings → System → Version & updates. It shows your current version and whether a newer release is out. When you're behind, it links to the release notes and shows the exact upgrade command.

2. Read the version notes

Some releases ask you to do something before or after upgrading, or can't be rolled back. Read the version notes for every version between yours and the new one.

Upgrading from before 1.20.27?

1.20.27 is a security release. Take a backup first and don't roll back by pinning the old image: passwords used under 1.20.27 can't be checked by earlier versions. To go back, restore the backup instead. The version notes list what else to check, such as setting a workspace address.

3. Back up first

Open Settings → Backups and choose Back up now. Download the backup if you'd like a copy off the server.

Keep your master key safe

Restoring an encrypted backup on a new server needs the same master key. Keep a copy somewhere that isn't your backup storage, such as a password manager.

4. Update

From your install folder (the one with docker-compose.yml):

Runbash
docker compose pull && docker compose up -d

This works for both the Community and Enterprise images. It pulls the latest image and recreates the app container. Re-running the install script does the same thing.

5. Check it worked

  • Settings → System → Version & updates shows the new version.
  • You can sign in. (Session handling can change between versions, so you may need to sign in again.)
  • Anything the version notes asked you to do is done.
Staying on a specific version

Set COMPASSDOCS_VERSION (Community) or COMPASSDOCS_EE_VERSION (Enterprise) in your .env, then run the same two commands.

Something go wrong? Raise a CompassDocs: Technical support (self-hosted) request at docs.felixazsolutions.com/support with your version and logs. See Finding your version and collecting logs in this help centre.

Full details: Updating and Backups and restore.

Still need help?

Raise a request and we'll get back to you by email.

New request