Skip to content

Updating

Tip

We recommend always updating Canvus server to the latest version to get the latest features and bug fixes.

Update a containerised deployment

Updating pulls new images and restarts the containers. Your data in /canvus-data/ is preserved.

sudo podman-compose pull
sudo podman-compose down
sudo podman-compose up -d

The new version starts and performs any necessary database migrations automatically.

Note

Always create a backup before updating. See backup-and-restore.

Verify the update

sudo podman-compose ps

Both canvus-postgres and canvus-combined should show as running. Then open https://your-server and confirm the new version is shown in Admin area > Settings > About.

Legacy bare-metal installation

Ubuntu:

sudo apt-get update
sudo apt-get install mt-canvus-server3

Windows:

Download and install the latest server package from the Canvus downloads page.

Normally updates require no extra steps. For major version upgrades (e.g. 2.x → 3.x), see the sections below.

Updating to 3.0 from 2.x

Warning

This update migrates data to a format incompatible with Canvus 2.x. It cannot be reversed without restoring a backup. A backup is automatically created during the update.

Canvus 3.0 changes how the server is configured. Some configuration variables were removed or renamed. The server attempts backward compatibility with 2.x configuration files, but some combinations are no longer allowed.

Note

Canvus 2.x clients cannot connect to Canvus Connect server 3.0 or newer.

Connections to the server

In 2.x, the server used multiple ports (5801 TCP, 5804 SSL, 8080 HTTP, 3001 HTTPS, 8090 REST API). In 3.0, all connections use a single port (default 443) via an internal reverse proxy.

Removed configuration options (2.x → 3.0)

All settings under these sections were removed: - [dashboard] - [rest-api] - [tcp] - [ssl]

Administrator account after 2.x → 3.0 update

The update does not automatically create user accounts. You must manually create an administrator account via the web UI or CLI after updating.

Troubleshooting

If you experience problems after an update, re-install the previous version and restore your backup. See backup-and-restore.