Skip to main content
Session Recording
TerminalSourceAPIChangelog

Reference

Settings​

Admin​

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

SettingTypeDefaultWhat it does
Retention (days)number30How long a session recording is kept before it is deleted automatically.
Require recordingselect"off"Record every session even when a host has recording turned off. Users can't stop a required recording.
Encrypt recordingsbooleantrueEncrypt new recordings on disk. Recordings made before stay as they are.
Alert when a recording is openedselect"off"Send an alert to auditors when someone watches, downloads or live watches a session.

User​

Each person sets these for themselves in Settings.

SettingTypeDefaultWhat it does
Always show buttonsbooleanfalseKeep the view, download and delete buttons under each log visible. Turn off to show them only on hover.

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 session recordingbooleanfalseRecord terminal output for this host so you can play it back or download it later.
Timestamps in text downloadsbooleanfalseDownload as text puts the time each line was printed at its start, in UTC. Recordings and playback stay the same.

Permissions​

Give these to roles in Settings, Roles.

PermissionWho has it at firstWhat it allows
session-recording.viewadmin, userSee and play back your own session recordings.
session-recording.auditadminSee and play back everyone's recordings, see who opened each one, put recordings on hold and watch or end live sessions.
session-recording.rulesadminAdd and change the rules that alert on, or end, a session when a command matches.

Actions​

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

ActionRuns onRiskInputs
session-recording.list
Session recordings
A hostRead only
session-recording.usage
Recording storage
A hostRead only
session-recording.verify
Check a recording for changes
One item on a hostRead only

Events​

Automations can start when one of these happens.

EventWhat it means
session-recording.alertA command alert rule matched

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
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.
events:coreMediumWatch everything happening. Including activity from other users, not just yours.
operations:provideMediumOffer actions. Its actions can be run from Automations, the CLI, the phone app and other places, by people allowed to use them.
notify:sendMediumSend alerts. To you or other users, and through the channels they set up.
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.
files:ownLowStore its own files. In its own folder on disk, 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.
kv:ownLowRemember small settings. Kept separate from other plugins.

Services​

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

ProvidesVersionPermission
recordings.writer1.2.0session-recording.view
UsesVersionOptional
sessions.live^1.0.0yes
privileged-access.hosts^1.0.0yes

API​

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

Platforms​

Linux, Windows, macOS