Skip to main content
SSH Terminal
TerminalSourceAPIChangelog

Reference

Settings​

Admin​

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

SettingTypeDefaultWhat it does
Terminal Session Persistencenumber30How long a disconnected terminal is kept alive on the server before it is closed. Min 1, max 1440 minutes. For sessions that must outlive this, enable Auto-Tmux on the host.
Keep sessions after disconnectbooleantrueKeep a disconnected terminal alive on the server for the time above, so reopening its tab picks up where it left off.
Command HistorybooleantrueAllow command history recording. When disabled, history is not saved regardless of per-host settings.
Storage ModeselectWhere pasted and uploaded terminal images are written. Auto picks by connection, Local and Remote (SFTP) are fixed.
Local directorysecretAbsolute path on the Termix backend where local mode writes images. Never shown after saving. Empty uses TERMIX_IMAGE_DIR.
Host pathstringThe host-side view of the local directory that terminal agents receive.
TTL (ms)numberHow long an uploaded image is kept, in milliseconds. Empty uses TERMIX_IMAGE_TTL_MS or one hour.
Max image countnumberMost images kept at once. Empty uses TERMIX_MAX_IMAGE_COUNT or 100.
Max storage bytesnumberMost bytes of images kept at once. Empty uses TERMIX_MAX_IMAGE_STORAGE_BYTES or 5 GiB.
X server for X11 forwardingstringWhere windows from hosts with X11 forwarding show up, like localhost:0. It must be reachable from the Termix server, so this is mostly for the desktop app with VcXsrv, XQuartz or Xwayland on this computer. Leave empty to turn X11 forwarding off.

User​

Each person sets these for themselves in Settings.

SettingTypeDefaultWhat it does
Command AutocompletebooleanfalseShow autocomplete while typing if you press tab
rz and sz file transfersbooleantrueUpload and download files with rz and sz (lrzsz) right in the terminal.
Right click in the terminalselect"copyPaste"Hold Shift to get the terminal menu instead, or copy and paste if the menu is your choice here
Ctrl+V pastesbooleantrueTurn off to send Ctrl+V to the shell. Ctrl+Shift+V still pastes
Copy selected text automaticallybooleanfalseCopies text as soon as you select it in the terminal
GPU renderingbooleantrueDraw the terminal with WebGL, which keeps up with heavy output. Turn off if text looks wrong.
Inline imagesbooleantrueShow pictures that programs print with sixel or the iTerm image format, like chafa or yazi previews.
Always show macro buttonsbooleanfalseKeep the run and delete buttons under each macro visible. Turn off to show them only on hover.
Always show history buttonsbooleanfalseKeep the copy and delete buttons under each command 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 TerminalbooleantrueOffer an SSH terminal for this host.
Command HistorybooleantrueRecord commands run in this terminal for history and autocomplete
X11 forwardingbooleanfalseShow windows of graphical programs you start in the terminal, like xclock or a settings tool. Needs an X server set in Settings, SSH Terminal, and X11Forwarding yes on the host.
Connect from (mobile app)select"auto"Where the mobile app opens SSH for this host: the phone, this server, or the phone when it can reach the host.

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
TERMIX_IMAGE_STORAGE_MODEWhere pasted terminal images go: auto, local or remote. Only used until an admin saves the setting.
TERMIX_IMAGE_DIRDATA_DIR/termix-image-v0Folder on the Termix server for local image storage.
TERMIX_IMAGE_HOST_PATH/tmp/termix-image-v0The same folder as the host sees it, for agents that read images.
TERMIX_IMAGE_TTL_MS3600000How long an image is kept, in milliseconds.
TERMIX_MAX_IMAGE_COUNT100Most images kept at once.
TERMIX_MAX_IMAGE_STORAGE_BYTES5368709120Most bytes of images kept at once.

Permissions​

Give these to roles in Settings, Roles.

PermissionWho has it at firstWhat it allows
ssh-terminal.sessionsadmin, userLets other features, such as session sharing and recording, reach your live terminal sessions.
ssh-terminal.historyadmin, userLets other features, such as the AI assistant, read your command history.
ssh-terminal.monitoradminLets other features, such as Session Recording, list, watch and end the live terminal sessions of every user.

Actions​

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

ActionRuns onRiskInputs
ssh-terminal.check-login
Check SSH login
A hostRead only
ssh-terminal.recent-commands
Recent commands
A hostRead only
ssh-terminal.sessions
Open terminal sessions
A hostRead only

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
credentials:readCriticalSee your passwords and keys. It can read the stored secret for any host you can reach.
ssh:connectHighRun commands on your servers. Any command, on hosts you connect it to, with your access.
ssh:transportHighChoose how hosts are reached. It can carry the SSH connection to a host over its own route, so it sees everything sent to and from those hosts, passwords included.
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.
events:coreMediumWatch everything happening. Including activity from other users, not just yours.
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.
files:ownLowStore its own files. In its own folder on disk, separate from other plugins.

Services​

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

ProvidesVersionPermission
sessions.live (ssh)1.1.0ssh-terminal.sessions
terminal.history1.0.0ssh-terminal.history
UsesVersionOptional
tmux.sessions^1.0.0yes
sessions.sharing^1.0.0yes
recordings.writer^1.0.0yes

API​

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

Platforms​

Linux, Windows, macOS