Client updating
See also: Server updating.
Hint
Keep MultiTaction Canvus client on the latest version to get the latest features and bug fixes.
Before you update
- Copy your working
mt-canvus.ini(see file locations). Up to Canvus 26.11.0 the update merges the file but does not keep a backup copy of it; from 26.11.1 Canvus saves.bakcopies next to it (see What happens when you update). - Optionally, back up your local canvases with
--backup(see Backup and restore). - Close Canvus client.
Update Canvus client
Download the latest Canvus client package from https://apps.multitaction.com/canvus/downloads/ and install it as described in the installation guides.
- Windows: the installer finds the installed version and asks "An old version of MT Canvus was detected. Do you want to uninstall it?" Choose Yes: the installer removes the old version, keeps your configuration files and installs the new one. If you choose No, the installer stops. The installer does not restart Windows.
- Ubuntu: the package is called
mt-canvus, so installing a new version replaces the installed one. The new version installs to its own folder,/opt/mt-canvus-<version>. From Canvus 26.09.6,/opt/mt-canvusand/usr/bin/mt-canvus-apppoint to the installed version, so scripts that use those paths keep working after an update.
Update from the MultiTaction apt repository
On Ubuntu 24.04 you can install and update Canvus client from the MultiTaction apt repository at apt.multitaction.com instead of downloading each package. The repository has two suites:
| Suite | Contents | Use it for |
|---|---|---|
noble-stable |
Release builds | Production walls and desktops |
noble-preview |
Development builds | Testing a coming release on a test computer only |
The repository is signed, and apt checks the signature on every update. To set it up:
-
Download the repository signing key:
sudo curl -fsSL https://apt.multitaction.com/keyring -o /usr/share/keyrings/apt-multitaction.gpg -
Add the repository with the suite you want, here
noble-stable:echo "deb [signed-by=/usr/share/keyrings/apt-multitaction.gpg] https://apt.multitaction.com noble-stable main" | sudo tee /etc/apt/sources.list.d/mt-noble.list sudo chmod 644 /etc/apt/sources.list.d/mt-noble.list -
Install or update Canvus client:
sudo apt update sudo apt install mt-canvus
After that, sudo apt update && sudo apt upgrade installs a new Canvus release when it is published to the suite, together with your other system updates. Do the steps in Before you update first, because an upgrade replaces the running version. To stop automatic upgrades of Canvus on a wall, hold the package with sudo apt-mark hold mt-canvus, and release it with sudo apt-mark unhold mt-canvus when you are ready to update.
What the update does to your configuration
- The installer updates the system-wide
mt-canvus.iniagainst the example file of the new version. On Ubuntu, from Canvus 26.10.4, an upgrade keeps your system-wide file instead of replacing it. - The first time the new version starts, it updates the per-user
mt-canvus.iniin the same way. - Your values are kept and new settings are added as comments. Keys the new example file does not list are commented out. Up to Canvus 26.11.0 so is the
[plugins]section, so plugins you turned off are on again. See What happens when you update.
After the update, check your settings and the Canvus client log files for warnings about deprecated settings.
Going back to an older version
A data folder that a newer version of Canvus has marked as needing that version cannot be opened by an older one. The older version then refuses to start and reports that the data folder "contains data that is not supported by the current version of MT Canvus". To use the older version, restore a backup made with that version, or point content/root at a different data folder (see Data folder and backups).
Upgrading from Canvus 3.4.x to 26.4.0
Version 26.4.0 introduced calendar versioning and changes to the licensing system. See the Upgrading the Canvus client from 3.x to 26.x guide before upgrading from a 3.4.x installation.
Updating to 3.0 from 2.x
The first time you launch Canvus client after updating to 3.0 copies of existing local canvases are made and the new copies are migrated to a new format incompatible with Canvus 2.x. The original local canvases from Canvus 2.x are left as is. If you decide to reinstall Canvus 2.x, your local canvases are available as they were before the migration.
After the initial migration, any changes made to the local canvases using Canvus 2.x are not available in 3.0. Canvus 3.x client cannot connect to Canvus Connect server 2.x.
Tip
Make a backup of your local canvases before updating to 3.0 (see client-backup).
Canvus 3.0 is a major update and changes the way the some options are configured in the Canvus client.
Specifically:
-
The way desktop mode and video wall mode are configured has changed. Canvus can now operate in single user mode or multi-user mode. See client-mode-settings.
-
The way the virtual keyboard behaves and is configured has changed. See client-virtual-keyboard.
-
Note and PDF coordinate system was changed to be consistent with other content types. If you have REST API applications or custom menus that position notes, you may need to adjust those applications to get the same behavior as in 2.7.
-
The data folder used to store local canvases has changed as follows:
%APPDATA%\MultiTaction\canvus-data\data-100to%APPDATA%\MultiTaction\canvus-data\data-300(Windows)~/MultiTaction/canvus-data/data-100to~/MultiTaction/canvus-data/data-300(Linux)
-
The default protocol and port the Canvus client uses to connect to Canvus Connect server have changed:
Canvus 2.x Canvus 3.x
Default connection protocol TCP SSL Default port for SSL connection 5804 443 Default port for TCP connection 5801 80
: New default connection settings for Canvus client
If you need to change the default settings to match the old behavior in Canvus 2.x, see client-configure-canvus-connect in the client configuration. Please ensure your server configuration and client configuration match.
Tip
Canvus client will log warnings about using deprecated configuration variables from 2.x in its log file.
Check the Canvus client log files after updating and restarting your client to address any warnings you might see about using deprecated configuration variables.
Canvus client installation includes a reference configuration file that can be used as an example to compare with your working configuration file. See client-config-file for the location of the example configuration file.
Troubleshooting
If you experience problems after an update, you can re-install the previous version of Canvus client. See Going back to an older version for the case where the older version does not accept the data folder.
You can also optionally restore your backup if you made one. See client-backup for more information.