linux-cloud-router/docs/router.md

Overview

The Overview tab shows the state of the router, read every 10 seconds by default (see Settings). The updates of the other packages of the system are on the System tab.

Panels

• Status: the overall status, ok or degraded, on its title bar; the installed version of vpn-router and, when the repository has a newer one, that version; IKEv2, OpenVPN and WireGuard; the status web service and its port; HTTPS and the name it is for, with a chip while the certificates come from Let's Encrypt's staging CA and a settings button (see HTTPS settings below); and Caddy, its HTTPS proxy, with its version, where it comes from (Ubuntu or upstream) and the state of caddy.service.
• Services: the state of each of the router's systemd services and of Caddy; the chip on the title bar tells whether the router's services are active.
• Addresses: links to the status page over HTTPS and over plain HTTP, and to the Router Manager over HTTPS, each opening in a new tab; and the issuer and the discovery URL of the router's OpenID Provider, each with a copy icon, or off while the provider is disabled (see Service accounts).
• Backup: the result of the last run, the next run and Run now (see Backup).
• PostgreSQL: each cluster with its main settings and its databases with their sizes.
• Configuration: the sections of the router's configuration the other pages do not show, among them the status web service (web) and HTTPS (https).

Caddy is switched to upstream's packages on the router as root with vpn-router-caddy use-upstream.

HTTPS settings

The settings button of the HTTPS row switches Let's Encrypt staging CA. While it is on, Caddy takes every certificate, the web sites' included, from Let's Encrypt's staging environment, whose rate limits are far higher but whose certificates no browser trusts: it is for routers that are rebuilt often, for tests only. While it is off, Caddy takes its certificates from Let's Encrypt, and from ZeroSSL when Let's Encrypt refuses, such as for its limit of 5 certificates a week for the same name. Saving runs the router's setup again, which applies the change. The other HTTPS settings are changed on the router with vpn-config-edit.

Updates

• Check update asks the router's package repository for newer versions.
• Upgrade appears when one is found; it installs the new packages after a confirmation and shows the upgrade's output. A reboot is offered when a package asks for one.
• Nothing is read while a check, an upgrade or a reboot runs.

Layout

• A panel folds by its title bar, and every panel but Status hides by its close icon; Panels shows the hidden ones again.
• Edit layout moves panels by dragging and switches each between one column and both.
• The browser keeps the layout.