Settings page
New in Canvus client 26.4.0, the in-app Settings page provides a graphical interface for configuring MultiTaction Canvus client settings. Settings are grouped into collapsible sections, each one corresponding to a section of the mt-canvus.ini configuration file, so you can find and change options without editing the file in a text editor.
The Settings page does not replace mt-canvus.ini. It edits the working copy of that file on disk: changes you save are written to the mt-canvus.ini file that Canvus is reading. Canvus reads the file when it starts, so both changes saved here and manual edits to the file take effect, and show on this page, after the next restart. Advanced settings that are not exposed in the Settings page can still be configured by editing mt-canvus.ini directly.
Note
For every setting and its INI file equivalent, see Configuration file. The Settings index maps each control on this page to its key.
Opening the settings page
- Open the main menu and tap the settings icon.
- Under Client, select Configuration.
The Settings page opens, showing all configuration groups with their sections collapsed.
The Client list in the settings menu also has Default canvas, Default colours and Virtual keyboard. These write the system/default-canvas, canvas/default-pen-color-presets, canvas/default-note-background-color-presets and system/virtual-keyboard-layouts keys. If Canvus is reading the system-wide file, they save to a new per-user file instead; see Which file Canvus reads.
Navigating sections
Tap any section header to expand it and reveal the settings inside. Tap the header again to collapse it.
Settings are organized into ten numbered groups. Groups 2 and 7 have no controls; see Settings that are not on this page below.
1. Identify this machine
- Identity: installation name for this Canvus client (
installation-name).
2. Collaboration and multi-site
This group has no controls. It shows "To configure these settings contact your admin." Canvus Connect servers ([server:<name>] blocks) are set in mt-canvus.ini; see Configure Canvus Connect.
3. Core system and storage
- System: Canvus folder, Codice server and Codice features, inactive timeout, canvas password enforcement, presentation timeout, snapshot limits, password character display time, virtual keyboard and multi-user mode, minimum window size, file and task limits, menu timeout, visible drives, keyboard layouts, default canvas, and lock-config.
- Content: data folder (
root). Requires restart. - Cache: cache maximum age (
max-age). - Backup: backup folder (
root). Requires restart.
4. Email out
- Email (SMTP): outbound mail server host, port, username, password and connection encryption. All require restart. The section also shows an Ignore proxy control, which has no effect.
- Email (Content): sender name, sender address, email subject, maximum attachment size, default email address, allow-user-email.
5. UI defaults
- Welcome Screen: whether users can exit Canvus from the welcome screen (
allow-exit). - Canvas: canvas size, pin-canvas, anchor-viewport, zoom-viewport, auto-pin-after, custom menu file.
- Widget: auto-pin-after, activation gestures.
- Web Browser: start page, search URL, upload sites, persistent sessions, mouse emulation, local file access (
allow-file-urls). - Annotation: eraser marker codes and eraser size.
- Password Security: canvas password rules: minimum length, lowercase, uppercase, numeric and symbol counts, maximum repeats and sequence length.
6. Media widgets
- PDF: PDF raster resolution.
- Video: tap-to-play, screen share audio.
- Video Stream: capture card and webcam preferences: minimum and maximum frame rate, minimum and maximum resolution, prefer-uncompressed.
- Image Search: Google Custom Search API key and engine ID. Both fields are masked.
7. Display and rendering
This group has no controls. It shows "To configure these settings contact your admin." Fixed workspaces ([fixed-workspace:<index>] blocks) and video outputs ([output:<name>] blocks) are set in mt-canvus.ini; see Fixed workspaces and Video outputs and video inputs.
8. Input hardware
- Remote Touch: remote touch interface, port and server IP. All require restart.
- Hardware: third-party touch device support (
third-party-touch). Requires restart. - Touch Mode Selector: timeout, home position (x and y percent) and radius.
9. External integrations
- Local Share: shared folder settings of the deprecated auxiliary PC feature.
- Remote Mount: daemon port (requires restart), mount options, mount folder (requires restart), log messages.
- Auxiliary PC: settings of the deprecated auxiliary PC feature, which RDP replaces. See Auxiliary PC.
10. Plugins
- Plugins: one toggle for each plugin Canvus found at start-up. A plugin is on by default; turning it off writes
<plugin library name>=falseto the[plugins]section ofmt-canvus.ini. Every plugin toggle requires a restart. See Plugins.
Editing settings
- Expand a section by tapping its header.
- Locate the setting you want to change.
- Edit the value using the provided control.
Each setting uses a control appropriate for its type:
- Toggle: on/off settings, for example
pin-canvasormouse-emulation. - Number field: whole-number settings such as timeouts in seconds, port numbers and size limits.
- Text field: short strings such as a sender name, email subject, host name or SMTP connection encryption.
- File or folder picker: path settings such as the data folder or backup folder.
- List editor: comma- or space-separated values such as
virtual-keyboard-layouts,show-volumesorminimum-window-size. - Password field: credentials and keys such as the SMTP password, the auxiliary PC password and the image search key. The field is always empty when the page opens. Canvus saves the value only if you type a new one, so leave the field empty to keep the current value.
- Dropdown:
auto,trueorfalseformulti-user-mode-enabled,virtual-keyboard-enabledandpersistent-sessions.
Some settings show the notice Requires Restarting to Apply below the control. The Settings index lists them. In the current version every change saved on this page takes effect only after a restart; see Saving changes.
Saving changes
When you have made your changes, tap Save to write them to the configuration file. Canvus writes only the settings you changed.
- Restart Canvus to apply the saved settings. Canvus does not restart by itself. From Canvus 26.11.1 a message confirms the save and reminds you to restart, or reports that the save failed, and the Settings page shows the values you saved when you open it again before restarting. Until you restart, the running session keeps using the old values.
- Tap Cancel to discard all unsaved changes.
The page saves to the user's own per-user mt-canvus.ini. On Ubuntu, Canvus reads the system-wide file /etc/MultiTaction/canvus/mt-canvus.ini unless a per-user file exists, and only root can write that file. From Canvus 26.11.1 the first save creates the per-user file as a copy of the system-wide file, and Canvus reads it from the next start. In earlier versions a save on a fresh Ubuntu install failed without a message on screen. See Which file Canvus reads.
Settings that are not on this page
Groups 2 and 7 show "To configure these settings contact your admin." instead of controls. Their settings are stored in mt-canvus.ini like all the others, but the Settings page does not edit them:
- Group 2, Collaboration and multi-site: Canvus Connect servers (
[server:<name>]). - Group 7, Display and rendering: fixed workspaces (
[fixed-workspace:<index>]) and video outputs ([output:<name>]).
Several other keys are also set only in mt-canvus.ini, for example [remote-desktop:<name>] blocks, [certificates], the [annotation] smoothing keys and the background video limits. The Settings index lists which keys have a control.
When lock-config is true, for example on a video wall, the whole Settings page is replaced by the message "Configuration is locked by your administrator and cannot be modified." Change settings by editing mt-canvus.ini directly.
Related
- Configuration file: full reference for all settings and their INI file format.
- Settings index: every Settings page control with its INI key.