Skip to main content
Automations
InfrastructureSourceAPIChangelog

Reference

Settings​

User​

Each person sets these for themselves in Settings.

SettingTypeDefaultWhat it does
Always show buttonsbooleanfalseKeep the test, run and delete buttons under each automation visible. Turn off to show them only on hover.
Open the automations panel with a terminalbooleanfalseShow the automations panel when a terminal opens on a host that has it.
Automations panel sideselect"right"Where the panel sits next to the terminal.
Automations panel sizenumber320Width, or height at the bottom, in pixels.
Automations panel edge buttonbooleantrueShow 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.

SettingTypeDefaultWhat it does
Enable maintenancebooleanfalseShow maintenance mode for this host.
Panel beside the terminalbooleantrueOffer a automations panel next to this host's SSH terminal.

Permissions​

Give these to roles in Settings, Roles.

PermissionWho has it at firstWhat it allows
automations.viewuserSee the automations and their history.
automations.createuserAdd new automations.
automations.edituserChange existing automations.
automations.deleteuserRemove automations.
automations.runuserTrigger an automation by hand.

Actions​

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

ActionRuns onRiskInputs
automations.list
List automations
The serverRead only
automations.run
Run an automation
The serverChangesautomation
automations.failed-runs
Failed automation runs
The serverRead 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.
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.
operations:invokeHighRun other plugins' actions. Acts for the signed-in user on the actions its manifest lists. Approval rules still apply.
credentials:useMediumConnect to your servers. It cannot see your passwords or keys.
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.
network:outboundMediumReach the internet. It can send requests to outside services.
network:serveMediumAccept connections. It opens a port on the Termix server.
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.
settings:read-coreLowRead Termix settings. Server settings, not your hosts or credentials.
ui:surfaceLowAdd its own screens. Tabs, panels and settings you can hide later.

Works with other plugins​

Needs: snippets ^1.0.0.

Works better with: fleets ^1.0.0, tunnels ^1.0.0, docker ^1.0.0, host-metrics ^1.0.0, wake-on-lan ^1.0.0.

Services​

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

ProvidesVersionPermission
automations.access1.0.0automations.view
UsesVersionOptional
snippets.access^1.0.0no
fleets.access^1.0.0yes
tunnels.access^1.0.0yes
docker.containers^1.0.0yes
docker.events^1.0.0yes
host-metrics.viewers^1.0.0yes
wake-on-lan.send^1.0.0yes
ai.tasks^1.0.0yes

API​

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

Platforms​

Linux, Windows, macOS