Upgrade the Core
Move a Synnax Core to a newer version, then update the Console and standalone Drivers.
Upgrade a Synnax Core to get new features and fixes. When the Console finds a Core that is older than the Console, it shows Incompatible Core version with an Update Core button.
Before you upgrade
- Check the version of your Core with
synnax --version. You can upgrade in one step from v0.47.0 or later to the current release. Upgrades from v0.46 or earlier are not supported. - Read the release notes of each version after yours.
- Check that your license covers the new version. Core 0.60 and later accept only signed license keys from the portal, so get one before you upgrade from 0.59. See numeric license keys. After the license term ends, a license with a version cap covers only versions up to the cap. See expiry.
- Stop the Core. Press Ctrl+C in its terminal, or stop its service.
- Copy the data folder of the Core to a safe place. The data folder holds all data, metadata, and the stored license key. See Back up the Core.
The new Core changes the data folder when it first starts. An older Core cannot always read it after that, so the copy is the only way back.
Upgrade
Linux
Windows
macOS
Docker
Download the new binary:
curl -LO https://github.com/synnaxlabs/synnax/releases/download/core/v0.60.0/synnax-v0.60.0-linuxReplace the binary that the Core runs from. For a Core in /usr/local/bin:
sudo mv synnax-v0.60.0-linux /usr/local/bin/synnaxMake the binary executable:
sudo chmod +x /usr/local/bin/synnaxStart the Core with the same flags and from the same folder as before, so it uses the same data folder. For a service, start the service.
-
If the Core runs as a service, stop it and wait until it stops:
synnax service stop synnax service status -
Download and run the new installer:
Download Synnax v0.60.0 for Windows
The installer replaces the Core and installs the service again. The service keeps its
settings in C:\ProgramData\Synnax\config.yaml, which the installer does not change. If
you clear Install Synnax as a Windows Service, the installer removes the service.
Download the new binary:
curl -LO https://github.com/synnaxlabs/synnax/releases/download/core/v0.60.0/synnax-v0.60.0-macosReplace the binary that the Core runs from. For a Core in /usr/local/bin:
sudo mv synnax-v0.60.0-macos /usr/local/bin/synnaxMake the binary executable:
sudo chmod +x /usr/local/bin/synnaxStart the Core with the same flags and from the same folder as before, so it uses the same data folder.
-
Pull the new image. Use a version tag, such as
synnaxlabs/synnax:0.59.0, so you can go back to the old image:docker pull synnaxlabs/synnax:<version> -
Remove the old container. The data and the certificates stay in their volumes:
docker stop synnax && docker rm synnax -
Start a new container with the same options, volumes, and flags as the old one. The license is bound to the
--mac-address, so keep the same address. Keep the certificate volume, or--auto-certmakes a new CA that your clients do not trust:docker run -d --name synnax --mac-address 02:5a:00:00:00:01 \ -p 9090:9090 -v synnax-data:/synnax/synnax-data \ -v synnax-certs:/usr/local/synnax/certs \ synnaxlabs/synnax:<version> <the same flags as before>
On its first start, the new Core logs running migrations and one migration completed
line for each change to stored data. Wait for
Synnax is running and available at <address>. If the Core stops during a migration,
the migration rolls back, and the next start runs it again.
To check the version, run synnax --version.
Update the Console and Drivers
- Console app -> the Console checks for updates and shows Update available. Click it to update.
- Console in a browser -> updates with the Core.
- Standalone Drivers -> install the new release on each computer. See Install a standalone Driver.
The Console, the client libraries, and the Driver warn when their major or minor version differs from the Core. They still connect. Upgrade the Core first, then the Console and Drivers. A Console older than 0.60 shows errors instead of the activation screen when a Core 0.60 has no license, so upgrade the Console with the Core.
Synnax Desktop has its own Core, which updates with the app. Synnax Desktop backs up its metadata before each update.
Go back to an earlier version
Synnax does not support a downgrade. To go back, stop the Core, replace the data folder with the copy you made before the upgrade, then start the earlier version.