Skip to main content

Install on Windows

Cordatus Client is a Linux application. On Windows it runs inside its own Linux environment, built on WSL 2 (Windows Subsystem for Linux). The Cordatus installer sets all of this up for you: you do not need to install WSL, Ubuntu or anything else first.

tip

If you plan to use Cordatus on a Linux system (for example Ubuntu) instead of Windows, skip this page and follow the Desktop (GUI) guide.

Requirements​

WindowsWindows 11 for the Cordatus desktop app. Windows 10 (version 2004 or newer) can run Cordatus only as a background service.
Processorx86_64 (Intel or AMD), with virtualization enabled in the BIOS/UEFI. It is enabled on most computers.
DiskAbout 20 GB free, plus space for the models and recordings you plan to keep.
AccountAdministrator rights on the computer.
InternetAccess to download.cordatus.ai and to Microsoft's servers.

An NVIDIA GPU is optional. To use one, keep the NVIDIA driver on Windows up to date; current drivers include GPU support for WSL. Do not install an NVIDIA driver inside Linux.

Install the Cordatus Client​

  1. Open PowerShell as administrator. Click the Start menu, type PowerShell, right-click Windows PowerShell and choose Run as administrator.

  2. Run the installer:

    irm https://download.cordatus.ai/install.ps1 | iex

  3. Answer the questions:

    • If WSL is not installed yet, the installer asks to install it. Type y and press Enter. Windows may then need a restart; after restarting, open PowerShell as administrator again and run the same command.
    • At How should Cordatus run?, press Enter to choose 1) Desktop app.

  4. Wait for it to finish. The installer downloads the Cordatus Linux environment and the newest Cordatus Client, which takes several minutes. It finishes by opening the Cordatus window and printing Done.

Install from the account that will use Cordatus

The Cordatus environment belongs to the Windows account that installs it. Run the installer while signed in as the person who will use Cordatus, not from a separate administrator account.

Add the Device to Your Account​

When the Cordatus window opens, sign in exactly as on a Linux desktop: click Login and use your Cordatus account details or a client token, then assign a license. See Adding a Device with User Credentials and Adding a Device with Token.

Opening and Closing Cordatus​

  • Open Cordatus from the Start menu (Cordatus (Cordatus)) or from the Cordatus shortcut on the desktop.
  • The device is online while the Cordatus window is open. After Windows restarts, open Cordatus again.
  • Close Cordatus with the window's close button, as on Linux. The device then appears offline in the Cordatus Web App.

Update​

Run the install command again in PowerShell as administrator. Cordatus is already installed, so the installer asks what to do; press Enter to choose U) Update it. Recordings, models and settings are kept.

danger

Choose R) Replace it only if you want to start from scratch. It deletes everything stored in Cordatus on this computer.

Uninstall​

Open Settings → Apps → Installed apps, find Cordatus and choose Uninstall. This deletes the Cordatus Linux environment and everything in it, including recordings, models and local data. Back up anything you need first.

What Is Different on Windows​

Remote DesktopNot available. Cordatus runs inside WSL and cannot see the Windows desktop.
CamerasIP cameras (RTSP, ONVIF) work as usual. USB cameras are not passed into WSL automatically, so IP cameras are recommended.
Memory and CPUWSL's share of the computer is set in %USERPROFILE%\.wslconfig. If that file does not exist, the installer creates it with 8 GB of memory and 4 processors. Adjust the values for your computer, then run wsl --shutdown and open Cordatus again.
Docker DesktopCan stay installed. Cordatus brings its own Docker. Do not turn on Docker Desktop's WSL Integration for the Cordatus distribution.
Do not install Cordatus inside your own WSL distribution

If you already use WSL (for example Ubuntu), do not also install Cordatus there with the Linux install command. Two Cordatus Clients on the same computer conflict with each other. If you installed one there before, remove it, replacing Ubuntu with the name of your distribution:

wsl -d Ubuntu -u root -- dpkg -r cordatus

Background Service​

For a computer that should run Cordatus without anyone using it, or on Windows 10, choose 2) Background service at the How should Cordatus run? question. Cordatus then runs without a window, and you manage the device entirely from the Cordatus Web App.

Because there is no window to sign in from, give the installer a client token so the device adds itself to your account. See Generating Client Tokens, then run:

& ([scriptblock]::Create((irm https://download.cordatus.ai/install.ps1))) -Mode Headless -Token <your-token>

Troubleshooting​

What you seeWhat to do
The installer asks you to restart WindowsRestart, then run the same command again in PowerShell as administrator.
The installer says the desktop app needs Windows 11You are on Windows 10. The installer installs the background service instead.
Anything elseThe installer writes a full log to %APPDATA%\Cordatus\install.log. Include it in your support request.