Skip to main content
WireGuard
NetworkingSourceAPIChangelog

Reference

Settings​

User​

Each person sets these for themselves in Settings.

SettingTypeDefaultWhat it does
Open the WireGuard panel with new terminalsbooleanfalseShow the WireGuard panel beside every SSH terminal that has WireGuard on. You can still open and close it from the button on the right edge.
WireGuard panel sideselect"right"Where the WireGuard panel sits next to a terminal.
WireGuard 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 WireGuard 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
WireGuardbooleanfalseShow the WireGuard tab for this host in its menu.
Show WireGuard panel in terminalsbooleantrueLet the WireGuard panel open beside this host's SSH terminal.
Alert when an interface is downbooleantrueSend an alert when an interface that starts at boot is not active. Checked when the WireGuard status is read.

Permissions​

Give these to roles in Settings, Roles.

PermissionWho has it at firstWhat it allows
wireguard.useadmin, userManage WireGuard interfaces and clients on hosts you can edit.

Actions​

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

ActionRuns onRiskInputs
wireguard.list-interfaces
List WireGuard interfaces
A hostRead only
wireguard.down
WireGuard interfaces down
A hostRead only
wireguard.start
Start WireGuard interface
One item on a hostChanges
wireguard.stop
Stop WireGuard interface
One item on a hostDestructive
wireguard.restart
Restart WireGuard interface
One item on a hostChanges

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.
credentials:useMediumConnect to your servers. It cannot see your passwords or keys.
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.
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.

API​

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

Platforms​

Linux, Windows, macOS