Install the agent on Windows, macOS, Ubuntu and Debian
Install the Silux Connect host agent as a background service, enrol it into your workspace, and grant the macOS permissions it needs.
Where:
/downloadsOn this page
Before you start
| System | Package | Supported versions |
|---|---|---|
| Windows | .msi (64-bit) | Windows 10 and 11 |
| macOS | .pkg (Apple Silicon + Intel) | Intel Macs from macOS 10.12, Apple Silicon from macOS 11. The desktop app needs macOS 10.15 or later. |
| Ubuntu | .deb | Ubuntu 22.04 or later |
| Debian | .deb (same file as Ubuntu) | Debian 12 or later |
- Download installers from Downloads in the console (
/downloads) or the public download page. Each file shows its SHA-256 checksum so you can check the download. - You need administrator / root rights on the computer.
- To enrol a service install you need an enrolment key: a workspace API key with the
devices:enrollscope. A workspace owner creates it on API keys (New key → tickdevices:enroll→ Create key, then copy it — it is shown once). - Each enrolled computer counts towards your plan’s device limit (Free 20, Solo 50, Team 200, Business 1000).
Just want to reach your own PC?: Install the Silux Connect app instead and sign in — it enrols the computer for you. Use the standalone agent for servers, kiosks and machines nobody signs in to.
Windows (.msi)
- Run
silux-connect-agent-…-x64.msias an administrator (double-click and accept the UAC prompt, or deploy silently withmsiexec /i silux-connect-agent-…-x64.msi /qnfrom Intune, GPO or your RMM). It installs toC:\Program Files\SiluxConnectAgent\and registers the automatic service Silux Connect Agent. - Open an administrator Command Prompt or PowerShell and enrol:
"C:\Program Files\SiluxConnectAgent\silux-agent.exe" enroll --api-url <your Silux Connect server address> --token <enrolment key> sc.exe stop silux-agent sc.exe start silux-agent - The computer appears in Devices as Online with its new Silux ID.
Good to know: The installer never restarts Windows by itself, even in a silent install. The configuration lives in
C:\ProgramData\Silux\silux-agent.toml.macOS (.pkg)
- Open
silux-connect-agent-….pkgand follow the installer (it asks for an administrator password). - In Terminal, enrol and start it:
sudo silux-agent enroll --api-url <your Silux Connect server address> --token <enrolment key> sudo launchctl bootstrap system /Library/LaunchDaemons/io.silux.connect.agent.plist - Grant the two permissions macOS asks for — without them you get a black screen or a picture you can’t control:
- System Settings → Privacy & Security → Screen Recording (called Screen & System Audio Recording on newer macOS): switch on silux-agent.
- System Settings → Privacy & Security → Accessibility: switch on silux-agent. This lets the session move the mouse and type.
- Check Devices: the Mac is Online. Open a session to confirm you can see and control it.
Mac with no monitor: A Mac mini or Mac Pro with nothing plugged in gets a 1920×1080 virtual display at the start of each session, so there is always something to show. See Virtual monitors.
To remove the agent later, run sudo /usr/local/share/silux-agent/uninstall.sh.
Ubuntu and Debian (.deb)
- Install with apt so its dependencies come along (
xdotool,xclip,wl-clipboard— needed for typing and the clipboard):sudo apt install ./silux-connect-agent_<version>_amd64.deb - Enrol and start the service (on Linux the command is
silux-connect-agent):
Alternatively putsudo silux-connect-agent enroll --api-url <your Silux Connect server address> --token <enrolment key> sudo systemctl enable --now silux-connect-agentapi_urlandenroll_tokenin/etc/silux/silux-agent.tomland start the service — the one-time token is erased from the file after a successful enrolment. - The computer appears in Devices as Online.
Servers without a desktop: When nobody is signed in to a desktop, the agent starts a private desktop session so you still get a picture. Wayland desktops are supported through the desktop’s own remote-desktop interface.
Upgrades: install the newer .deb the same way; an enrolled agent keeps its identity and restarts on its own. The agent also updates itself.
Check it worked
- Devices lists the computer as Online with a 9-digit ID like
267-006-252. - On the computer,
silux-agent status(Linux:silux-connect-agent status) prints the configuration, identity, proxy and update status;silux-agent get-idprints just the Silux ID. - Open the device and press Connect → Start live viewer.
Agent command line
silux-agent get-id # print this computer's Silux ID
silux-agent status # config, identity, proxy, update status
silux-agent set-password <pw> # unattended-access password (8+ characters; asks if omitted)
silux-agent set-password --clear # remove it
silux-agent set-proxy http://user:password@proxy.example:3128
silux-agent set-proxy socks5://proxy.example:1080
silux-agent set-proxy off # direct again
silux-agent connect 123456789 # open the console ready to connect to that ID
silux-agent enroll --api-url <server> --token <enrolment key>Run these as administrator / root. On Linux use silux-connect-agent; on Windows use the full path "C:\Program Files\SiluxConnectAgent\silux-agent.exe". After set-proxy, restart the service. Without a proxy setting the agent honours SILUX_PROXY, HTTPS_PROXY, ALL_PROXY and NO_PROXY.
What the agent needs to reach
- Your Silux Connect server over HTTPS — enrolment, heartbeat, scripts, patches, inventory.
- The server’s relay WebSocket — live pictures, terminal and file transfer.
- Optional: UDP 3478 on the relay host, so sessions can go direct peer-to-peer. If it’s blocked the relay carries the session.
Related help
Getting started
Create your workspace, add your first computer and open a remote session — about ten minutes from start to finish.
Connecting to a computer
Every way to open a session: from the website, from the desktop app, by Silux ID + access code, with an unattended password, and from your phone.
Downloads
Installers published on your Silux Connect server — the app, the host agent and Terminal Sync — with SHA-256 checksums.
API keys
Scoped, workspace-bound keys for integrations and for enrolling agents.
Troubleshooting
Fixes for the most common problems: offline computers, black screens, no control on a Mac, slow pictures, clipboard, files, wake, sign-in and the tray icon.
