Skip to main content
Tailscale
NetworkingSourceAPIChangelog

Reference

Settings​

Admin​

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

SettingTypeDefaultWhat it does
Control serverselect"tailscale"Pick Headscale if you run your own Headscale server.
API keysecretUsed to list the devices on your tailnet. Works with a Tailscale or Headscale key.
API base URLstringLeave empty for Tailscale. For Headscale, enter your Headscale address.
Alert when a device goes offlinebooleanfalseSend an alert to admins when a tailnet device that was online drops off. Needs the API key.

Permissions​

Give these to roles in Settings, Roles.

PermissionWho has it at firstWhat it allows
tailscale.devices.viewadmin

Actions​

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

ActionRuns onRiskInputs
tailscale.devices
Tailnet devices
The serverRead only
tailscale.status
Tailscale
A hostRead only
tailscale.up
Connect Tailscale
A hostChanges
tailscale.down
Disconnect Tailscale
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
credentials:readCriticalSee your passwords and keys. It can read the stored secret for any host you can reach.
auth:provideHighHandle sign in. It can add a login method, a second factor or an SSH sign-in type.
ssh:connectHighRun commands on your servers. Any command, on hosts you connect it to, with your access.
network:outboundMediumReach the internet. It can send requests to outside services.
network:serveMediumAccept connections. It opens a port on the Termix server.
credentials:useMediumConnect to your servers. It cannot see your passwords or keys.
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.
ui:surfaceLowAdd its own screens. Tabs, panels and settings you can hide later.

Works with other plugins​

Works better with: host-metrics ^1.0.0.

API​

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

Platforms​

Linux, Windows, macOS