Skip to main content
Docker
InfrastructureSourceAPIChangelog

Reference

Settings​

Admin​

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

SettingTypeDefaultWhat it does
Stack managementbooleanfalseLet 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.

SettingTypeDefaultWhat it does
Open the containers panel with new terminalsbooleanfalseShow 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 sideselect"right"Where the containers panel sits next to a terminal.
Containers panel sizenumber380Width in pixels, or height when it is at the bottom. You can also drag its edge.
Show the panel buttonbooleantrueShow 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.

SettingTypeDefaultWhat it does
Enable DockerbooleanfalseManage containers on this host.
Container Runtimeselect"docker"Choose the CLI used for container management on this host
Show containers panel in terminalsbooleantrueLet the containers panel open beside this host's SSH terminal.
Alert on container problemsbooleanfalseSend an alert when a container becomes unhealthy, keeps restarting or exits with an error.
Stack managementbooleanfalseManage compose stacks on this host. An administrator also has to allow it.
Stacks folderstring"/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.

PermissionWho has it at firstWhat it allows
docker.useadmin, userOpen 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.

ActionRuns onRiskInputs
docker.list-containers
List containers
A hostRead only
docker.summary
Container summary
A hostRead only
docker.start-container
Start container
One item on a hostChanges
docker.stop-container
Stop container
One item on a hostChanges
docker.restart-container
Restart container
One item on a hostChanges
docker.pause-container
Pause container
One item on a hostChanges
docker.unpause-container
Resume container
One item on a hostChanges
docker.remove-container
Remove container
One item on a hostDestructiveforce
docker.pull-image
Pull image
A hostChangesimage
docker.remove-image
Remove image
A hostDestructiveimage, force
docker.prune-images
Remove unused images
A hostDestructiveall
docker.create-volume
Create volume
A hostChangesname
docker.remove-volume
Remove volume
A hostDestructivename
docker.prune-volumes
Remove unused volumes
A hostDestructive
docker.create-network
Create network
A hostChangesname, driver, subnet
docker.remove-network
Remove network
A hostDestructivename
docker.prune-networks
Remove unused networks
A hostDestructive

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
ssh:connectHighRun commands on your servers. Any command, on hosts you connect it to, with your access.
users:impersonateHighAct as other users. Runs background work with another user's access, such as scheduled jobs. Every use is written to the audit log.
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.
ui:surfaceLowAdd its own screens. Tabs, panels and settings you can hide later.
kv:ownLowRemember small settings. Kept separate from other plugins.

Services​

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

ProvidesVersionPermission
docker.containers1.0.0docker.use
docker.events1.0.0docker.use

API​

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

Platforms​

Linux, Windows, macOS