Reference
Settings
Admin
Set by an admin in Settings, under the plugin's name. It applies to everyone.
| Setting | Type | Default | What it does |
|---|---|---|---|
| Allow Session Sharing | boolean | true | Allow live terminal, RDP, VNC, and Telnet sessions to be shared instance-wide. Overrides every per-host sharing toggle when disabled. |
| Public URL for guest links | string | The address guests open, when it differs from the one you use, like a public proxy in front of a server on a VPN. Leave empty to use the current address. |
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 |
|---|---|---|---|
| Allow Session Sharing | boolean | true | Let live sessions on this host be shared via link or with other users |
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 |
|---|---|---|
REDIS_URL | Redis that several Termix servers share for meeting rooms, like redis://redis:6379. Not needed with one server. | |
TERMIX_REDIS_PREFIX | termix:collab | Prefix for the keys it writes in Redis. |
Permissions
Give these to roles in Settings, Roles.
| Permission | Who has it at first | What it allows |
|---|---|---|
session-sharing.use | admin, user | Share live sessions by link or with other users, and create and join collaboration rooms. |
Actions
Run these from Operations Center, Automations, the CLI (termix ops), the phone app or the API. See actions.
| Action | Runs on | Risk | Inputs |
|---|---|---|---|
session-sharing.list-sharesList active shares | The server | Read only | |
session-sharing.host-sharesShares of this host | A host | Read only | |
session-sharing.revoke-shareRevoke share | The server | Changes | share |
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 |
|---|---|---|
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. |
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. |
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. |
Works with other plugins
Needs: ssh-terminal ^1.0.0.
Works better with: remote-desktop ^1.0.0.
Services
Services are how plugins call each other. Plugin authors can use these.
| Provides | Version | Permission |
|---|---|---|
sessions.sharing | 1.0.0 | session-sharing.use |
| Uses | Version | Optional |
|---|---|---|
sessions.live | ^1.0.0 | no |
API
The plugin's HTTP routes are in the API reference.
Platforms
Linux, Windows, macOS