Skip to main content
Web Servers
InfrastructureSourceAPIChangelog

Reference

Settings​

User​

Each person sets these for themselves in Settings.

SettingTypeDefaultWhat it does
Open the panel with the terminalbooleanfalseShow the Web Servers panel when a terminal opens on a host that has it.
Panel sideselect"right"Where the panel sits next to the terminal.
Panel sizenumber360Width of the panel, or its height at the bottom, in pixels.
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
Web ServersbooleanfalseManage nginx, Apache and Caddy on this host from the Web Servers tab.
Use sudobooleantrueUse sudo to read and change the web server. Turn off if the login is root.
Read onlybooleanfalseShow sites, config and logs but never change them on this host.
Panel beside the terminalbooleantrueOffer the Web Servers panel on this host's terminal tabs.

Permissions​

Give these to roles in Settings, Roles.

PermissionWho has it at firstWhat it allows
web-servers.useadmin, userSee web servers and sites on hosts you can reach, and change them 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
web-servers.status
Web server status
A hostRead only
web-servers.list-sites
List sites
A hostRead only
web-servers.test-config
Test web server config
A hostRead onlyserver
web-servers.reload
Reload web server
A hostChangesserver
web-servers.restart
Restart web server
A hostChangesserver
web-servers.enable-site
Turn site on
One item on a hostChanges
web-servers.disable-site
Turn site off
One item on a hostChanges
web-servers.delete-site
Delete site
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
credentials:readCriticalSee your passwords and keys. It can read the stored secret for any host you can reach.
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.
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