Reference
Settings
Admin
Set by an admin in Settings, under the plugin's name. It applies to everyone.
| Setting | Type | Default | What it does |
|---|---|---|---|
| Enable Remote Desktop | boolean | true | Allow RDP, VNC and Telnet connections. |
| Use an external guacd | boolean | false | Termix runs RDP, VNC and Telnet itself. Turn this on to send them to your own guacd instead. REMOTE_DESKTOP_ENGINE overrides this. |
| guacd URL | string | Where guacd listens, as host:port. The GUACD_URL, GUACD_HOST and GUACD_PORT environment variables override this. | |
| RustDesk ID server | string | Your own RustDesk ID server (hbbs), as host or host:port. Leave empty to use the public RustDesk server. Hosts can set their own. | |
| RustDesk relay server | string | Your RustDesk relay server (hbbr). Leave empty to use what the ID server says. | |
| RustDesk server key | string | The public key of your RustDesk server, from id_ed25519.pub. Needed with your own server. | |
| Moonlight Web address | string | The Moonlight Web server Termix talks to, for Sunshine streaming. See the docs to run one. | |
| Moonlight Web public address | string | The address browsers open, if it differs from the one above. HTTPS is needed for gamepads and keyboard lock. | |
| Moonlight Web username | string | An admin login on Moonlight Web. Termix uses it to list, add and pair PCs. | |
| Moonlight Web password | secret | The password for that login. | |
| Ignore Moonlight Web certificate | boolean | false | Turn on for a self-signed certificate on Moonlight Web. |
User
Each person sets these for themselves in Settings.
| Setting | Type | Default | What it does |
|---|---|---|---|
| Start Quick Connect sessions view only | boolean | false | Quick Connect RDP, VNC and ARD sessions open without sending your mouse and keyboard. Turn input on from the toolbar when you want to act. |
Host
Set per host in the host editor, on the plugin's tab. Host defaults can set them for many hosts at once.
| Setting | Type | Default | What it does |
|---|---|---|---|
| Color Depth | select | "inherit" | Used for RDP hosts that leave it on their default. |
| Resize Method | select | "inherit" | How the remote screen follows the window size. |
| Force Lossless | select | "inherit" | Force lossless image encoding (higher quality, more bandwidth) |
| Wallpaper | select | "inherit" | Show desktop wallpaper (disabling improves performance) |
| Font Smoothing | select | "inherit" | Enable ClearType font rendering |
| Desktop Composition | select | "inherit" | Enable Aero glass effects |
| Disable Audio | select | "inherit" | Mute all audio from the remote session |
| Enable Printing | select | "inherit" | Redirect local printers to the remote session |
| Enable Drive Redirection | select | "inherit" | Map a local folder as a drive in the remote session |
| Disable Copy | select | "inherit" | Prevent copying text from the remote session |
| Disable Paste | select | "inherit" | Prevent pasting text into the remote session |
Environment variables
Set these on the Termix server, for example under environment: in your compose file. See environment variables for the ones core and other plugins read.
| Variable | Default | What it does |
|---|---|---|
REMOTE_DESKTOP_ENGINE | builtin | builtin runs RDP, VNC and Telnet inside Termix. guacd sends them to an external guacd instead. Overrides the Use external guacd setting. |
RDP_DRIVE_PATH | /app/data/plugin-data/remote-desktop/rdp-drive | Folder the built-in engine keeps RDP drive files in. Each user gets a folder under it. |
GUACD_HOST | localhost | Host an external guacd listens on. Only used with Use external guacd. Overrides the guacd URL setting. |
GUACD_PORT | 4822 | Port an external guacd listens on. |
GUACD_URL | An external guacd as host:port, in place of GUACD_HOST and GUACD_PORT. | |
GUACD_TUNNEL_HOST | termix | Address an external guacd uses to reach Termix for hosts behind jump hosts and VNC without a username. In Compose, the Termix container name. In Kubernetes it defaults to the pod IP. |
GUACD_RECORDING_PATH | Folder an external guacd writes recordings to, as guacd sees it. | |
GUACD_RECORDING_BACKEND_PATH | /app/data/plugin-data/remote-desktop/session_recordings/guacamole | Folder Termix keeps remote desktop recordings in. With an external guacd, the same folder as Termix sees it. |
GUACD_DRIVE_PATH | /drive | Folder an external guacd keeps RDP drive files in. Each user gets a folder under it. |
GUACAMOLE_ENCRYPTION_KEY | Key that encrypts connection tokens, 64 hex characters. Made for you on each start if not set. Set it when you run more than one Termix server. |
Permissions
Give these to roles in Settings, Roles.
| Permission | Who has it at first | What it allows |
|---|---|---|
remote-desktop.sessions | admin, user | Let session sharing and collab rooms show this user's RDP, VNC and Telnet sessions to others. |
remote-desktop.monitor | admin | Lets other features, such as Session Recording, list, watch and end the RDP, VNC and Telnet sessions of every user. |
remote-desktop.moonlight | admin | Add Sunshine PCs to Moonlight Web and pair them, using the saved Moonlight Web login. |
Actions
Run these from Operations Center, Automations, the CLI (termix ops), the phone app or the API. See actions.
| Action | Runs on | Risk | Inputs |
|---|---|---|---|
remote-desktop.check-portsCheck remote desktop ports | A host | Read only | |
remote-desktop.sessionsOpen remote sessions | A host | Read only |
Capabilities
What the plugin's code is allowed to do. Termix shows this list before you install it. See capabilities for all of them.
| Capability | Risk | What it means |
|---|---|---|
credentials:read | Critical | See your passwords and keys. It can read the stored secret for any host you can reach. |
ssh:connect | High | Run commands on your servers. Any command, on hosts you connect it to, with your access. |
desktop:local | High | Use this computer. Can read and change files, run a shell and open local ports on this computer. Only in the Termix desktop app. |
users:impersonate | High | Act as other users. Runs background work with another user's access, such as scheduled jobs. Every use is written to the audit log. |
network:sockets | High | Open its own network connections. It can listen on ports and connect to any address directly, without Termix checking each connection. |
credentials:use | Medium | Connect to your servers. It cannot see your passwords or keys. |
network:serve | Medium | Accept connections. It opens a port on the Termix server. |
operations:provide | Medium | Offer actions. Its actions can be run from Automations, the CLI, the phone app and other places, by people allowed to use them. |
hosts:read | Low | See your host list. Names and addresses for hosts you can already see. |
ui:surface | Low | Add its own screens. Tabs, panels and settings you can hide later. |
files:own | Low | Store its own files. In its own folder on disk, separate from other plugins. |
Works with other plugins
Works better with: session-recording ^1.0.0, tunnels ^1.0.0.
Services
Services are how plugins call each other. Plugin authors can use these.
| Provides | Version | Permission |
|---|---|---|
sessions.live (rdp, vnc, ard, telnet, rustdesk) | 1.1.0 | remote-desktop.sessions |
remote-desktop.console | 1.0.0 | remote-desktop.sessions |
| Uses | Version | Optional |
|---|---|---|
recordings.writer | ^1.1.0 | yes |
tunnels.access | ^1.0.0 | yes |
API
The plugin's HTTP routes are in the API reference.
Platforms
Linux, Windows, macOS