Skip to main content
Web Endpoint
NetworkingSourceAPIChangelog

Reference

Settings​

Admin​

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

SettingTypeDefaultWhat it does
Allow tunnels on other addressesbooleanfalseLets an endpoint's bind address publish its tunnel on this server's network, with no Termix login in front of it. Leave off: browsers reach tunnels through Termix itself.
Let Termix reach hosts directlybooleanfalseThrough Termix uses an SSH tunnel when a host has SSH. Turn this on for hosts without SSH, like firewalls and iLO, so this server connects to them itself. Anyone who can edit a host can then point it at addresses this server can reach.

User​

Each person sets these for themselves in Settings.

SettingTypeDefaultWhat it does
Open the web UI panel with a terminalbooleanfalseShow the web UI panel when a terminal opens on a host that has it.
Web UI panel sideselect"right"Where the panel sits next to the terminal.
Web UI panel sizenumber520Width, or height at the bottom, in pixels.
Web UI 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
Enable web endpointsbooleanfalseOpen this host's web interfaces from the sidebar.
Endpointsjson
Alert when a web UI is downbooleanfalseSend an alert when a web UI on this host stops answering.
Panel beside the terminalbooleantrueOffer a web UI panel next to this host's SSH terminal.

Permissions​

Give these to roles in Settings, Roles.

PermissionWho has it at firstWhat it allows
web-endpoint.useadmin, userCheck that web pages on hosts you can reach answer.

Actions​

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

ActionRuns onRiskInputs
web-endpoint.check
Check web endpoints
A hostRead only

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.
network:socketsHighOpen its own network connections. It can listen on ports and connect to any address directly, without Termix checking each connection.
credentials:useMediumConnect to your servers. It cannot see your passwords or keys.
network:serveMediumAccept connections. It opens a port on the Termix server.
desktop:windowMediumOpen desktop windows. Only in the Termix desktop app.
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.

Works with other plugins​

Needs: tunnels ^1.0.0.

Services​

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

UsesVersionOptional
tunnels.access^1.0.0no
reverse-proxy.endpoints^1.0.0yes

API​

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

Platforms​

Linux, Windows, macOS