Reference
Settings
Admin
Set by an admin in Settings, under the plugin's name. It applies to everyone.
| Setting | Type | Default | What it does |
|---|---|---|---|
| Terminal Session Persistence | number | 30 | How 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 disconnect | boolean | true | Keep a disconnected terminal alive on the server for the time above, so reopening its tab picks up where it left off. |
| Command History | boolean | true | Allow command history recording. When disabled, history is not saved regardless of per-host settings. |
| Storage Mode | select | Where pasted and uploaded terminal images are written. Auto picks by connection, Local and Remote (SFTP) are fixed. | |
| Local directory | secret | Absolute path on the Termix backend where local mode writes images. Never shown after saving. Empty uses TERMIX_IMAGE_DIR. | |
| Host path | string | The host-side view of the local directory that terminal agents receive. | |
| TTL (ms) | number | How long an uploaded image is kept, in milliseconds. Empty uses TERMIX_IMAGE_TTL_MS or one hour. | |
| Max image count | number | Most images kept at once. Empty uses TERMIX_MAX_IMAGE_COUNT or 100. | |
| Max storage bytes | number | Most bytes of images kept at once. Empty uses TERMIX_MAX_IMAGE_STORAGE_BYTES or 5 GiB. | |
| X server for X11 forwarding | string | Where 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.
| Setting | Type | Default | What it does |
|---|---|---|---|
| Command Autocomplete | boolean | false | Show autocomplete while typing if you press tab |
| rz and sz file transfers | boolean | true | Upload and download files with rz and sz (lrzsz) right in the terminal. |
| Right click in the terminal | select | "copyPaste" | Hold Shift to get the terminal menu instead, or copy and paste if the menu is your choice here |
| Ctrl+V pastes | boolean | true | Turn off to send Ctrl+V to the shell. Ctrl+Shift+V still pastes |
| Copy selected text automatically | boolean | false | Copies text as soon as you select it in the terminal |
| GPU rendering | boolean | true | Draw the terminal with WebGL, which keeps up with heavy output. Turn off if text looks wrong. |
| Inline images | boolean | true | Show pictures that programs print with sixel or the iTerm image format, like chafa or yazi previews. |
| Always show macro buttons | boolean | false | Keep the run and delete buttons under each macro visible. Turn off to show them only on hover. |
| Always show history buttons | boolean | false | Keep 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.
| Setting | Type | Default | What it does |
|---|---|---|---|
| Enable Terminal | boolean | true | Offer an SSH terminal for this host. |
| Command History | boolean | true | Record commands run in this terminal for history and autocomplete |
| X11 forwarding | boolean | false | Show 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.
| Variable | Default | What it does |
|---|---|---|
TERMIX_IMAGE_STORAGE_MODE | Where pasted terminal images go: auto, local or remote. Only used until an admin saves the setting. | |
TERMIX_IMAGE_DIR | DATA_DIR/termix-image-v0 | Folder on the Termix server for local image storage. |
TERMIX_IMAGE_HOST_PATH | /tmp/termix-image-v0 | The same folder as the host sees it, for agents that read images. |
TERMIX_IMAGE_TTL_MS | 3600000 | How long an image is kept, in milliseconds. |
TERMIX_MAX_IMAGE_COUNT | 100 | Most images kept at once. |
TERMIX_MAX_IMAGE_STORAGE_BYTES | 5368709120 | Most bytes of images kept at once. |
Permissions
Give these to roles in Settings, Roles.
| Permission | Who has it at first | What it allows |
|---|---|---|
ssh-terminal.sessions | admin, user | Lets other features, such as session sharing and recording, reach your live terminal sessions. |
ssh-terminal.history | admin, user | Lets other features, such as the AI assistant, read your command history. |
ssh-terminal.monitor | admin | Lets 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.
| Action | Runs on | Risk | Inputs |
|---|---|---|---|
ssh-terminal.check-loginCheck SSH login | A host | Read only | |
ssh-terminal.recent-commandsRecent commands | A host | Read only | |
ssh-terminal.sessionsOpen terminal sessions | A host | Read 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.
| Capability | Risk | What it means |
|---|---|---|
credentials:read | Critical | See your passwords and keys. It can read the stored secret for any host you can reach. |
ssh:connect | High | Run commands on your servers. Any command, on hosts you connect it to, with your access. |
ssh:transport | High | Choose 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: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. |
events:core | Medium | Watch everything happening. Including activity from other users, not just yours. |
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. |
files:own | Low | Store 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.
| Provides | Version | Permission |
|---|---|---|
sessions.live (ssh) | 1.1.0 | ssh-terminal.sessions |
terminal.history | 1.0.0 | ssh-terminal.history |
| Uses | Version | Optional |
|---|---|---|
tmux.sessions | ^1.0.0 | yes |
sessions.sharing | ^1.0.0 | yes |
recordings.writer | ^1.0.0 | yes |
API
The plugin's HTTP routes are in the API reference.
Platforms
Linux, Windows, macOS