Skip to main content
Alerts
MonitoringSourceAPIChangelog

Reference

Settings​

Admin​

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

SettingTypeDefaultWhat it does
Termix announcementsbooleantrueShow news from the Termix team, like security notices and releases, in everyone's inbox.
Keep alerts for (days)number90Older alerts are removed from every inbox.
SMTP serverstringNeeded for email channels. Leave empty to turn email off.
SMTP portnumber587Usually 587 with STARTTLS or 465 with TLS.
Use TLS from the startbooleanfalseTurn on for port 465. Leave off for 587, which upgrades to TLS on its own.
SMTP usernamestringLeave empty if the server does not need a login.
SMTP passwordsecretStored encrypted.
From addressstringThe sender alerts come from.

User​

Each person sets these for themselves in Settings.

SettingTypeDefaultWhat it does
Alert popupsselect"warning"Which new alerts pop up while you use Termix. They always land in the inbox.
Always show buttonsbooleanfalseKeep the buttons under each alert, channel and rule visible. Turn off to show them only on hover.

Permissions​

Give these to roles in Settings, Roles.

PermissionWho has it at firstWhat it allows
alerts.useadmin, userGet alerts in the inbox and send them to your own channels.

Actions​

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

ActionRuns onRiskInputs
alerts.unread
Unread alerts
The serverRead only
alerts.send
Send me an alert
The serverChangestitle, body, severity

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
db:core-refsHighRead core account tables. Can query users, roles and hosts directly from the database.
notify:hubHighReceive every alert. Stores and delivers the alerts all plugins send, including their contents.
network:socketsHighOpen its own network connections. It can listen on ports and connect to any address directly, without Termix checking each connection.
events:coreMediumWatch everything happening. Including activity from other users, not just yours.
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.
notify:sendMediumSend alerts. To you or other users, and through the channels they set up.
db:ownLowStore its own data. Kept in its own tables, separate from other plugins.
secrets:ownLowStore its own secrets. Encrypted by Termix. The plugin never holds the key.
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.

API​

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

Platforms​

Linux, Windows, macOS