Skip to main content
Remote Desktop
TerminalSourceAPIChangelog

Reference

Settings​

Admin​

Set by an admin in Settings, under the plugin's name. It applies to everyone.

SettingTypeDefaultWhat it does
Enable Remote DesktopbooleantrueAllow RDP, VNC and Telnet connections.
Use an external guacdbooleanfalseTermix runs RDP, VNC and Telnet itself. Turn this on to send them to your own guacd instead. REMOTE_DESKTOP_ENGINE overrides this.
guacd URLstringWhere guacd listens, as host:port. The GUACD_URL, GUACD_HOST and GUACD_PORT environment variables override this.
RustDesk ID serverstringYour 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 serverstringYour RustDesk relay server (hbbr). Leave empty to use what the ID server says.
RustDesk server keystringThe public key of your RustDesk server, from id_ed25519.pub. Needed with your own server.
Moonlight Web addressstringThe Moonlight Web server Termix talks to, for Sunshine streaming. See the docs to run one.
Moonlight Web public addressstringThe address browsers open, if it differs from the one above. HTTPS is needed for gamepads and keyboard lock.
Moonlight Web usernamestringAn admin login on Moonlight Web. Termix uses it to list, add and pair PCs.
Moonlight Web passwordsecretThe password for that login.
Ignore Moonlight Web certificatebooleanfalseTurn on for a self-signed certificate on Moonlight Web.

User​

Each person sets these for themselves in Settings.

SettingTypeDefaultWhat it does
Start Quick Connect sessions view onlybooleanfalseQuick 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.

SettingTypeDefaultWhat it does
Color Depthselect"inherit"Used for RDP hosts that leave it on their default.
Resize Methodselect"inherit"How the remote screen follows the window size.
Force Losslessselect"inherit"Force lossless image encoding (higher quality, more bandwidth)
Wallpaperselect"inherit"Show desktop wallpaper (disabling improves performance)
Font Smoothingselect"inherit"Enable ClearType font rendering
Desktop Compositionselect"inherit"Enable Aero glass effects
Disable Audioselect"inherit"Mute all audio from the remote session
Enable Printingselect"inherit"Redirect local printers to the remote session
Enable Drive Redirectionselect"inherit"Map a local folder as a drive in the remote session
Disable Copyselect"inherit"Prevent copying text from the remote session
Disable Pasteselect"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.

VariableDefaultWhat it does
REMOTE_DESKTOP_ENGINEbuiltinbuiltin 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-driveFolder the built-in engine keeps RDP drive files in. Each user gets a folder under it.
GUACD_HOSTlocalhostHost an external guacd listens on. Only used with Use external guacd. Overrides the guacd URL setting.
GUACD_PORT4822Port an external guacd listens on.
GUACD_URLAn external guacd as host:port, in place of GUACD_HOST and GUACD_PORT.
GUACD_TUNNEL_HOSTtermixAddress 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_PATHFolder an external guacd writes recordings to, as guacd sees it.
GUACD_RECORDING_BACKEND_PATH/app/data/plugin-data/remote-desktop/session_recordings/guacamoleFolder Termix keeps remote desktop recordings in. With an external guacd, the same folder as Termix sees it.
GUACD_DRIVE_PATH/driveFolder an external guacd keeps RDP drive files in. Each user gets a folder under it.
GUACAMOLE_ENCRYPTION_KEYKey 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.

PermissionWho has it at firstWhat it allows
remote-desktop.sessionsadmin, userLet session sharing and collab rooms show this user's RDP, VNC and Telnet sessions to others.
remote-desktop.monitoradminLets other features, such as Session Recording, list, watch and end the RDP, VNC and Telnet sessions of every user.
remote-desktop.moonlightadminAdd 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.

ActionRuns onRiskInputs
remote-desktop.check-ports
Check remote desktop ports
A hostRead only
remote-desktop.sessions
Open remote sessions
A hostRead 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.

CapabilityRiskWhat it means
credentials:readCriticalSee your passwords and keys. It can read the stored secret for any host you can reach.
ssh:connectHighRun commands on your servers. Any command, on hosts you connect it to, with your access.
desktop:localHighUse this computer. Can read and change files, run a shell and open local ports on this computer. Only in the Termix desktop app.
users:impersonateHighAct as other users. Runs background work with another user's access, such as scheduled jobs. Every use is written to the audit log.
network:socketsHighOpen its own network connections. It can listen on ports and connect to any address directly, without Termix checking each connection.
credentials:useMediumConnect to your servers. It cannot see your passwords or keys.
network:serveMediumAccept connections. It opens a port on the Termix server.
operations:provideMediumOffer actions. Its actions can be run from Automations, the CLI, the phone app and other places, by people allowed to use them.
hosts:readLowSee your host list. Names and addresses for hosts you can already see.
ui:surfaceLowAdd its own screens. Tabs, panels and settings you can hide later.
files:ownLowStore 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.

ProvidesVersionPermission
sessions.live (rdp, vnc, ard, telnet, rustdesk)1.1.0remote-desktop.sessions
remote-desktop.console1.0.0remote-desktop.sessions
UsesVersionOptional
recordings.writer^1.1.0yes
tunnels.access^1.0.0yes

API​

The plugin's HTTP routes are in the API reference.

Platforms​

Linux, Windows, macOS