Skip to content

Command-line arguments

Canvus Connect server supports a number of command-line arguments that can be provided starting the executable. For the location of the server application, see server-application

Usage:

mt-canvus-server [options]

Available options:

--help Show this help. --version Show version information. --activate \<activation key> Activate a server license over the internet using an activation key. --create-license-request \<activation key> Create an offline license activation request in the user\'s home directory using an activation key. --reload-certs Reload the server TLS certificates after renewal. --clear-db Permanently delete everything in the Canvus database, including all canvases, folders and users. --server-config \<filename> Set the server configuration file. Default: /etc/MultiTaction/canvus/mt-canvus-server.ini

--no-crash-reporter Disable the built-in crash reporting system and automatic crash dump upload. --verbose Print out verbose debug information. --configure-db Automatically set up the local Postgresql server and configure Canvus DB settings if needed. Run as root (with sudo) to make sure the application has access to DB and config.

Commands for managing users:

Some commands have optional [passwd] parameter that allows to specify the new password from the command line. If this parameter is not given, a random password is generated instead. Giving the password from command line is not secure on a shared system.

--list-users

: List all users on the server.

--create-user \<email> [passwd]

: Create a new admin user.

--create-admin \<email> [passwd]

: Create a new admin user.

--delete-user \<email | id>

: Delete a user.

--change-email \<email | id> \<new email>

: Change a user login / email address.

--change-name \<email | id> \<name>

: Change a user name.

--change-password \<email | id> [passwd]

: Change a password for an existing user.

--make-admin \<email | id>

: Make an existing user an admin.

--make-normal-user \<email | id>

: Make an existing admin a normal user.

--block-user \<email | id>

: Block an existing user.

--unblock-user \<email | id>

: Unblock an existing user.

Commands for creating and restoring backups:

--backup Make a backup of Canvus multisite server and exit. Uses exit code 0 on

: success.

--restore Restore a Canvus multisite server backup from the path specified with

: --backup-path and exit. Any existing canvases and assets will be deleted. Run as an admin user.

--backup-path \<path> Specify the folder where the backup is created to (with --backup) or

: restored from (with --restore). When creating a backup and --backup-path is specified, the backup is written directly to the given folder. If not specified when creating a backup, a new subfolder is created under the \'backup/root\' folder specified in the configuration file and the backup is written to the subfolder. When restoring a backup, this parameter is mandatory.

--backup-skip \<list>

: Can be used to exclude parts of the data from the backup process. Only used with --backup command. \<list> can be a comma-separated list of following tokens:

-   db
-   assets

--backup-delete

: Delete all files and folders in the backup-path prior to writing the new backup in there. Only used with --backup command.