Server management
Since v2.18.0, System → Servers can provision the servers around your gateway from its release cache. Server management is admin-only, off by default, and requires sign-in. Enable it deliberately in Servers → Settings.
Choose the access mode
Section titled “Choose the access mode”| Mode | What the gateway does |
|---|---|
| Managed over SSH | Uses its own SSH key, pins the server’s host key on first use, and checks it on every connection. |
| Monitor only | Checks the declared roles from outside; no SSH key or remote login. |
| Manual | Produces a script for you to run on the server; you upload its sealed result. The gateway does not log in. |
Create the SSH key in the Gateway key tab. It can live in encrypted storage or outside it. Rotation has an explicit finish step. A sudo password, when needed, is requested for the job and is not stored.
Inventory checks the system, architecture, root/sudo access, ports, firewall, time synchronization and existing services. Take over offers to register services installed by hand: their secrets move into the registry, but they keep running as found until you reinstall them.
An owner marker prevents another gateway—or a newer restored copy of this gateway—from changing the same server without an explicit admin takeover. After restoring a backup, changes remain blocked until the restored servers are checked and Apply is pressed.
Set up a server
Section titled “Set up a server”- Open Set up a server…, choose the server and verify its SSH host key.
- Review inventory results and resolve failed prerequisites.
- Select roles and inspect the plan: it lists changes to both the server and this gateway.
- Choose advanced options where needed: release, certificate lifetime, server-only TLS key, SSH source restrictions, password authentication and journal storage.
- Start the job and follow its steps and live log. The setup step survives a page reload.
- Review the generated artifacts, integration bindings and final checks. You can choose to integrate later.
One installation draft is kept per server. Download plan provides a reviewable copy before execution. The Bridges, Splitting and Nodes pages can open setup with the appropriate role selected.
Supported roles
Section titled “Supported roles”| Role | Managed components and controls |
|---|---|
| DERP relay | Pinned gateway-CA or Let’s Encrypt certificate; node-key admission; relay map, traffic/quota, shared tenants, fallback and certificate rotation. |
| Bridge | Bridge service bound to its Bridges record; phased PSK rotation with consumer tracking and an optional fail-closed mode. |
| Splitting | Reassembler, MASQUE proxy, echo server and obfs4, independently; active component server and optional secondary failover. |
| Gateway node | Full gateway with sign-in, recorded admin credentials and CA; optionally paired as a federation peer. |
The release contains native Linux binaries for amd64 and arm64. obfs4 is a managed component, not an additional binary in the Gateway release’s nine-binary artifact set.
Jobs and maintenance
Section titled “Jobs and maintenance”Jobs are queued with per-server locks. Logs stream with reconnect/resume support. Failed jobs raise an alert; cancel, retry and abandon are explicit actions. Keys, tokens and certificates generated by a job are filed as artifacts and shown only after password re-entry.
Each role offers Update / Reinstall / Roll back, Options…, Restart / Stop / Start, Logs, Check files, Remove and Integrate / Unlink. Updating or reinstalling keeps its secrets. Removal lets you choose whether to retain or purge them. File checks compare against recorded installation hashes and report drift. Incompatible role releases are not offered.
Update roles… runs a batch one job at a time, stopping at the first failure unless explicitly configured to continue. A per-server maintenance window uses HH:MM-HH:MM in the gateway’s local time. Changes and batches wait for the window; Run now starts them immediately.
DERP certificate rotation starts automatically 30 days before expiry, within the server’s maintenance window, and waits for devices to receive the new map before finishing. This certificate automation is separate from release update policy.
From v2.19.0, update, rollback and reconfigure jobs run to completion instead of waiting mid-operation for artifact review. A serving role is bound before the review is requested; the artifacts remain available for review afterward. This does not remove SSH host-key checks or installation-plan review. Uploads tolerate short link drops, and slow uploads are no longer closed by the SSH keepalive.
Release trust
Section titled “Release trust”From v2.19.0, fetching a release from the site includes the server agent and role binaries for managed-server architectures, with each file verified against the signed manifest. Previously cached releases can be topped up. Internet downloads use the gateway’s own tunnel policy and wait without an eligible tunnel unless direct WAN downloads are explicitly allowed; local release mirrors are exempt.
v2.18.1 includes both release-signing public keys. The shared cache authenticates releases signed by them. Automatic updates remain opt-in and require a built-in trusted key. A gateway still running v2.18.0 has no embedded keys and requires manual archive acceptance or an installer upgrade; publishing signed files does not retroactively add keys to that binary. See Updates and release trust before enabling update automation.
Related
Section titled “Related”- Updates and release trust — cache, self-update and rollback behavior.
- Bridge proxies — bridge records and transport choices.
- Traffic splitting — component roles and policy behavior.
- Operations playbook — routine checks and incident handling.