Enrolling devices

• Unattended (your fleet): servers and managed endpoints. Permanent until removed. Uses a persistent agent API key. Result: a device with a permanent 9-digit Silux ID.
• Attended / Quick Support (someone else's machine): ad-hoc support. One session, code expires. Uses a one-time Quick Support code.

• Silux ID — a unique 9-digit number per machine (like a TeamViewer ID), generated automatically.
• Enrollment token — one-time; the agent uses it on first run to join your tenant, then it is erased from disk.
• Agent API key — the persistent credential used afterwards (X-Silux-Api-Key).
• Quick Support code — one-time, time-limited (optionally IP-bound) for attended sessions.

1. Get the agent + token: open Downloads in the console — the agent comes pre-configured with your server URL and a one-time enrollment token for your tenant.

2. Install:

• Windows: run the .msi as administrator.
• macOS: run the .pkg; grant Screen Recording + Accessibility when prompted (required for control).
• Linux: install the package or run the binary as a service.

Agent config:

api_url      = "https://<your-server>"   # hosted or your own domain
enroll_token = "<one-time token>"          # erased after first enroll

3. First run: the agent calls POST /enroll. The server resolves your tenant, checks your device limit, generates a unique 9-digit Silux ID + API key, and returns them; the agent stores the key and erases the token.

4. Verify: the device shows online in Devices; open it → Start live viewer to confirm control.

1. Generate a Quick Support code in the console (short TTL).
2. The user runs the small Quick Support app and enters the code.
3. They join your tenant for a temporary session; the code is single-use and expires. Nothing permanent is left behind unless you convert it to a managed device.

• 401 auth.required — missing/expired token or key; get a fresh token from Downloads.
• 402 device_limit_reached — plan device cap hit; remove a device or upgrade.
• 403 tenant_mismatch — the agent's Silux ID belongs to another tenant; re-enroll clean.
• Offline after install — agent can't reach api_url/relay; check the server URL, firewall, and that the relay WebSocket port is open.
• Screen shows but input does nothing (macOS) — grant Accessibility permission to the agent.

• API/console over HTTPS (api_url) — enrollment, heartbeat, RMM, MDM.
• Relay WebSocket (RELAY_WS_PUBLIC_URL) — live remote-desktop / terminal / file-transfer streams. Ensure this port is reachable from the device's network.
• Optional: UDP 3478 on the relay host (STUN) — lets sessions go direct peer-to-peer between the computer and the browser. If it is blocked the relay carries the session; Security policy → Direct connections turns it off entirely.

The agent sends API calls and the relay WebSocket through an HTTP proxy (CONNECT, with Basic login) or SOCKS5. Set it once and restart the service:

silux-agent set-proxy http://user:password@proxy.corp:3128
silux-agent set-proxy socks5://proxy.corp:1080
silux-agent set-proxy off        # direct again (also ignores HTTPS_PROXY)

Without a setting the agent uses SILUX_PROXY, HTTPS_PROXY or ALL_PROXY; NO_PROXY lists hosts to reach directly. silux-agent status shows the proxy in use.

silux-agent get-id                 # print this computer's Silux ID
silux-agent set-password <pw>      # unattended-access password (8+ characters; stdin if omitted)
silux-agent set-password --clear   # remove it
silux-agent connect 123456789      # open the console ready to connect to that ID
silux-agent status                 # config, identity, proxy, update status
silux-agent enroll --api-url <url> --token <token>

Run as administrator / root on the computer itself while the agent service is running: set-password proves it is that computer with its current access code, so a shared installer key alone can't set passwords elsewhere. The password uses your workspace's default permission profile and every change is audit-logged. On Linux the command is silux-connect-agent; on Windows "C:\Program Files\SiluxConnectAgent\silux-agent.exe".