Skip to content

Updating

Hint

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

To update an existing installation of Canvus server to the latest version, do the following:

Ubuntu:

Run the following commands:

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

Windows:

Download and install the latest server package from https://apps.multitaction.com/mt-canvus/canvus-downloads.html

Normally updates won\'t require any extra steps. However, if you are performing a major update, for example from 2.x to 3.x, see the sections below for more information.

Updating to 3.0 from 2.x

Warning

The update process will affect data stored on your Canvus server by migrating it to a new format incompatible with Canvus 2.x. This process can not be reversed and you can not go back to an earlier version of Canvus server after the update without restoring a backup. A backup of your data is automatically created during the update (see server-backup).

Canvus 3.0 is a major update and changes the way the server is configured on some parts. Some configuration variables are no longer supported and others have been renamed. The Canvus server 3.0 tries to retain backwards compatibility with configuration files from 2.x, but some combinations of configuration variables are no longer allowed in the new version.

Note

Old Canvus clients running version 2.x will not be able to connect to Canvus Connect server 3.0 or newer.

Connections to the server

The way Canvus 3.0 server handles connections has changed. In Canvus 2.x, the server would use multiple different ports to listen for connections:

  • TCP connections from Canvus client at port 5801
  • SSL connections from Canvus client at port 5804 (not enabled by default)
  • HTTP connections from web browsers at port 8080 (not enabled by default)
  • HTTPS connections from web browsers at port 3001 (not enabled by default)
  • HTTP(S) connections to REST API at port 8090 (not enabled by default)

The way all of these settings are configured has changed. In Canvus 3.0, the server uses an internal reverse proxy and accepts all connections through a single port. This includes the proprietary TCP and SSL protocols from Canvus client and also HTTP(S) connections to the web UI and REST API.

By default, Canvus 3.0 listen to SSL and HTTPS connections in port 443. SSL is enabled by default. Canvus also optionally redirects traffic from port 80 to port 443. This redirection is enabled by default. Canvus 3.0 also enables REST API and the web UI by default and these can no longer be disabled.

If you need to adjust these default settings in the Canvus 3.0 server, see server-configuration-connections under server administration.

Codice cards

The Codice server in Canvus 3.0 no longer supports Codices that act as shortcuts to open to local canvases or canvases stored on a different server. In Canvus 3.0, all canvases that you want to open with a Codice card shortcut must be stored on the same server that is acting as Codice server.

Password protected canvases

Password protected canvases are only supported on local canvases in Canvus 3.0. Shared canvases on a Canvus Connect server use users and permissions to manage access.

When migrating from 2.x, all password protected canvases on Canvus Connect server will be placed in a \"Lost & Found\" folder in the root of the server and made owned by System user. An administrator user must move the canvases and adjust their permissions manually after the update.

Removed server configuration options

The following list of configuration options from Canvus 2.x in the mt-canvus-server.ini have been removed in Canvus 3.0 and no longer have any effect:

  • All settings under [dashboard] section
  • All settings under [rest-api] section
  • All settings under [tcp] section
  • All settings under [ssl] section

A new server configuration file template is included with Canvus 3.0 which you can use as reference when migrating your configuration from Canvus 2.x.

Tip

We recommend you check the Canvus server log files after updating and restarting your server and address any warnings you might see about deprecated configuration variables.

Canvus server installation includes a reference configuration file that can be used as an example to compare with your working configuration file. See server-config-file for the location of the example configuration file.

Administrator account

The update process for Canvus Connect server from 2.7 to 3.0 does not automatically create any user accounts on the system. You must manually create an administrator user account to be able to configure the server using the web UI.

See instructions in the installation manual for creating an administrator user account on Windows or Linux.

Troubleshooting

If you experience problems after an update, you can always re-install the previous version and restore your backup. See server-backup for more information.