Skip to main content
Firewall
NetworkingSourceAPIChangelog

Reference

Settings​

User​

Each person sets these for themselves in Settings.

SettingTypeDefaultWhat it does
Open the firewall panel with a terminalbooleanfalseShow the firewall panel when a terminal opens on a host that has it.
Firewall panel sideselect"right"Where the panel sits next to the terminal.
Firewall panel sizenumber360Width, or height at the bottom, in pixels.
Firewall 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
FirewallbooleanfalseShow the Firewall tab for this host to manage its firewall over SSH.
Use sudobooleantrueRun firewall commands with passwordless sudo when the login is not root.
Read onlybooleanfalseShow the firewall but block every change from Termix.
SSH lockout checkbooleantrueStop and ask before a change that looks like it would block SSH from Termix.
Undo timernumber60Seconds you get to press Keep after a risky change before the host undoes it.
Timer on every changebooleanfalseUse the undo timer for every change, not only the risky ones.
Firewall panelbooleantrueOffer the firewall panel beside SSH terminals for this host.

Permissions​

Give these to roles in Settings, Roles.

PermissionWho has it at firstWhat it allows
firewall.useadmin, userOpen the Firewall tab on hosts you can reach. Changes also need edit access to the host.

Actions​

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

ActionRuns onRiskInputs
firewall.list-rules
List firewall rules
A hostRead only
firewall.status
Firewall
A hostRead only
firewall.port-allowed
Port is allowed
A hostRead onlyport, protocol, source
firewall.allow-port
Allow a port
A hostChangesport, protocol, source
firewall.remove-port
Remove an allowed port
A hostDestructiveport, protocol, source
firewall.delete-rule
Delete firewall rule
One item on 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.
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.
db:ownLowStore its own data. Kept in its own tables, separate from other plugins.
ui:surfaceLowAdd its own screens. Tabs, panels and settings you can hide later.

Works with other plugins​

Works better with: fleets ^1.0.0.

Services​

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

UsesVersionOptional
fleets.access^1.0.0yes

API​

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

Platforms​

Linux, Windows, macOS