Windows

This section describes steps required to install Canvus server on Windows.

Note

On Windows, Canvus Connect server requires one of the following operating systems:

64-bit Windows 10 Professional
64-bit Windows 2016 Server
64-bit Windows 2019 Server

Install Canvus server

Download the latest Canvus server version from the Canvus download page.

Run the Canvus server installer as an administrator.

Database setup

Download and install PostgreSQL from the EnterpriseDB® web site. Use PostgreSQL 10 or newer.

During PostgreSQL installation you don\'t need to include any PostgreSQL Stack Builder packages, but you can accept the other default settings. The installer asks for a new password for the database [postgres]{.title-ref} user. Remember this password, you will need it later when creating the database.

Next, open an Administrator Command Prompt and setup the Canvus Connect database and database user by running this command:

"%ProgramFiles%\MT Canvus Server\bin\mt-canvus-server.exe" --configure-db

This command will add a new database and a database user with a random password and store those settings in the server configuration file %ProgramData%\MultiTaction\canvus\mt-canvus-server.ini. The configuration file is created if it doesn\'t already exist.

This command is safe to run multiple times. Any existing values in the configuration file are used as is.

The tool will ask for the [postgres]{.title-ref} user password when it needs it.

Alternatively, you can also Configure the database manually.

(Optional) Configure Canvus server

Canvus Connect server will start and work using its default settings. However, if you want to change the default settings you need to edit the server configuration file mt-canvus-server.ini.

When editing the configuration file, any lines starting with ; character are treated as comments. Make sure to remove the preceding ; on the lines you edit.

Tip

server-config-file-windows

You can also change much of the configuration using the web UI.

(Optional) Define connection types

By default, Canvus server will listen on port 443 for encrypted SSL and HTTPS connections. It will also redirect HTTP from port 80 to port 443. Canvus will automatically generate self-signed SSL certificates on startup.

If want to change these default settings, see server-configuration-connections.

If the default settings are fine, continue to start-server-windows.

Start or stop Canvus server

This section describes how to start, restart and stop the Canvus server.

The server runs as the mt-canvus-server service. To start or stop the service:

Open the Windows Services applet as an administrator.
Double-click MT Canvus Server in the service list.
In the Properties dialog, click the Start or Stop buttons, as required.

After the service has started, log entries record server activity. For details about where to find the log files, see server-log-file.

Tip

You can also manage the server using an Administrator Command Prompt:

Start server: sc start mt-canvus-server
Stop server: sc stop mt-canvus-server
Check server: sc query mt-canvus-server

Start or stop Canvus web UI

Note

The Canvus server service must be running before you start the server web UI.

The Canvus server web UI runs as a separate mt-canvus-dashboard service. To start or stop the web UI:

Open the Windows Services applet as an administrator.
Double-click MT Canvus Dashboard in the service list.
In the Properties dialog, click the Start or Stop buttons, as required.

After the service has started, log entries record server activity. For details about where to find the log files, see server-log-file.

Tip

You can also manage the web UI using an Administrator Command Prompt:

Start web UI: sc start mt-canvus-dashboard
Stop web UI: sc stop mt-canvus-dashboard
Check web UI: sc query mt-canvus-server

Create administrator user

In order to manage your Canvus server, you need to create at least one administrator user account on the Canvus server.

Open an administrator Command Prompt

Run the following command:

"C:\Program Files\MT Canvus Server\bin\mt-canvus-server" --create-admin <email>

For example, "C:\Program Files\MT Canvus Server\bin\mt-canvus-server" --create-admin admin@example.com. A password will be automatically generated for the user and displayed in the terminal.

Tip

Use "C:\Program Files\MT Canvus Server\bin\mt-canvus-server" --help for a list of all accepted command-line arguments.

Activate your license

You can now proceed to sign in to the Canvus server web UI and activate your Canvus server license. See server-licensing for details.