Client licensing
See also: Server licensing.
MultiTaction Canvus client must have an up-to-date license (licence). The license defines the scope of your deployment. For example, it specifies the maximum size of the screen that Canvus client will run.
You must obtain an activation key from your MultiTaction representative. You can then use this key to generate and activate your Canvus client license. Alternatively, if your host server cannot connect to the internet, you can use the activation key to generate a license request. For details about where activated licenses are saved, see client-license.
License wizard modes
The license wizard appears under three conditions:
- No license required: when a valid, in-date license is present, the wizard does not open at startup and Canvus starts normally. You can still open it yourself; see Open the license wizard.
- Grace period: when a license has expired but is still within the 14-day grace period, the wizard opens automatically at startup. You can click Skip to dismiss it and continue using Canvus during the grace period, or activate a new license immediately.
- Forced: when there is no valid license, or the license has expired beyond the grace period, you must activate a license to continue. The wizard cannot be skipped.
The wizard also has a button to request a free trial license.
Reminders and notices
- Renewal reminder: when the license expires within 7 days, Canvus shows a reminder at start-up and when you switch canvases. Renew the license before it expires.
- No internet after activation: Canvus does not need to reach the MultiTaction license service after the license is activated. A computer without internet access, activated online or offline, keeps running until the license expires. Plan the renewal before the expiry date; for an offline computer, see Generate a license request while offline.
- License could not be verified: if a license file is installed but is not valid, for example because it has expired beyond the grace period, and you close the wizard without activating a license, Canvus tells you the license could not be verified and exits.
The renewal reminder and the wizard do not appear when dialogs are disabled, for example under MT Launcher or on a video wall (see Open the license wizard). Without a valid license, Canvus then exits with code 3, or code 7 when the installed license covers only older versions of Canvus.
Which computer a license belongs to
A license is activated for one computer. From Canvus 26.10.4, Canvus identifies the computer by the operating system's machine ID instead of the MAC address of a network adapter, so adding a virtual, VPN or USB network adapter no longer uses another license seat. Licenses activated against a MAC address stay valid, and a new activation on the same computer moves its existing activation instead of taking another seat.
The machine ID is /etc/machine-id on Ubuntu, the MachineGuid value that Windows creates at installation, and the hardware UUID on macOS. A license file copied to a computer with a different machine ID does not work: Canvus reports that the host ID of this machine does not match the license. When you prepare one disk image for several computers, empty the machine ID before you capture an Ubuntu image, with sudo truncate -s 0 /etc/machine-id, so that each computer creates its own at first boot. On Windows, make sure each computer has its own MachineGuid. Each computer needs its own activation.
Open the license wizard
The wizard opens by itself when you start Canvus client without a valid license, from the MT Canvus shortcut on Windows, your applications menu on Ubuntu, or the Applications folder on macOS.
To open it at any other time, for example to replace a license that is still valid, close Canvus client first, then run:
- Windows: double-click
activation-wizard.batinC:\Program Files\MT Canvus\bin. -
Ubuntu, in a terminal on the Canvus computer's desktop:
/opt/mt-canvus/bin/mt-canvus-app --activation-wizard -
macOS, in Terminal:
"/Applications/MT Canvus.app/Contents/MacOS/mt-canvus-app" --activation-wizard
Canvus client closes when you finish or cancel a wizard opened this way, so start it again afterwards.
Use the same method if the wizard does not open by itself:
- Launcher: Launcher starts Canvus client with dialogs disabled, so an unlicensed client exits without showing the wizard. Exit Launcher first.
- Video walls: the wizard does not open by itself if any window in
screen.xmlis set to stay on top or to bypass the window manager, which is typical on a video wall.
If Canvus client is still running, you get an "already running" error instead of the wizard.
Obtain an activation key
Your MultiTaction representative will provide you with an activation key for your Canvus client license. After receiving your activation key, you can:
- Activate your license. Choose this option if your Canvus client is currently connected to the internet; see activate-client-license.
- Request a license. Choose this option if your Canvus client is not connected to the internet; see generate-client-license-request.
Activate your license
The license wizard is the recommended way to activate Canvus client. Use it unless you cannot, for example on a headless computer or during an unattended or scripted deployment. In those cases, see activate-client-cli below.
If your Canvus client is connected to the internet, you can submit your activation key to automatically request, receive and activate a license for the current computer.
- Open the license wizard.
- Next to This device, click Meeting Room or Desktop / Laptop. Next stays disabled until you choose. Versions before 26.10.3 do not show this choice.
- From the drop-down list, choose Online: Use activation key to register online. Then click Next.
- When prompted, enter your Canvus activation key. Then click Next.
- Wait while your Canvus license downloads. Then click Finish. Your Canvus installation is now licensed and activated.
- If the wizard opened by itself, Canvus now starts automatically. If you opened it with
--activation-wizardoractivation-wizard.bat, start Canvus client yourself.
Laptops activated as Meeting Room before 26.10.3
Before Canvus 26.10.3 the wizard skipped the device choice and chose Meeting Room, so a laptop on a multi-product key could take a meeting-room seat. Updating does not move existing activations. Reactivate such a computer against a Desktop / Laptop seat, and deactivate its old Meeting Room activation to release that seat.
Online activation connects to ls2026.multitaction.com over HTTPS (TCP 443). The trial request and the offline activation portal use the same host, and Canvus uses no other host for licensing. The wizard saves the license for the account that runs it; see where is my client license.
Activate your license from the command line
Use this method only if the license wizard is not available to you. Your Canvus client must be connected to the internet to use this method.
The Canvus client binary accepts an --activate option, which requests, receives and activates a license for the current computer in a single step.
The license is saved in the license folder of the account that runs the command; see where is my client license. Run it as the account that will run Canvus, not with sudo: with sudo the license is saved for root and Canvus does not find it.
Ubuntu
Run:
$ /opt/mt-canvus/bin/mt-canvus-app --activate <key>
Where <key> is your license activation key, including the hyphens. For example:
$ /opt/mt-canvus/bin/mt-canvus-app --activate ABCD-AC2D-HGF6-HVD2
The package installs to a version-specific folder, /opt/mt-canvus-<version>. From Canvus 26.09.6 it also points the symlink /opt/mt-canvus and the command /usr/bin/mt-canvus-app at the installed version, so the path above works whatever version is installed, and mt-canvus-app --activate <key> works as well. On older versions, use the versioned path, for example /opt/mt-canvus-26.09.5/bin/mt-canvus-app; list the installed versions with ls -d /opt/mt-canvus-*.
Windows
Open a command prompt and run:
"C:\Program Files\MT Canvus\bin\mt-canvus-app.exe" --activate <key>
For example:
"C:\Program Files\MT Canvus\bin\mt-canvus-app.exe" --activate ABCD-AC2D-HGF6-HVD2
Bundle and suite keys
A bundle or suite activation key (such as a Canvus Connect suite key) covers more than one product, so the licensing service cannot tell which seat pool the activation should draw from. Use the --product-type option to name the product:
$ /opt/mt-canvus/bin/mt-canvus-app --activate ABCD-AC2D-HGF6-HVD2 --product-type canvus_meeting_room
The accepted product types are:
canvus_meeting_roomcanvus_desktop_laptop
Your MultiTaction representative will tell you which one applies to your key. Activation keys that cover a single product do not need this option. If a key needs --product-type and you leave it out, activation fails and Canvus prints the commands to run instead. New in 26.07.7.
The --product-type option applies to --create-license-request in the same way; see the offline sections below.
Generate a license request while offline
If your host server cannot connect to the internet, you can generate a license request file for your Canvus client.
Tip
If the license wizard is not available to you, the Canvus client binary can create the request file directly: /opt/mt-canvus/bin/mt-canvus-app --create-license-request <key> on Ubuntu, or "C:\Program Files\MT Canvus\bin\mt-canvus-app.exe" --create-license-request <key> on Windows. Add --product-type <type> for a bundle or suite key. The request file is written to your home folder (Documents on Windows).
- Open the license wizard.
- Next to This device, click Meeting Room or Desktop / Laptop. Next stays disabled until you choose. Versions before 26.10.3 do not show this choice.
- From the drop-down list, choose Offline: Create license request. Then click Next.
- When prompted, enter your license activation key. Then click Next.
- Save the generated offline request file. The wizard creates an HTML request file, for example
MT-Canvus-offline-request.html, in your home folder (Documents on Windows). You can copy this file to a USB device if the Canvus computer is offline. - On a computer with internet access, open the generated HTML request file and follow the upload-portal link shown in the file. The portal URL is generated for the activation key and included in the request file.
- Upload the request file in the portal. The portal returns a license file, for example
license-XXXX.html. The license file is an HTML document with the license embedded; you can open it in a browser to see the license details and instructions. Legacy.cslicenselicense files remain valid and are activated the same way. - Copy the returned license file to your Canvus computer, then install it as described below.
Next, see Activate your license while offline.
Activate your license while offline
The license wizard has no step for installing a license file you receive from the portal. Copy the file into the license folder yourself:
- Close Canvus client.
- Copy the license file you received from MultiTaction into the license folder for the account that runs Canvus client. Create the folder if it does not exist. Do not rename the file; it must keep its
.htmlextension (or.cslicensefor a legacy license).- Windows:
%LOCALAPPDATA%\MultiTaction\Licenses - Ubuntu and macOS:
~/MultiTaction/Licenses
- Windows:
- Start Canvus client. It reads the license at startup.
To license every account on the computer, use %PROGRAMDATA%\MultiTaction\Licenses on Windows or /etc/MultiTaction/Licenses on Ubuntu and macOS instead; see client-license.
Tip
If you installed Canvus client in desktop mode, it automatically opens in full screen mode. To toggle out of full screen mode and into windowed mode, press F11.