Skip to main content
Session Sharing
ProductivitySourceAPIChangelog

Reference

Settings​

Admin​

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

SettingTypeDefaultWhat it does
Allow Session SharingbooleantrueAllow live terminal, RDP, VNC, and Telnet sessions to be shared instance-wide. Overrides every per-host sharing toggle when disabled.
Public URL for guest linksstringThe 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.

SettingTypeDefaultWhat it does
Allow Session SharingbooleantrueLet 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.

VariableDefaultWhat it does
REDIS_URLRedis that several Termix servers share for meeting rooms, like redis://redis:6379. Not needed with one server.
TERMIX_REDIS_PREFIXtermix:collabPrefix for the keys it writes in Redis.

Permissions​

Give these to roles in Settings, Roles.

PermissionWho has it at firstWhat it allows
session-sharing.useadmin, userShare 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.

ActionRuns onRiskInputs
session-sharing.list-shares
List active shares
The serverRead only
session-sharing.host-shares
Shares of this host
A hostRead only
session-sharing.revoke-share
Revoke share
The serverChangesshare

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
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.
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.
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.

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.

ProvidesVersionPermission
sessions.sharing1.0.0session-sharing.use
UsesVersionOptional
sessions.live^1.0.0no

API​

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

Platforms​

Linux, Windows, macOS