Upgrading a Self-Hosted Server
How to upgrade a self-hosted Scanopy server and daemon, with Docker Compose or a native binary install.
Upgrade the containers
Pull the latest images and recreate the containers:
docker compose pull
docker compose up -dThis upgrades both the server and any daemons defined in your compose file. Volumes are preserved, so no re-registration or reconfiguration is needed.
If the pull fails, see Docker Pull or Download Fails.
If you use the integrated daemon, do not delete the daemon-config volume during upgrades — it
stores the daemon's identity (ID, API key, and site assignment). That identity is provisioned
once at server setup and cannot be re-derived, so deleting the
volume means provisioning the daemon again from scratch.
Add a license key to a Community server
Upgrade the server to v0.17.17 or later, then copy your key from Settings > License in Scanopy Cloud.
Add it to the .env file next to the compose file as SCANOPY_LICENSE_KEY=your-license-key-here, then run docker compose up -d. docker compose restart keeps the old environment and doesn't read the key.
A server with an online key is read-only until its first check-in succeeds, so it needs outbound HTTPS to app.scanopy.net:443 first. If it stays read-only, see License Key Set, Server Stays Read-Only or Community.
Upgrade your daemons
Upgrading the containers covers the integrated daemon. If it still shows Outdated afterwards, see Integrated Daemon Still Shows Outdated. Daemons on other hosts keep their version. When a release asks for a daemon upgrade, they show Outdated until you upgrade them, as in Upgrading Daemons.
Release notes after an upgrade
After the server first starts on a new version, each user sees a What's new in Scanopy window with the notes for the releases since the version they last saw.
If SMTP is configured and the release is marked for email, the server also emails the notes to every verified user, once per version. The email carries that release's notes only. Without SMTP the email waits, and the first start with SMTP configured sends it.
To hold the email, for example while you check the upgrade, start the server with SCANOPY_HOLD_RELEASE_EMAIL=true. The first start without it sends the email.
Each user turns these emails off with Release notes under Settings > Email.
Product names and logos are trademarks of their respective owners. See credits.