Reference
Settings
User
Each person sets these for themselves in Settings.
| Setting | Type | Default | What it does |
|---|---|---|---|
| Collapse folders by default | boolean | true | Start each snippet folder collapsed when you open the Snippets panel. |
| Show commands | boolean | true | Show the first line of each snippet's command under its name. |
| Always show buttons | boolean | true | Keep the run, copy and edit buttons under each snippet visible. Turn off to show them only on hover. |
| Confirm before running | boolean | false | Ask before a command snippet runs in a terminal. |
| Fill sudo password | boolean | false | When a snippet runs on a host without a terminal, answer its sudo prompt with the host's sudo password, or its SSH password if none is set. |
| Open the snippets panel with a terminal | boolean | false | Show the snippets panel when a terminal opens on a host that has it. |
| Snippets panel side | select | "right" | Where the panel sits next to the terminal. |
| Snippets panel size | number | 360 | Width, or height at the bottom, in pixels. |
| Snippets panel edge button | boolean | true | Show a small button on the terminal edge to open the panel. |
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 |
|---|---|---|---|
| Panel beside the terminal | boolean | true | Offer a snippets panel next to this host's SSH terminal. |
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 |
|---|---|---|
SNIPPET_EXECUTION_TIMEOUT_SECONDS | Stop a snippet run on hosts after this many seconds. Unset means no limit. |
Permissions
Give these to roles in Settings, Roles.
| Permission | Who has it at first | What it allows |
|---|---|---|
snippets.view | user | See your own snippets, notes and shared snippets. |
snippets.create | user | Create new snippets, notes and folders. |
snippets.edit | user | Rename or change existing snippets and folders. |
snippets.delete | user | Delete snippets and folders. |
snippets.share | user | Share snippets and folders with other users or roles. |
Actions
Run these from Operations Center, Automations, the CLI (termix ops), the phone app or the API. See actions.
| Action | Runs on | Risk | Inputs |
|---|---|---|---|
snippets.listList snippets | The server | Read only | |
snippets.runRun a snippet | A host | Changes | snippet |
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. |
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. |
credentials:use | Medium | Connect to your servers. It cannot see your passwords or keys. |
hosts:write | Medium | Create and change hosts. It can add hosts and edit the ones you already have. |
events:core | Medium | Watch everything happening. Including activity from other users, not just yours. |
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. |
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. |
secrets:own | Low | Store its own secrets. Encrypted by Termix. The plugin never holds the key. |
Services
Services are how plugins call each other. Plugin authors can use these.
| Provides | Version | Permission |
|---|---|---|
snippets.access | 1.0.0 | snippets.view |
API
The plugin's HTTP routes are in the API reference.
Platforms
Linux, Windows, macOS