Skip to main content
Hosts Config
InfrastructureSourceAPIChangelog

Reference

Settings​

Admin​

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

SettingTypeDefaultWhat it does
Alert when the hosts file has problemsbooleantrueSend admins an alert when the hosts file cannot be read or some hosts are not applied.

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.

VariableDefaultWhat it does
TERMIX_HOSTS_CONFIGPath to the hosts file (.yaml, .yml or .json). Unset means the plugin loads nothing and locks no hosts.

Permissions​

Give these to roles in Settings, Roles.

PermissionWho has it at firstWhat it allows
hosts-config.manageadminSee the hosts file status and reload it.

Actions​

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

ActionRuns onRiskInputs
hosts-config.status
Hosts file
The serverRead only
hosts-config.reload
Reload hosts file
The serverChanges

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
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.
config:secretsHighRead secrets the server holds. Environment variables and files on the server, except Termix's own keys.
hosts:writeMediumCreate and change hosts. It can add hosts and edit the ones you already have.
hosts:lockMediumManage hosts as read only. Hosts it manages can't be edited, deleted or reshared by anyone else.
credentials:useMediumConnect to your servers. It cannot see your passwords or keys.
network:serveMediumAccept connections. It opens a port on the Termix server.
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.
db:ownLowStore its own data. Kept in its own tables, separate from other plugins.
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.

API​

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

Platforms​

Linux, Windows, macOS