Reference
Settings
Admin
Set by an admin in Settings, under the plugin's name. It applies to everyone.
| Setting | Type | Default | What it does |
|---|---|---|---|
| X server for X11 programs | string | Where 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.
| Setting | Type | Default | What it does |
|---|---|---|---|
| Open the tunnels panel with a terminal | boolean | false | Show the tunnels panel when a terminal opens on a host that has it. |
| Tunnels panel side | select | "right" | Where the panel sits next to the terminal. |
| Tunnels panel size | number | 320 | Width, or height at the bottom, in pixels. |
| Tunnels panel edge button | boolean | true | Show 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.
| Setting | Type | Default | What it does |
|---|---|---|---|
| Enable tunnels | boolean | false | Set up SSH tunnels through this host. |
| Panel beside the terminal | boolean | true | Offer a tunnels panel next to this host's SSH terminal. |
Permissions
Give these to roles in Settings, Roles.
| Permission | Who has it at first | What it allows |
|---|---|---|
tunnels.use | admin, user | Start, 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.
| Action | Runs on | Risk | Inputs |
|---|---|---|---|
tunnels.listList tunnels | The server | Read only | |
tunnels.downTunnels down | The server | Read only | |
tunnels.connectConnect a tunnel | The server | Changes | name |
tunnels.disconnectDisconnect a tunnel | The server | Changes | name |
Events
Automations can start when one of these happens.
| Event | What it means |
|---|---|
tunnels.tunnel-down | Tunnel went down |
tunnels.tunnel-up | Tunnel 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.
| Capability | Risk | What it means |
|---|---|---|
ssh:connect | High | Run commands on your servers. Any command, on hosts you connect it to, with your access. |
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. |
db:core-refs | High | Read core account tables. Can query users, roles and hosts directly from the database. |
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. |
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. |
notify:send | Medium | Send alerts. To you or other users, and through the channels they set up. |
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. |
db:own | Low | Store its own data. Kept in its own tables, separate from other plugins. |
ui:surface | Low | Add its own screens. Tabs, panels and settings you can hide later. |
secrets:own | Low | Store 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.
| Provides | Version | Permission |
|---|---|---|
tunnels.access | 1.0.0 | tunnels.use |
API
The plugin's HTTP routes are in the API reference.
Platforms
Linux, Windows, macOS