Client configuration file
See also: Server configuration, Settings index.
This page describes how to configure MultiTaction Canvus client by editing its configuration file, mt-canvus.ini. It lists every setting the client reads that you may change, with its section, key, default value and meaning.
You can also edit most of these settings in the app
From Canvus 26.4.0, most of the settings on this page can be edited in the Settings page inside Canvus (Settings > Client > Configuration). The Settings page writes to the same mt-canvus.ini file described here. Use the file directly when you need a setting the Settings page does not show, when you script a deployment, or when Canvus is not running. The Settings index maps each Settings page control to its key on this page.
About mt-canvus.ini
The file uses the INI format: [section] headers, key=value lines, and comments that start with ;. In this reference a setting is written as section/key, for example system/lock-config is the lock-config key in the [system] section. Most keys are commented out in the example file; remove the leading ; to set them.
On Windows, write a backslash in a path as \\ or use / instead, for example C:\\CanvusFolder or C:/CanvusFolder.
Each Canvus installation has these copies of mt-canvus.ini:
- An example version that ships with the application, for reference. Canvus also uses it as the template when it creates or updates a working file. Installing a new version replaces it. Do not edit it.
- A working version that Canvus reads. There can be a per-user file and a system-wide file. See file locations for the paths on each platform.
Note
When you configure Canvus client, always edit the working version of the configuration file.
Which file Canvus reads
Canvus looks for the per-user file first and then for the system-wide file. It reads the first file it finds and ignores the other one. The two files are not combined: as soon as a per-user file exists, nothing in the system-wide file applies to that user. If neither file exists, Canvus uses its built-in defaults and creates a per-user file from the example the first time it starts.
- Ubuntu: the package creates the system-wide file
/etc/MultiTaction/canvus/mt-canvus.inifrom the example on a fresh install. Because that file exists, Canvus does not create a per-user file, and every user reads the system-wide file. From Canvus 26.10.4 an upgrade keeps this file and merges new settings into it; earlier packages replaced it with the example. Purging the package (apt purge) removes it. - Windows: the installer does not create a system-wide file. If you want one, create
%PROGRAMDATA%\MultiTaction\canvus\mt-canvus.iniyourself, and remove any per-user file that would shadow it. - Any platform: start Canvus with
--mt-canvus-config <file>to read a specific file instead. See command-line arguments.
The Configuration page in Settings saves changes to the user's own per-user file. From Canvus 26.11.1, if Canvus is reading the system-wide file, the page first creates the per-user file as a copy of the system-wide file, and Canvus reads the per-user file from the next start. Earlier versions saved to the file Canvus was reading, which on Ubuntu failed for the system-wide file unless you changed its permissions.
Default canvas, Default colours and Virtual keyboard in Settings > Client save differently. If Canvus is reading the system-wide file, they write a new per-user file that contains the system-wide settings plus the change. From then on that user reads the per-user file, and later changes to the system-wide file no longer apply to them.
Canvus reads the file when it starts. Changes made in a text editor or on the Configuration page take effect after a restart. A new default canvas or keyboard layout list chosen from Settings > Client takes effect at once; new default colours apply to canvases created after a restart.
What happens when you update
When a different build of Canvus starts for the first time, it updates your per-user file against the new example file. The installer does the same for the system-wide file. From Canvus 26.10.4 this happens for every new build, not only for every new release.
- Values you set are kept.
- Settings that are new in the example are added, commented out, so you can find them.
- Keys and sections that the example does not list are commented out, with a
; NOTE:line above them. Older key names that Canvus still understands (see Deprecated keys) are moved to their current name instead. - Canvus writes a
[meta]section with aconfig-versionkey to record the build that last updated the file. Do not edit it. - From Canvus 26.11.1, Canvus first saves a copy of the file next to it as
mt-canvus.ini.<date-time>.bakand keeps the five most recent copies. If it cannot make the copy, it leaves the file unchanged.
Back up your configuration before you update
Up to Canvus 26.11.0 the update does not keep a backup copy of mt-canvus.ini. Copy the file before you install a new version. If an update commented out a setting you need, remove the leading ; from that line, or restore it from a .bak copy.
Settings the update comments out in Canvus 26.11.0 and earlier
Up to Canvus 26.11.0 the example file has no [plugins] section and does not list identity/asset-directory, so the update comments out the plugin settings described in Plugins and a custom asset folder. Plugins you turned off are on again after the update, and Canvus starts using the default asset folder. After each update, check Settings > Client > Configuration > Plugins and the [identity] section of mt-canvus.ini. From Canvus 26.11.1 the update keeps both.
Canvus does not update a file you name with --mt-canvus-config.
MT Launcher configuration
On Windows, the Canvus installer writes the MT Launcher configuration at install time from a bundled template into %PROGRAMDATA%\MultiTaction\launcher\apps\mt-canvus-<version>.ini. This file controls how MT Launcher starts Canvus client: it runs mt-canvus-app.exe with --disable-dialogs and restarts it if it crashes. The template is not left on disk. Installing a new version deletes older mt-canvus-*.ini files from that folder, so if you customized the MT Launcher configuration by hand, reapply your changes to the new file after each update.
Locking client configuration
By default, users can change the client configuration from the Settings menu. If this is not desirable, for example on a public video wall, lock the configuration file. When it is locked, the Settings page shows "Configuration is locked by your administrator and cannot be modified." and Canvus refuses to save any setting from the user interface, including the default canvas and the virtual keyboard layouts.
[system]
; Prevent Canvus client from making any changes to this configuration file.
; This option is primarily meant for public installations.
; DEFAULT: false
; lock-config=false
Single user or multi-user mode
The Canvus user interface works in two modes, each suited to a different setup. By default Canvus detects the mode each time it starts (auto). You can set it explicitly instead. Changing it requires a restart.
[system]
; Enabling multi-user mode optimizes the application user experience for
; large, multi-user installations. Disable it for a single user experience on
; personal devices like laptops. Available options:
; true Multi-user mode is enabled. QR code login is preferred, the user
; interface is optimized for multiple users.
; false Multi-user mode is disabled. All local and network disk drives
; are shown in the volume list instead of just removable USB drives.
; auto The system is considered to be in multi-user mode if the application
; display configuration (screen.xml) contains more than one window, or
; if the touch configuration (config.txt) uses MultiTaction displays.
; DEFAULT: auto
; multi-user-mode-enabled=auto
Virtual keyboard
You can configure whether the built-in virtual keyboard in Canvus opens automatically. With auto, the virtual keyboard is used in multi-user mode, and on Windows also when the computer is in tablet mode. Changing it requires a restart.
[system]
; Should Canvus use a built-in virtual keyboard. Available options:
; true Virtual keyboard is opened automatically
; false Virtual keyboard is not opened automatically, the system
; is expected to have a physical keyboard
; auto Virtual keyboard is used in multi-user mode or when Windows is in
; tablet mode.
; DEFAULT: auto
; virtual-keyboard-enabled=auto
Virtual keyboard layouts
The virtual keyboard offers English (en), French (fr) and Russian (ru) layouts. virtual-keyboard-layouts lists the layouts users can switch between with a button on the keyboard. virtual-keyboard-layout sets the layout the keyboard starts in.
[system]
; A comma separated list of enabled virtual keyboard layouts.
; Available choices are en (English), fr (French) and ru (Russian).
; DEFAULT: en
; virtual-keyboard-layouts=en
; Layout the virtual keyboard starts in, for example en, fr or ru.
; DEFAULT: en
; virtual-keyboard-layout=en
Tip
You can also change the enabled layouts from Settings > Client > Virtual keyboard.
Disks
Canvus shows USB drives in Disks in the main menu as soon as they are plugged in. On Windows, show-volumes adds other drives, including mapped network drives. The setting is in the [system] section, and its default depends on the multi-user mode setting. In the example below, drives C:, D: and G: are shown in the Canvus menu. On Ubuntu the setting has no effect and Disks shows USB drives only. For step-by-step examples, including network shares on Windows and Ubuntu, see Files in and out.
[system]
; A comma separated list of drive letters, which should always be displayed on
; the side menu if mounted. A value of '*' means all drive letters. This setting
; is only supported on Windows. The default value depends on the
; multi-user-mode-enabled setting.
; DEFAULT (multi-user-mode-enabled=false): *
; DEFAULT (multi-user-mode-enabled=true): empty
show-volumes=C,D,G
Email settings
Canvus users can send canvas items such as images, videos and documents to an email address. This gives users a simple way to take content out of Canvus.
From Canvus 26.11.1, email is off until you turn it on. While it is off, the Email button on canvas items is greyed out, with the tooltip "Email export is not enabled. Set [mail] enabled=true in mt-canvus.ini", and Canvus sends no email. See Turn email on.
When email is on and host in [smtp] does not name your own SMTP server, Canvus sends these emails through a mailbox that MultiTaction provides. This mailbox is a stopgap until you configure your own mail service, and is not meant for continued use. While it is in use, the recipient addresses and the attached items leave your network and pass through MultiTaction's mail service on the internet. Each attachment is limited to max-attachment-size in [mail], 32 MB by default; Canvus does not send larger items.
Use your own SMTP server
Set all of host, port, username, password and connection-encryption in [smtp], and sender-address in [mail], together: any key you leave unset falls back to the stopgap mailbox's value. Set sender-address to an address that your relay accepts as the sender for the account in username; many relays, including Microsoft 365, reject a sender address that differs from the signed-in account unless that account has send-as rights. Changes to [smtp] require a restart.
Turn email on
Do one of these, then restart Canvus:
- Set
enabled=truein[mail]. Canvus then uses your[smtp]settings, or the stopgap mailbox for any you leave unset. - Set
hostin[smtp]to your own SMTP server, as described above. This turns email on withoutenabled.
[mail]
enabled=true
Turn email off
Email is off unless you turn it on. To keep it off even when host in [smtp] names a server, set enabled=false in [mail] and restart Canvus. Canvus also reads 0, no and off as off.
SMTP and mail settings
[smtp]
; SMTP server host name. Setting it turns email on, unless [mail] enabled
; is false.
; host=smtp.example.com
; SMTP server port.
; DEFAULT: 587
; port=587
; SMTP user name and password.
; username=canvus@example.com
; password=
; Encryption for the SMTP connection. Values are not case sensitive:
; tls STARTTLS: connect unencrypted, then switch to TLS (usually port 587)
; ssl TLS from the start of the connection (usually port 465)
; ssl-ignore-errors as ssl, but accept any server certificate
; none no encryption
; auto any other value: TLS from the start on port 465, STARTTLS on other ports
; DEFAULT: tls
; connection-encryption=tls
[mail]
; Turn email on or off. Email is off until this is true, or until [smtp]
; host names your own SMTP server. false keeps email off even when host is set.
; DEFAULT: empty (off unless [smtp] host is set)
; enabled=true
; Sender name of the email.
; DEFAULT: Canvus
; sender-name=Canvus
; Sender address of the email. Use an address your SMTP relay accepts.
; sender-address=canvus@example.com
; Subject for the emails.
; DEFAULT: Content from Canvus
; subject=Content from Canvus
; Path to an HTML file used as the body of the emails. If empty, or if the
; file cannot be read, the built-in email body is used.
; DEFAULT: empty
; skeleton=
; Maximum email attachment size in megabytes.
; DEFAULT: 32
; max-attachment-size=32
; Default email address when sending email.
; DEFAULT: empty
; default-email-address=
; Allow users to specify another email address when sending email.
; Note: Disabling this setting and setting default-email-address
; to an empty value is not a valid configuration. Canvus will refuse
; to start if you specify it.
; DEFAULT: true
; allow-user-email=true
The client's tls means STARTTLS, while tls in Canvus Server's [smtp] security means TLS from the start of the connection.
Fixed workspaces
These workspaces cannot be resized or removed and are defined in the mt-canvus.ini configuration file.
Note
Fixed workspaces are also called 'breakout screens' or 'control displays'.
; Fixed workspaces
; Multiple workspaces can be defined that cannot be changed while the
; application is running.
; NOTE: Each workspace is defined with the format [fixed-workspace:<index>],
; where the index (starting at 1) defines the left to right positional order of
; the workspaces.
; [fixed-workspace:1]
; The size setting must be specified for each workspace. A block without a
; valid size is ignored.
; size=3240 1920
; Also, the following settings can be specified for each fixed workspace:
; If specified, this name appears in the workspace label, otherwise the standard
; "Workspace n" naming is used.
; DEFAULT: empty
; name=
; NOTE: setting either view-location or view-scale will override any other
; settings that influence the initial position and scale of the view, for
; example, the zoom-viewport and anchor-viewport settings in the [canvas]
; section.
; The initial location of the view on the workspace. If 0 0, the default
; location will be used.
; NOTE: Values specifying an area outside the view size will be adjusted to
; ensure the viewport is valid.
; DEFAULT: 0 0
; view-location=0 0
; The initial scale of the view on the workspace. If zero, the default scale
; will be used.
; NOTE: The maximum scale factor value allowed is 10.
; DEFAULT: 0
; view-scale=0
Note
Canvus treats both view-location values as zero or negative: a positive value is used as its negative. view-location=200 100 and view-location=-200 -100 give the same view.
Predefined text snippets
To speed up text entry and avoid typing errors, Canvus supports predefined text (also called keyboard shortcuts or snippets). This feature is designed primarily to streamline demonstrations and presentations.
You often need to type text in Canvus, such as when you add text to a Note widget or run an internet search for a web page. When you use an on-screen keyboard to type, you can insert items of predefined text. This is useful when you need to repeatedly enter the same text string such as a web site URL or email address.
To insert items of predefined text, tap the predefined text button on the on-screen keyboard. Then tap the item you want in the pop-up list of predefined text.
To add predefined text snippets:
-
On the application computer, create a Shortcuts subfolder below the data file folder (see client-data-files).
For example, if the user logged on while Canvus runs is
multi, the expanded paths would be- Ubuntu:
/home/multi/MultiTaction/canvus-data/data-300/Shortcuts - Windows:
C:\Users\multi\AppData\Roaming\MultiTaction\canvus-data\data-300\Shortcuts
- Ubuntu:
-
Using your preferred text editor, save one or more files of predefined text in the Shortcuts folder.
Canvus supports three file formats. You can use any combination of file formats. Choose the combination that best suits the needs of your organization:
-
Single named item: This simple file contains a single item of predefined text. The filename is the name of the predefined text. This name appears in the pop-up list of predefined text. The content of the file is the text you want to insert.
You can create any number of these files, each containing a separate item of predefined text. However, if you have multiple items of predefined text, you may find the following multiple item file formats easier to maintain.
-
Multiple unnamed items: This file contains multiple items of predefined text. These items do not have names. The filename must start with an underscore character (_).
Each line in the file is a single item of predefined text. Each line appears exactly as written in the pop-up list of predefined text.
-
Multiple named items: This file contains multiple items of predefined text. These items do have names. The filename must have a .json extension and the file content must adhere to JSON syntax.
Each entry in the file defines an item of predefined text and its name. These names appear in the pop-up list of predefined text. If your items of predefined text are lengthy or similar (such as variants of your corporate URL), you may find that short descriptive item names are easier to recognize in the pop-up list of predefined text items. See the example files in Examples.
-
-
After you create or edit a file of predefined text, you must restart Canvus client to load the new file(s).
Examples
Consider three example files of predefined text (shortcuts) in the Shortcuts folder:
-
Example 1: Single item of predefined text
Use a descriptive filename, for example
support mail. The file contains a single item of predefined text:support@example.com -
Example 2: Unnamed items of predefined text
The filename must begin with an underscore character. For example,
_shortcuts. The file contains unnamed items of predefined text:Specialists in advanced visualization support@example.com www.example.com/support-services -
Example 3: Named items of predefined text
The filename must have a .json extension. For example,
shortcuts.json. The file contains named items of predefined text:[ { "name": "Strapline", "text": "Specialists in advanced visualization" }, { "name": "Support email", "text": "support@example.com" }, { "name": "Support URL", "text": "www.example.com/support-services" } ]
Codice cards
Codice cards refers to fiducial markers for MultiTaction displays. Individual Codice cards can be registered for the following functionality:
- Eraser card: the card erases annotations on the canvas when placed on the screen.
- Canvas card: the card opens a specific canvas when placed on the screen.
- Personal folder card: the card opens a specific Codice folder when placed on the screen.
Codice server
To use canvas cards or Codice folder cards, a codice-server must be specified in the mt-canvus.ini configuration file. Eraser cards are not affected by this setting.
[system]
; Name of the Codice server where all Codice data like the personal folders
; and Canvas Codice maps are stored. To use these features, configure
; Canvus Connect by adding a new section for the server, for
; instance [server:My server], and then setting codice-server=My server
; DEFAULT: empty, which disables all Codice server features
; codice-server=
Note
Use the server name as the value of codice-server, not the address of the server.
Eraser cards
Canvus users can erase annotations with a pen, mouse or eraser card. An eraser card uses special Codice eraser codes.
By default, Codice cards 612 and 614 are defined as Codice eraser cards. To change these codes or add additional eraser codes in the client configuration file:
-
Edit the following setting in the [annotation] section. (Manually add this section and setting to mt-canvus.ini if they do not already exist.)
[annotation] eraser-marker-codes=612, 614, 615Where eraser-marker-codes specifies the eraser codes. You can assign a new value or add a comma-separated list of values. In the example above, eraser codes 612, 614 and 615 are all designated as eraser codes.
-
If you have finished editing mt-canvus.ini, restart Canvus on the application computer.
Canvas cards
Canvas cards allow using a Codice card as a shortcut to open a specific canvas. When enabled, users are able to associate specific Codice cards to canvases from the Canvus client user interface (see registering-codice-card).
This feature is disabled by default and must be enabled in the client configuration:
[system]
; Allows assignment of Codice marker to be used as a shortcut for canvas
; selection.
; DEFAULT: false
; enable-canvas-codices=false
Codice folder cards
The Canvus client can use a dedicated Canvus server to store Codice folders. This server is referred to as codice-server (see Codice server). Because the Codice folders are stored on a server, they can be accessed from any client using the same codice-server.
This feature requires a dedicated Canvus server and can not be used with a standalone Canvus client.
Codice folders are enabled by default on the client as long as a codice-server has been configured. The Codice folders can be manually disabled by adjusting the following setting in the client configuration file:
[system]
; Enables the Codice folders feature that is triggered with Codice markers.
; See also system/codice-server setting in this file.
; DEFAULT: true
; enable-codice-folders=true
Note
enable-personal-folders is a deprecated alias for this setting. It still works but logs a warning; use enable-codice-folders instead.
Set inactivity timeout for workspaces
You can set an inactivity timeout for Canvus client. If users do not interact with a workspace before the timeout expires, the workspace closes and the welcome screen appears.
[system]
; Timeout (in seconds) after which workspace is closed and returned
; to the welcome screen if the workspace hasn't been interacted with.
; Setting inactive-timeout=0 disables this feature.
; DEFAULT: 14400 (4 hours)
; inactive-timeout=14400
Set inactivity timeout for menus
By default, the canvas menus along the edge or bottom of the screen close automatically after 15 s of inactivity. If users do not interact with an open menu before the timeout expires, the menu closes. You can change or cancel the timeout.
[system]
; Timeout (in seconds) for expanded menus on the side or bottom of the canvas.
; Set to zero for no timeout.
; DEFAULT: 15
; menu-timeout=15
Presentations, menus and window size
| Key | Default | Meaning |
|---|---|---|
system/presentation-control-timeout-seconds |
30 |
Time in seconds after which the controls of a full-screen presentation hide when nobody touches them. |
system/enable-canvas-menu-hide-hotspot |
false |
If true, Canvus adds a hotspot on top of each workspace. Tapping and holding it hides or shows the canvas menus. From Canvus 26.11.1 you can also hide parts of the interface permanently; see Kiosk mode. |
system/minimum-window-size |
1024 768 |
Smallest size, in pixels, that a user can resize the Canvus window to. 0 0 removes the limit. Applies in single-user mode when Canvus runs in one resizable window. |
Kiosk mode
From Canvus 26.11.1, system/enable-canvas-menu-hide-hotspot also accepts these values:
kioskhides title bars, item sidebars, the main menu and resize handles. People can add content but cannot rearrange or delete it. The finger menu stays visible.- A comma-separated list of the parts to hide, from
title,sidebar,mainmenu,fingerandresizer, for exampletitle, resizer. kiosk, fingerhides everything.
[system]
enable-canvas-menu-hide-hotspot=kiosk
Configure default pin and display settings
You can configure default pin and display settings for when a canvas opens. For example, you can specify that all canvases are pinned when they open. You can also specify whether to zoom a canvas to achieve a "best fit" and jump to an anchor area when a canvas opens.
; Canvas settings
[canvas]
; If true, the canvas is automatically pinned when it is opened.
; DEFAULT: false
; pin-canvas=false
; If true, the canvas is automatically moved to the first anchor position when
; it is opened.
; If there are no anchors or it is false, the zoom-viewport setting is used to
; determine the position.
; DEFAULT: false
; anchor-viewport=false
; If true, the canvas is automatically zoomed to ensure all widgets are visible
; when it is opened.
; If false, the initial position will be determined by the last saved position
; within the session.
; NOTE: If there is no saved position then the viewport will be centralized.
; DEFAULT: false
; zoom-viewport=false
; Custom menu file in YAML format used to display a user-defined menu
; structure on the finger menu. See Custom menu.
; DEFAULT: empty
; custom-menu=
See Custom menu for the custom-menu file format.
Pin inactive canvases and widgets automatically
Canvases and widgets can be pinned automatically after a period of inactivity. This is useful for users giving a canvas presentation, reducing the risk that they accidentally move or resize screen items.
[canvas]
; If set, an unpinned canvas is pinned after it has not been scaled or moved
; for the specified number of seconds
; If zero, the canvas is never auto-pinned
; DEFAULT: 0
; auto-pin-after=0
; Widget settings
[widget]
; This setting only applies to local canvases. If set, an unpinned widget is
; pinned after it has not been scaled or moved for the specified number of
; seconds
; If zero, the widget is never auto-pinned
; DEFAULT: 0
; auto-pin-after=0
Canvas size and default colours
These settings apply to canvases created on this computer after you restart Canvus. Existing canvases keep their size and colours.
| Key | Default | Meaning |
|---|---|---|
canvas/size |
9600 |
Size of a new canvas. One number sets the longer edge in pixels, and Canvus calculates the shorter edge from the aspect ratio of the workspace the canvas is created on. Two numbers, for example 9600 5400, set the width and height. |
canvas/default-pen-color-presets |
#e7e7f2,#000000,#0539db,#f7f700,#08c41a,#f20000 |
Pen colour palette that new local canvases start with, as comma-separated hex colours. The first colour is the default. Connectors use the pen colours. |
canvas/default-note-background-color-presets |
#3aaa34,#1d71b8,#fcea0f,#e6332a,#662583,#ffffff |
Note colour palette that new local canvases start with. The first colour is the default. |
Canvus ignores entries that are not valid colours. An empty list, or a list with no valid entry, gives the built-in palette. You can also set both palettes from Settings > Client > Default colours. Canvases on a Canvus Server take their default colours from the server configuration instead.
Widget activation
When a user activates an unpinned item, Canvus shows the menus around its border. These settings control which gestures activate an item and when it is deactivated again.
| Key | Default | Meaning |
|---|---|---|
widget/activation-gestures |
all |
Comma-separated list of gestures that activate an item: all (any interaction), tap, tap-and-delay (a tap followed by a short pause) and hold (fingers held on the item). For example activation-gestures=tap-and-delay,hold. |
widget/activation-gesture-delay |
0.5 |
Pause in seconds after a tap before the tap-and-delay gesture activates the item. |
widget/tap-to-deactivate |
false |
If true, tapping the canvas deactivates the items near the tap. |
widget/deactivation-distance |
1000 in multi-user mode, no limit in single-user mode |
When an item is activated by touch, other active items whose last touch was closer than this many pixels are deactivated. |
Annotation and eraser
| Key | Default | Meaning |
|---|---|---|
annotation/eraser-marker-codes |
612, 614 |
Codice marker codes that act as erasers. See Eraser cards. |
annotation/eraser-size |
100 60 |
Width and height of the rectangular eraser. Canvus draws the eraser at twice these values. |
annotation/mouse-eraser-marker-code |
42 |
Marker code Canvus gives the mouse when it is used as an eraser. Do not use this code on a Codice card. |
The [annotation] section also holds five advanced stroke-smoothing settings. Change them only if pen strokes look jagged or distorted.
| Key | Default | Meaning |
|---|---|---|
annotation/max-pen-noise |
0.1 |
Noise threshold for incoming pen points. |
annotation/max-fit-error |
0.75 |
Maximum error when fitting curves to a stroke. |
annotation/max-relative-fit-error |
20 |
Maximum curve-fitting error relative to the stroke width. |
annotation/max-erase-error |
0.5 |
Tolerance used when the eraser hits a stroke. |
annotation/max-stroke-radius-change-rate |
0.1 |
Maximum rate at which the stroke width may change along a stroke. |
Enable touch mode selector
By default, Canvus supports input devices like pens for annotating and erasing. However, when running on touch screens that do not have pen or eraser support, Canvus offers a third party touch mode which allows users to switch between manipulating content or drawing and erasing using their fingers.
When enabled, a touch selector UI component enables users to quickly switch touch mode using their fingers. The touch selector is permanently visible on the screen and includes three buttons to select what happens when they interact with the software using their fingers:
- Pointer mode: Users can use a finger like a mouse pointer. For example, you can move or resize widgets, tap buttons, and browse web pages or PDF documents.
- Pen mode: Users can use a finger to draw annotations on the screen.
- Eraser mode: Users can use a finger to erase annotations.
Changing third-party-touch requires a restart.
[hardware]
; Enable or disable third party touch mode. This mode is meant to be used with
; devices that do not have a separate pen and/or eraser functionality and only
; work with touch input. When enabled, users will see extra UI that allows them
; to use their fingers to annotate and erase.
; DEFAULT: false
; third-party-touch=false
[touch-mode-selector]
; Settings for touch mode selector (only used if third-party-touch is enabled).
; Set to false to hide the touch mode selector.
; DEFAULT: true
; enabled=true
; Idle time in seconds before the selector is returned to its home location in
; finger mode.
; DEFAULT: 10
; timeout=10
; Home position of the selector as a percentage of the window width.
; DEFAULT: 90
; home-x-percent=90
; Home position of the selector as a percentage of the window height.
; DEFAULT: 90
; home-y-percent=90
; Distance in pixels from the home position outside which the selector will
; return to the home position.
; DEFAULT: 500
; home-radius=500
Configure Canvus Connect
By default, Canvus client can only display local canvases stored locally on the application computer. You can configure Canvus clients for Canvus Connect, enabling separate Canvus deployments to connect to each other and allowing geographically dispersed users to use shared canvases. For example, users in London and Paris can simultaneously see and work on the same shared canvas.
To configure your Canvus client for Canvus Connect, you must edit settings in mt-canvus.ini. First, you must identify the Canvus server that the client will connect to. Then you must configure the display names for participants in shared canvas sessions. These tasks are described in the following sections.
Tip
You can also use shared links to add a Canvus Connect server without having to manually edit the Canvus client configuration file.
Verify server setup
Canvus Connect requires a Canvus client in each location plus a Canvus Connect server to manage the connections. Before you can configure your clients, you must set up the server. For details about setting up Canvus Connect server, see server-install.
Specify the server
First, you must identify the Canvus server that your client will connect to. A [server:<name>] block without a server= value is ignored.
; Canvus Connect server list
; Configure each server with [server:<name>] section.
; You can have multiple servers, but each server name must be unique.
; [server:Canvus Connect]
;
; The Canvus Connect server host to connect to.
; NOTE: This value must be specified.
; DEFAULT: empty
; server=
; Protocol used for communication with the Canvus Connect server. Options are
; ssl or tcp. The default protocol is determined by the chosen port below.
; DEFAULT (port 443): ssl
; DEFAULT (port 80): tcp
; protocol=ssl
; Port used for communication with the Canvus Connect server. The default port
; is determined by the chosen protocol above.
; DEFAULT (ssl protocol): 443
; DEFAULT (tcp protocol): 80
; port=443
; Control REST API access to this client from this server.
; Valid values are:
; * none - Do not expose this client to REST API at all.
; * ro - Allow read-only access to the client state
; * rw - Allow read-write access to the client state
; DEFAULT: none
; rest-api-access=none
; Set the connection password (if required) for connecting to this server.
; The password cannot contain semicolon, or quotation marks.
; DEFAULT: empty
; connection-password=
If you set neither protocol nor port, Canvus uses ssl on port 443. The tcp protocol is not encrypted.
About connection passwords
If required, you can set up a connection password for your Canvus server. Only Canvus clients with this password can connect to the server.
This feature provides an additional level of security if you store canvases with sensitive information on your Canvus server and the server is publicly accessible over the internet (that is, clients do not need a VPN to connect to the server).
If a client does not hold the connection password, it cannot connect to the server, even if the other server connection details are correctly specified in the [server:name] section of mt-canvus.ini.
Configure site name for session participants
The site name that appears in the participant dialog is configurable.
[identity]
; Name of the installation of this Canvus client. Is shown in the
; participant list for this client. If empty, the hostname of the machine
; is used.
; DEFAULT: empty
; installation-name=
Turn off local canvases
By default, Canvus offers a built-in Local server next to the Canvus Servers you configure, and users can create local canvases that are stored only on the computer that runs Canvus. To keep every canvas on Canvus Server, for example because your data-governance or backup policy requires it, turn local canvases off:
[system]
; Turn off local canvases. When true, the built-in Local server is not
; offered, so users can only open and create canvases on the Canvus servers
; listed in [server:<name>] sections, and no canvas is stored only on this
; computer. Configure at least one server, or there is nothing to open.
; Existing local canvases are not deleted; they come back when this is
; false again.
; DEFAULT: false
; disable-local-canvases=false
Restart Canvus to apply the change.
- Configure at least one server in a
[server:<name>]section first (see Configure Canvus Connect). If no server is configured, users have nothing to open. - Local canvases that already exist are hidden, not deleted. They are still in the data folder and come back if you set the key to
falseagain. Delete them before you turn local canvases off if they must not stay on the computer. - Canvus still keeps a cache of the files on shared canvases in its asset folder. See Cache and asset management to limit how long cached files are kept.
- From Canvus 26.10.4 the update keeps this setting. Earlier versions can drop it when they update
mt-canvus.ini, so check it after updating.
Server certificates
When Canvus connects to a Canvus Server over ssl, it checks the server's certificate. If the certificate is not trusted and a user chooses to trust it, Canvus remembers that choice in a certificate folder. Canvus also trusts the CA certificates in that folder, so you can add your organization's CA certificate there as a file whose name ends in .cert.pem.
[certificates]
; Folder of extra CA certificates trusted for connections to Canvus servers.
; Server certificates a user chooses to trust are remembered here too.
; DEFAULT: ca-certificates in the folder that holds the per-user mt-canvus.ini
; certificate-dir=
RDP (remote desktop protocol)
Canvus client has a built-in RDP client. It can be used to connect to an RDP server, for example running on a Windows Server machine. Setting up an RDP connection enables Canvus to do the following:
- Interact with a remote PC using multi-touch gestures
- Interact with applications like Office, Photoshop, Paint, etc. running on the RDP server, thus bringing in more content to the Canvus sessions
- Receive audio and video from the RDP server
Remote file transfer is not supported
Do not use the RDP widget as a file-transfer mechanism. Moving files to or from the remote server, or round-tripping edited files back into Canvus through RDP, is not supported.
Types of RDP connections
Canvus connects to an RDP server via two different modes:
1. Remote Desktop Mode: This mode typically displays the entire desktop of the RDP server, but it can also be configured to use a RemoteApp connection, which would restrict users from accessing any application other than the one specified. To enable RemoteApp, modify the app parameter in the remote-desktop configuration block of the mt-canvus.ini file. For the full list of RDP parameters, see Configuring the Canvus client.
; RemoteApp to launch on connect. This setting is used only when connecting
; using the Remote Desktop list.
; NOTE: Backslashes in paths need special handling on Windows computers.
; Replace each \ with \\.
; Example: %WINDIR%\\System32\\notepad.exe
; Example: ||notepad (using configured RemoteApp alias)
; DEFAULT: empty (show the whole desktop)
; app=
2. Remote File Handler Mode: This mode is not supported for file transfer or remote file editing. Do not configure RDP with the expectation that Canvus will copy files into the remote session or sync edited files back to the canvas. Use the normal file import/export workflow outside the RDP session instead.
file-extensions=doc,docx,ppt,pptx,xls,xlsx,png,mp4,pdf
The file-extensions setting is retained for legacy configurations only. New deployments should not rely on it for RDP-based file transfer or remote file editing.
Configuring the RDP server
Canvus can connect to RDP servers running on Windows Server or Windows 10 Professional PCs.
In order to access an RDP Server from Canvus Client, please do the following on the machine running the RDP server:
1. Enable remote desktop feature. Click here for more information
2. Enable support for unlisted remote apps by installing this .reg file. You can also perform the same operation by downloading a RemoteApp Tool, which also allows you to tune the timeout for idle sessions.
Note
Because Canvus is designed to be multi-user software, each RDP widget in Canvus requires its own RDP connection and session. To support more than one simultaneous RDP connection, the RDS server must be configured to allow this.
Tip
If the RDS server is not configured to allow multiple connections and sessions from a single user, your existing RDP connections will be closed in Canvus when you try to open a new one. If you are using a Windows RDS server, open Group Policy Editor. Navigate to Computer Configuration > Administrative Templates > Windows Components > Remote Desktop Services > Remote Desktop Session host > Connections
- Set the Limit Number of Connections to something more than 1 (or disable it).
- Disable Restrict Remote Desktop Services users to a single Remote Desktop Services session.
You must restart the RDS server after modifying these settings.
Recommended: Log off disconnected sessions immediately
When an RDP widget is closed, Canvus disconnects from the RDS server but does not log off the Windows session. Without this setting, disconnected sessions remain active on the server and can cause stale session issues on reconnect.
Open Group Policy Editor (gpedit.msc) and navigate to:
Computer Configuration > Administrative Templates > Windows Components > Remote Desktop Services > Remote Desktop Session Host > Session Time Limits
Set "Set time limit for disconnected sessions" to Enabled with a value of 1 minute (or the lowest available value).
This ensures that when a Canvus user closes an RDP widget, the Windows session is logged off promptly, freeing server resources and preventing stale session artifacts when the user reconnects.
Alternatively, on Windows Server with RDS roles, navigate to Server Manager > Remote Desktop Services > Collections > (your collection) > Properties > Session and set End a disconnected session to the lowest available value.
The server must be restarted (or gpupdate /force run) after modifying Group Policy settings.
Configuring the Canvus client
Define the configuration details about the RDP server in the mt-canvus.ini. It has the following exhaustive list of parameters that allow you to configure RDP connections:
; Remote desktop connection configuration block. There is no limit on the
; number of remote-desktop configuration blocks as long as they all have
; unique names.
; [remote-desktop:Connection name]
; Hostname or IP address of the RDP server with an optional port number.
; If this parameter is empty, the whole configuration block is disabled.
; To use a non-standard port, include it in the host value as host:port.
; Examples: localhost, rdp.example.com, rdp.example.com:13389, 10.0.0.1:3389
; DEFAULT: empty
; host=
; Username to use to log in to the server.
; DEFAULT: empty
; username=
; Password for the given username. Leave empty if password is not used
; or if you wish to enter the password manually when connecting.
; DEFAULT: empty
; password=
; Domain to use for authentication.
; DEFAULT: empty
; domain=
; Maximum number of concurrent connections to this server.
; DEFAULT: 0 (unlimited)
; max-connections=0
; Show this server in the Remote Desktop list. If this is set to false, you
; can't directly connect to the server, instead this connection is just used
; to open files.
; Either show-in-server-list must be true or file-extensions must not be empty.
; DEFAULT: true
; show-in-server-list=true
; Comma-separated list of file extensions of files that are opened through
; this server.
; Either show-in-server-list must be true or file-extensions must not be empty.
; Example: doc,docx,ppt,pptx,xls,xlsx
; DEFAULT: empty
; file-extensions=
; RDP gateway hostname with optional port number. Leave empty if gateway
; is not used.
; DEFAULT: empty
; gateway=
; Gateway username.
; DEFAULT: empty
; gateway-username=
; Gateway password.
; DEFAULT: empty
; gateway-password=
; Gateway Domain.
; DEFAULT: empty
; gateway-domain=
; Advanced RDP settings:
; Initial RDP desktop resolution for new RDP widgets.
; DEFAULT: 1920 1080
; desktop-size=1920 1080
; RemoteApp to launch on connect. This setting is used only when connecting
; using the Remote Desktop list.
; NOTE: Backslashes in paths need special handling on Windows computers.
; Replace each \ with \\.
; Example: %WINDIR%\\System32\\notepad.exe
; Example: ||notepad (using configured RemoteApp alias)
; DEFAULT: empty (show the whole desktop)
; app=
; Command line arguments to RemoteApp, used when "app" setting is used.
; DEFAULT: empty
; app-args=
; Extra FreeRDP command line arguments.
; Example: /drive:home,/home/multi
; DEFAULT: empty
; extra-args=
Below is an example of the parameters required to set up an RDP connection.
[remote-desktop:Example RDP Server]
host=rdp.example.com
username=some_user
password=some_password
Note
hostname= is a deprecated alias for host=. Canvus still reads it, but the update merge comments it out (see What happens when you update). Use host=.
Info
- rdp under advanced-content.
Changing keyboard layout
See Virtual keyboard layouts above for the virtual-keyboard-layouts setting and the supported layouts (English, French, and Russian).
Note
Canvus must be restarted after this setting has been modified.
Cache and asset management
By default, Canvus clients are configured to cache assets used in local and shared canvases. This is done to enhance performance and to reduce the bandwidth usage.
This behavior can be modified if necessary. The maximum time assets are allowed to be cached can be set in the mt-canvus.ini file as defined below:
[cache]
; Maximum time in seconds that assets are allowed to be cached.
; DEFAULT: 2592000 (30 days)
; max-age=2592000
When a local canvas is deleted any unreferenced assets and their caches are deleted from the disk. For shared canvases, Canvus keeps track of every cached asset and when it was last used. If a cached asset has not been used for more than the value specified by max-age, it gets deleted from the disk.
To disable caching set max-age=0 in the mt-canvus.ini file. This means that assets are only cached temporarily and get immediately removed after no longer being needed.
Note
Keep max-age at its default value for the best loading performance when opening shared canvases.
Browser settings
You can configure how the built-in web browser in the Canvus client behaves by adjusting the following settings in the configuration file.
[browser]
; Browser start page that is opened when a new web browser widget is created.
; DEFAULT: https://www.google.com
; start-page=https://www.google.com
; Search URL that is opened when a search term is entered in the web browser
; address bar. A word QUERY written in uppercase letters is replaced with the
; search terms.
; DEFAULT: https://www.google.com/search?q=QUERY
; search-url=https://www.google.com/search?q=QUERY
; Specify which internet sites allow content to be uploaded by dragging onto a
; browser widget.
; if upload-sites=* or missing, allow all uploads.
; if upload-sites is empty, prevent all uploads.
; if upload-sites are specified a widget can only be dropped on the browser if
; its current URL contains one of the specified names, e.g.
; upload-sites=drive.google.com,docs.google.com,mail.google.com
; DEFAULT: *
; upload-sites=*
; Specify if browser sessions should be saved on disk so that cookies,
; browsing history and other session data persists between application
; restarts. Set to false to use in-memory sessions that are cleared when
; application is restarted or user logs out.
; DEFAULT: true
; persistent-sessions=true
; Browsers can handle touches by either passing all touches to the browser
; or converting the first touch to mouse clicks and drags. Different web
; apps work better with the two alternative behaviors. The user can pick
; the best behavior on the browser. This setting determines the default state
; for new browsers. If true, then, by default, touches are converted to mouse
; clicks.
; DEFAULT: false
; mouse-emulation=false
; Allow the browser to open files on this computer. When true, the address bar
; opens file:// URLs and turns a typed absolute path (/home/..., C:\..., or
; \\server\share\...) into one. When false, such input is searched for like
; any other text, and a file:// URL that arrives from the canvas is not opened.
; DEFAULT: false
; allow-file-urls=false
; Comma-separated list of Chromium / CEF feature flags to disable in the
; embedded web browser. Values map 1:1 to Chromium's
; --disable-features=<list> command-line switch.
; DEFAULT: ThirdPartyCookieDeprecation,BounceTrackingMitigations,TrackingProtection3pcd
; cef-disable-features=ThirdPartyCookieDeprecation,BounceTrackingMitigations,TrackingProtection3pcd
; Space-separated raw Chromium command-line switches for the embedded browser.
; DEFAULT (Linux): --no-sandbox --no-zygote --disable-dev-shm-usage
; DEFAULT (Windows and macOS): empty
; cef-extra-switches=
upload-sites
An entry matches anywhere in the address of the page shown in the browser, so keep entries specific: box.com would also match dropbox.com. Uploads work only by dragging an item onto the page; a site's own upload button does nothing, because Canvus does not open a file chooser for web pages. For entries for common file-sharing sites, see Choose which sites accept uploads.
allow-file-urls (new in 26.10.4)
The browser address is saved on the canvas, and every computer that opens the canvas opens the path on its own disk. On a shared canvas, keep the files on a drive that has the same path on every computer, for example a mapped network drive.
cef-disable-features (new in 26.4.0)
The cef-disable-features option lets an administrator turn off individual Chromium / CEF features in the embedded browser. This is useful when a specific web application misbehaves in Canvus because of a Chromium default, or when a new experimental Chromium feature needs to be disabled across a fleet. Values are passed directly to Chromium's --disable-features switch, so any feature name Chromium accepts there is accepted here. The default turns off Chromium privacy features that break single sign-on and other cookie-based sign-in flows. Setting it to an empty value clears these defaults, so those Chromium features are no longer disabled.
cef-background-services (new in 26.11.1)
From Canvus 26.11.1 the embedded browser no longer connects to Google services in the background (push messaging, the account list, component downloads and network time, for example android.clients.google.com, mtalk.google.com:5228, accounts.google.com, update.googleapis.com and www.google.com). Web pages, including Google sign-in pages, are not affected. To allow these background connections again, set cef-background-services=true in the [browser] section.
cef-extra-switches and the browser sandbox
On Linux the default switches work around a crash of the embedded browser on newer Linux kernels. --no-sandbox turns off the Chromium sandbox. From Canvus 26.09.0 this default applies on Linux only; Windows and macOS start with no extra switches. Do not copy the Linux line onto a Windows installation, where it would only weaken the browser sandbox. A value you set is used on every platform, and an empty value (cef-extra-switches=) clears the default. You can also pass single switches on the command line; see command-line arguments.
Canvus folder
You can specify a custom folder to be opened from Files in the finger menu. Use a full path with forward slashes, also on Windows. If the folder does not exist, Canvus creates it. If Canvus cannot create or use the folder, it falls back to the default. Restart Canvus after a change. For examples, including network shares, see Files in and out.
[system]
; The directory that is opened from the finger menu.
; DEFAULT: Home directory of the active user in single user mode or
; the Canvus-folder inside the data folder (content/root) in
; multi-user mode.
; canvus-folder=C:/CanvusFolder
Default canvas
You can specify a default canvas that can be quickly accessed from the welcome screen. The URL can be any shared link to a canvas stored on a Canvus Connect server or a link to a local canvas.
[system]
; URL of the default canvas that can be quickly opened from the welcome
; screen.
; DEFAULT: empty
; default-canvas=
Tip
You can also change the default canvas from Settings > Client > Default canvas.
Data folder and backups
All three settings require a restart.
| Key | Default | Meaning |
|---|---|---|
content/root |
%APPDATA%\MultiTaction\canvus-data (Windows), ~/MultiTaction/canvus-data (Ubuntu), ~/Library/MultiTaction/canvus-data (macOS) |
Root of the Canvus data folder. Local canvases and their assets, assets downloaded for shared canvases and the built-in Canvus folder are stored in its data-300 subfolder. See Where is my data?. |
backup/root |
%LOCALAPPDATA%\MultiTaction\canvus\backups (Windows), ~/MultiTaction/canvus/backups (Ubuntu and macOS) |
Folder for client backups. When Canvus starts for the first time after a software update, it first backs up the local canvases into a new subfolder here. --backup also writes here when you do not give --backup-path. Do not set it to an empty value: Canvus then cannot make the update backup and does not start after an update. See Backup and restore. |
identity/asset-directory |
asset-storage in the data-300 subfolder of the data folder |
Folder for the files on canvases (images, PDFs, videos and 3D models): those of local canvases, and the cache of files from shared canvases. See Asset folder. |
Note
If you point content/root at a new, empty folder, Canvus starts with no local canvases. Move the existing data-300 folder there first if you want to keep them. On Windows the default data folder is in the roaming profile; on sites with roaming profiles, set content/root to a folder on a local disk.
Asset folder
The asset folder is usually the largest part of the data folder, especially on video walls with a lot of video. To keep it on another disk while the rest of the data folder stays where it is, set asset-directory in the [identity] section:
[identity]
; DEFAULT: asset-storage in the Canvus data folder, for example
; ~/MultiTaction/canvus-data/data-300/asset-storage
asset-directory=D:/CanvusAssets
To move the asset folder:
- Close Canvus.
- Copy the existing
asset-storagefolder to the new location. Local canvases still refer to the files in it: if you pointasset-directoryat an empty folder, the files on your local canvases disappear, and Canvus downloads the files of shared canvases again. - Make sure the account that runs Canvus can write to the new folder.
- Set
asset-directoryto the new folder and start Canvus.
content/root does not move a custom asset folder: if you change the data folder later, the asset folder stays where asset-directory points.
Check the setting after updating to 26.11.0 or earlier
Up to Canvus 26.11.0 the update comments out asset-directory, because the example file does not list it, and Canvus then uses the default folder again. After each update, check that the line is still active in mt-canvus.ini. From Canvus 26.11.1 the update keeps it.
Welcome screen
| Key | Default | Meaning |
|---|---|---|
welcome-screen/allow-exit |
true |
Show the exit button on the welcome screen. |
welcome-screen/animated-background |
true |
Animate the welcome screen background. When false, or when the animation cannot be loaded, Canvus shows a still image instead. New in 26.09.7. |
Local canvas passwords
These settings control passwords for local canvases. Canvases on Canvus Server cannot have canvas passwords: Settings > Canvas > Password shows "Remote canvases don't use passwords", and access is controlled by user and group permissions instead. The [password-security] rules apply when a user sets a password on a local canvas in Canvus (Settings > Canvas > Password), and Canvus shows the rules in the password dialog. For each rule, 0 or an empty value means no rule.
| Key | Default | Meaning |
|---|---|---|
system/enforce-canvas-password |
false |
If true, every new local canvas must have a password. Does not affect canvases on a Canvus Server. |
system/password-char-display-time |
0.5 |
Time in seconds that a typed character stays visible in a password field before it is hidden. From Canvus 26.11.1, 0 also hides the last typed character in the web browser's log-in dialog. |
password-security/min-length |
4 |
Minimum number of characters. |
password-security/min-lowercase |
0 |
Minimum number of lowercase letters. |
password-security/min-uppercase |
0 |
Minimum number of uppercase letters. |
password-security/min-numeric |
0 |
Minimum number of digits. |
password-security/min-symbol |
0 |
Minimum number of characters that are not letters or digits. |
password-security/max-repeats |
0 |
Maximum number of identical characters in a row. With 2, aa is allowed and aaa is not. |
password-security/max-sequence |
0 |
Maximum length of an ascending or descending run of letters or digits. With 3, abc is allowed and abcd is not. |
PDF, video and snapshots
| Key | Default | Meaning |
|---|---|---|
pdf/raster-resolution |
2048 |
Resolution in pixels of the longer edge of each rendered PDF page. Higher values are sharper and use more memory. |
video/tap-to-play |
false |
If true, tapping a video plays or pauses it. If false, users tap the play button. |
video/screenshare-audio |
false |
If false, a screen share widget opens with its audio muted. |
system/max-snapshot-resolution |
8192 |
Maximum resolution in pixels of a snapshot image. Values below 256 are treated as 256. |
system/snapshot-scale |
1.0 |
Scale factor for snapshots. 1.0 takes the snapshot at native resolution; 2.0 doubles it for high-DPI content. The result is still limited by max-snapshot-resolution. |
Video inputs
The [video-stream] settings are preferences for local capture devices (capture cards and webcams) that offer several formats. They are hints: if a device cannot meet them, Canvus uses the closest format the device offers. They do not affect IP video streams or NDI sources.
| Key | Default | Meaning |
|---|---|---|
video-stream/min-fps |
14 |
Minimum preferred frame rate. |
video-stream/max-fps |
31 |
Maximum preferred frame rate. |
video-stream/min-resolution |
800 600 |
Minimum preferred resolution in pixels. |
video-stream/max-resolution |
3840 2160 |
Maximum preferred resolution in pixels. |
video-stream/prefer-uncompressed |
true |
Prefer uncompressed video formats from the device. |
Video canvas backgrounds
From Canvus 26.09.4 a canvas background can be a video. Canvus converts an imported background video that exceeds these limits. The defaults suit video walls that decode video in hardware. Lower them for installations whose clients decode in software, such as laptops.
| Key | Default | Meaning |
|---|---|---|
system/background-video-max-width |
3840 |
Maximum width in pixels. |
system/background-video-max-height |
2160 |
Maximum height in pixels. |
system/background-video-max-fps |
30 |
Maximum frame rate. |
system/background-video-bitrate |
20000000 |
Bit rate of a converted video, in bits per second. |
Image search
Image search in the finger menu uses Google Custom Search, and is on by default. Until you set your own key, Canvus uses MultiTaction's Google key and search engine, which has SafeSearch on.
When a user searches, Canvus sends the search terms to Google (www.googleapis.com), and then downloads the result images and their thumbnails from the websites that host them. No user account, canvas or session data is sent with the search. Google is the only image search provider Canvus supports, and Canvus 26.11 has no setting that turns image search off.
To use your own Google account, create a Custom Search API key and a search engine ID in it, and set them here. Both fields are masked in the Settings page.
[image-search]
; Google Custom Search API key.
; api-key=
; Google Custom Search engine ID.
; engine-id=
Performance limits
Both settings require a restart.
| Key | Default | Meaning |
|---|---|---|
system/max-open-files |
4096 |
Maximum number of files Canvus can have open at the same time (Ubuntu only). Canvus cannot raise it above the system's hard limit. Raise it if large local canvases fail to load assets. |
system/max-concurrent-tasks |
0 |
Maximum number of background tasks Canvus runs at the same time. 0 lets Canvus choose from the number of CPU cores. |
Remote touch
These settings control the network address remote devices use to send touch to screen share widgets. Changing them requires a restart. See Remote touch.
| Key | Default | Meaning |
|---|---|---|
remote-touch/interface |
em1 on Ubuntu when server-ip is not set, otherwise empty |
Network interface that remote devices connect to. |
remote-touch/server-ip |
empty | IP address that remote devices connect to, if you do not set an interface. Useful on Windows, where interface names can change. |
remote-touch/port |
5010 |
First port used for remote touch. Each source uses its own port, from this port up to 100 ports above it (5010 to 5110 by default). |
If neither interface nor server-ip is set, Canvus uses the first valid IPv4 address it finds.
Video outputs and video inputs
[output:<name>] blocks define the video outputs on a video wall. <name> is the name users see in Canvus. See Video outputs.
; [output:Projector]
; Position of the output area on the desktop, in pixels.
; DEFAULT: 0 0
; location=5180 0
; Size of the output area, in pixels.
; DEFAULT: 0 0
; size=1920 1080
[video-input:<device>] blocks give a video input device the name users see in Canvus. On Ubuntu, <device> is the device name without the /dev/ prefix, for example video0 (from Canvus 26.4.1). On Windows, it is the full video=... device string from the Canvus log. See Video inputs.
; [video-input:video0]
; name=Front camera
Auxiliary PC and remote mount
The auxiliary PC feature is deprecated. Remote desktop (RDP) replaces it: use an RDP connection to work with Office documents and other applications on a Windows computer. See Auxiliary PC. The [auxiliary-pc] and [local-share] sections are no longer described here; leave them unset on new installations.
The [remote-mount] settings control mt-canvus-daemon, the local helper that mounts remote shares:
| Key | Default | Meaning |
|---|---|---|
remote-mount/daemon-port |
8081 |
Port of the local mt-canvus-daemon that mounts remote shares. Requires a restart. |
remote-mount/mount-folder |
/mnt |
Ubuntu: folder that remote shares are mounted under. Windows: folder that holds links to remote shares. Requires a restart. |
remote-mount/mount-options |
empty | Comma-separated extra options for the mount command, for example vers=2.0. Ignored on Windows. |
remote-mount/log-messages |
false |
Log the messages sent to and from mt-canvus-daemon. |
Plugins
The [plugins] section turns individual plugins off. Each key is the base name of the plugin's library file, and false stops that plugin from loading at the next start. A plugin without a key is on. From Canvus 26.5.1 you can also set these from the Settings page. See Plugins.
[plugins]
libExamplePlugin=false
Canvas call
The [canvas-call] section decides what this installation may use in the canvas call, the live voice and head shots shared by everyone who has the same canvas open. Both keys default to true. With one set to false, that half is left out of the call panel. With both set to false, the canvas call is not offered on this installation at all. Whenever the call is offered, the installation plays what other people say. The Server has its own switch, canvas-call-enabled; see Canvas call. For what each combination does, see Canvas call administration.
[canvas-call]
; Set to false to never use a camera on this installation, so no head shots
; are sent from it.
; DEFAULT: true
; allow-camera=true
; Set to false to never use a microphone on this installation, so nobody on
; it can be heard in the canvas call.
; DEFAULT: true
; allow-microphone=true
Deprecated keys
Canvus still reads these older names. Use the current name: the update merge comments out the old names marked below.
| Old name | Current name | Notes |
|---|---|---|
system/desktop-mode |
system/multi-user-mode-enabled and system/virtual-keyboard-enabled |
off = multi-user mode with virtual keyboard, keyboard = single-user mode without virtual keyboard, tablet = single-user mode with virtual keyboard. Kept by the update merge. |
system/fixed-workspaces |
[fixed-workspace:<index>] blocks |
List of sizes in the form <width>x<height>. Ignored when any [fixed-workspace:<index>] block exists. Kept by the update merge. |
system/enable-personal-folders |
system/enable-codice-folders |
The update merge moves the value to the current name. |
system/show-logout-options |
welcome-screen/allow-exit |
The update merge moves the value to the current name. |
system/enforce-protected-canvas |
system/enforce-canvas-password |
The update merge moves the value to the current name. |
[canvus-connect] section |
[identity] section |
From Canvus 26.11.1 the update merge moves the keys to [identity]; where both sections set the same key, the [identity] value is kept. Earlier versions comment them out. |
remote-desktop:<name>/hostname |
remote-desktop:<name>/host |
Commented out by the update merge. |
Removed keys
These keys never had an effect and were removed from the example file in Canvus 26.11.1. If your mt-canvus.ini sets one, the next update comments it out with a note.
| Key | Notes |
|---|---|
smtp/ignore-proxy |
Email is always sent through the system proxy settings. |
content/plugin-folders |
|
system/admin-info |
Canvus did not show the admin contact information anywhere. |
system/min-workspace-width-for-info-panel |
|
video-streaming/out-gop-size |