Reference
Settings
Admin
Set by an admin in Settings, under the plugin's name. It applies to everyone.
| Setting | Type | Default | What it does |
|---|---|---|---|
| Stack management | boolean | false | Let hosts use compose stack management. While this is off, it is hidden and blocked for everyone. |
User
Each person sets these for themselves in Settings.
| Setting | Type | Default | What it does |
|---|---|---|---|
| Open the containers panel with new terminals | boolean | false | Show the containers panel beside every SSH terminal that has Docker on. You can still open and close it from the button on the right edge. |
| Containers panel side | select | "right" | Where the containers panel sits next to a terminal. |
| Containers panel size | number | 380 | Width in pixels, or height when it is at the bottom. You can also drag its edge. |
| Show the panel button | boolean | true | Show a small button on the right edge of a terminal that opens the containers 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 |
|---|---|---|---|
| Enable Docker | boolean | false | Manage containers on this host. |
| Container Runtime | select | "docker" | Choose the CLI used for container management on this host |
| Show containers panel in terminals | boolean | true | Let the containers panel open beside this host's SSH terminal. |
| Alert on container problems | boolean | false | Send an alert when a container becomes unhealthy, keeps restarting or exits with an error. |
| Stack management | boolean | false | Manage compose stacks on this host. An administrator also has to allow it. |
| Stacks folder | string | "/opt/stacks" | The folder on the host where each stack has its own folder with a compose file. |
Permissions
Give these to roles in Settings, Roles.
| Permission | Who has it at first | What it allows |
|---|---|---|
docker.use | admin, user | Open the Docker manager and container consoles on hosts with Docker enabled. |
Actions
Run these from Operations Center, Automations, the CLI (termix ops), the phone app or the API. See actions.
| Action | Runs on | Risk | Inputs |
|---|---|---|---|
docker.list-containersList containers | A host | Read only | |
docker.summaryContainer summary | A host | Read only | |
docker.start-containerStart container | One item on a host | Changes | |
docker.stop-containerStop container | One item on a host | Changes | |
docker.restart-containerRestart container | One item on a host | Changes | |
docker.pause-containerPause container | One item on a host | Changes | |
docker.unpause-containerResume container | One item on a host | Changes | |
docker.remove-containerRemove container | One item on a host | Destructive | force |
docker.pull-imagePull image | A host | Changes | image |
docker.remove-imageRemove image | A host | Destructive | image, force |
docker.prune-imagesRemove unused images | A host | Destructive | all |
docker.create-volumeCreate volume | A host | Changes | name |
docker.remove-volumeRemove volume | A host | Destructive | name |
docker.prune-volumesRemove unused volumes | A host | Destructive | |
docker.create-networkCreate network | A host | Changes | name, driver, subnet |
docker.remove-networkRemove network | A host | Destructive | name |
docker.prune-networksRemove unused networks | A host | Destructive |
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 |
|---|---|---|
ssh:connect | High | Run commands on your servers. Any command, on hosts you connect it to, with your access. |
users:impersonate | High | Act as other users. Runs background work with another user's access, such as scheduled jobs. Every use is written to the audit log. |
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. |
ui:surface | Low | Add its own screens. Tabs, panels and settings you can hide later. |
kv:own | Low | Remember small settings. Kept separate from other plugins. |
Services
Services are how plugins call each other. Plugin authors can use these.
| Provides | Version | Permission |
|---|---|---|
docker.containers | 1.0.0 | docker.use |
docker.events | 1.0.0 | docker.use |
API
The plugin's HTTP routes are in the API reference.
Platforms
Linux, Windows, macOS