Skip to main content
Reverse Proxy
NetworkingSourceAPIChangelog

Reference

Settings​

Admin​

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

SettingTypeDefaultWhat it does
HTTP portnumber8081The port this plugin listens on for HTTP. Map your public port 80 to it. Needed for Let's Encrypt.
HTTPS portnumber8444The port this plugin listens on for HTTPS. Map your public port 443 to it.
Listen addressstring"0.0.0.0"Use 0.0.0.0 to accept connections from anywhere, or 127.0.0.1 to keep routes local.
Termix addressstringThe address people use to open Termix, like https://termix.example.com. Needed for routes that ask for Termix login.
Certificate emailstringLet's Encrypt uses it for expiry notices.
Use Let's Encrypt stagingbooleanfalseTest certificates that browsers do not trust. Use while setting up to avoid rate limits.
Custom certificate authoritystringThe ACME directory address of another CA, like a private step-ca. Leave empty to use Let's Encrypt.
Login length in hoursnumber12How long a visitor stays signed in on a protected route.
Web endpoint domainstringA domain with a wildcard DNS record pointing at this proxy, like *.apps.example.com. Web Endpoint's Through Termix mode opens each page on its own temporary name under it. Needs the Termix address above. Add a port after a colon if visitors use one.

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
Allow reverse proxy routesbooleanfalseRoutes for this host are managed in the Reverse Proxy tab. Turn this off to stop them.
Target addressstringWhere routes send traffic. Leave empty to use this host's own address. Set it to reach a container or another machine.
Default login for new web routesselect"none"What new web routes on this host start with.

Permissions​

Give these to roles in Settings, Roles.

PermissionWho has it at firstWhat it allows
reverse-proxy.useadminOpen the Reverse Proxy tab and add routes to hosts you can edit.
reverse-proxy.accessadmin, userSign in to web routes that ask for a Termix login.

Actions​

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

ActionRuns onRiskInputs
reverse-proxy.list-routes
List proxy routes
A hostRead only
reverse-proxy.failing
Proxy routes failing
A hostRead only
reverse-proxy.enable-route
Turn a proxy route on
One item on a hostChanges
reverse-proxy.disable-route
Turn a proxy route off
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
network:socketsHighOpen its own network connections. It can listen on ports and connect to any address directly, without Termix checking each connection.
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:serveMediumAccept connections. It opens a port on the Termix server.
network:outboundMediumReach the internet. It can send requests to outside services.
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.
secrets:ownLowStore its own secrets. Encrypted by Termix. The plugin never holds the key.
kv:ownLowRemember small settings. Kept separate from other plugins.
ui:surfaceLowAdd its own screens. Tabs, panels and settings you can hide later.

Services​

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

ProvidesVersionPermission
reverse-proxy.endpoints1.0.0reverse-proxy.access

API​

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

Platforms​

Linux, Windows, macOS