Skip to content

Frequently Asked Questions

Common questions about administering a MultiTaction Canvus Server that don't fit neatly elsewhere in the manual. If you don't find an answer here, check Installation and Administration, or see Command-line arguments for the full CLI reference.

How do I create a local emergency admin account from the CLI?

Use this when you cannot sign in to the web UI as an administrator: your single sign-on identity provider is down, or every existing administrator is locked out. The command runs on the server machine and creates a local account (email and password) that does not depend on any external sign-in provider.

The command connects to the Canvus Server running on the same machine, so the server must be running.

Warning

Passing a password directly on the command line is not secure on a shared system: anyone who can read the shell history or process list can see it. Omit the password argument and Canvus generates a random one, printed once to the console.

1. Open a command line with administrator privileges

  • Windows: Start menu → type cmd → right-click Command Prompt → Run as administrator.
  • Ubuntu (bare-metal): open a terminal; prefix each command below with sudo.
  • Podman/Docker (containerised): open a terminal on the host. You only need enough privilege to run podman exec.

2. Create the account

  • Windows:
    "C:\Program Files\MT Canvus Server\bin\mt-canvus-server.exe" --create-admin emergency-admin@example.com
    
  • Ubuntu (bare-metal):
    sudo /opt/canvus/bin/mt-canvus-server --create-admin emergency-admin@example.com
    
  • Podman/Docker (containerised):
    sudo podman exec -it canvus-combined /opt/canvus/bin/mt-canvus-server --create-admin emergency-admin@example.com
    

Add a password after the email (--create-admin emergency-admin@example.com YourStrongPassword) if you'd rather set one explicitly instead of using the generated one. A password set this way is not checked against the server's password policy, so choose a strong one.

This creates the account as a full administrator, independent of any existing login provider.

3. Confirm the account exists

  • Windows:
    "C:\Program Files\MT Canvus Server\bin\mt-canvus-server.exe" --list-users
    
  • Ubuntu (bare-metal):
    sudo /opt/canvus/bin/mt-canvus-server --list-users
    
  • Podman/Docker (containerised):
    sudo podman exec -it canvus-combined /opt/canvus/bin/mt-canvus-server --list-users
    

Look for the account in the output, with type admin and state active.

4. Sign in

Open the Canvus server web UI as normal and sign in with the new account and the password you set (or the generated one printed in step 2).

If something goes wrong

Forgot the password, or need to reset it: use --change-password in place of --create-admin:

  • Windows: "C:\Program Files\MT Canvus Server\bin\mt-canvus-server.exe" --change-password emergency-admin@example.com
  • Ubuntu: sudo /opt/canvus/bin/mt-canvus-server --change-password emergency-admin@example.com
  • Podman: sudo podman exec -it canvus-combined /opt/canvus/bin/mt-canvus-server --change-password emergency-admin@example.com

Account shows as blocked: run --unblock-user emergency-admin@example.com with the same per-platform prefix as above.

The command cannot connect: check that the Canvus Server service or container is running.

See Command-line arguments for the full list of user-management commands.

5. Clean up once you're back in

This account is for emergencies. Don't leave it as a standing backdoor. Once normal admin access is restored, either delete it or block it for next time:

  • Delete: --delete-user emergency-admin@example.com
  • Block (keeps it in reserve, unblock later in seconds): --block-user emergency-admin@example.com

Prefix either command with the platform-specific binary path or podman exec wrapper shown in step 2.