Skip to main content
Tunnels
NetworkingSourceAPIChangelog

Reference

Settings​

Admin​

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

SettingTypeDefaultWhat it does
X server for X11 programsstringWhere windows of programs started from X11 apps show up, like localhost:0. The Termix server connects to it, so this is mostly for the desktop app with VcXsrv, XQuartz or Xwayland on this computer. Leave empty to turn X11 apps off.

User​

Each person sets these for themselves in Settings.

SettingTypeDefaultWhat it does
Open the tunnels panel with a terminalbooleanfalseShow the tunnels panel when a terminal opens on a host that has it.
Tunnels panel sideselect"right"Where the panel sits next to the terminal.
Tunnels panel sizenumber320Width, or height at the bottom, in pixels.
Tunnels panel edge buttonbooleantrueShow a small button on the terminal edge to open the panel.

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
Enable tunnelsbooleanfalseSet up SSH tunnels through this host.
Panel beside the terminalbooleantrueOffer a tunnels panel next to this host's SSH terminal.

Permissions​

Give these to roles in Settings, Roles.

PermissionWho has it at firstWhat it allows
tunnels.useadmin, userStart, stop and watch SSH tunnels, and save client tunnel presets.

Actions​

Run these from Operations Center, Automations, the CLI (termix ops), the phone app or the API. See actions.

ActionRuns onRiskInputs
tunnels.list
List tunnels
The serverRead only
tunnels.down
Tunnels down
The serverRead only
tunnels.connect
Connect a tunnel
The serverChangesname
tunnels.disconnect
Disconnect a tunnel
The serverChangesname

Events​

Automations can start when one of these happens.

EventWhat it means
tunnels.tunnel-downTunnel went down
tunnels.tunnel-upTunnel is back

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
ssh:connectHighRun commands on your servers. Any command, on hosts you connect it to, with your access.
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.
db:core-refsHighRead core account tables. Can query users, roles and hosts directly from the database.
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.
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.
notify:sendMediumSend alerts. To you or other users, and through the channels they set up.
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.
db:ownLowStore its own data. Kept in its own tables, separate from other plugins.
ui:surfaceLowAdd its own screens. Tabs, panels and settings you can hide later.
secrets:ownLowStore its own secrets. Encrypted by Termix. The plugin never holds the key.

Services​

Services are how plugins call each other. Plugin authors can use these.

ProvidesVersionPermission
tunnels.access1.0.0tunnels.use

API​

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

Platforms​

Linux, Windows, macOS