1.8 KiB
1.8 KiB
VPN Router Manager Documentation
The VPN Router Manager shows the state of a router running the vpn-router package and manages
its users, connections, certificates and services. Members of the router's group admins see all
pages; any other user sees only their own account.
The help opens at the topic of the page you are on. Links between topics open in this panel; Back returns to the previous topic and the house icon to this one.
Pages
| Page | Topics |
|---|---|
| Router | Overview, Metrics, Logs, Backup, System |
| Identities | Users, Groups, Service accounts |
| Connectivity | Site-to-site connections |
| Remote Access | IKEv2, OpenVPN and WireGuard |
| Certificates | Certificates |
| Web Sites | Sites, Files, DNS |
| Docker | Docker |
| Header | Shell, Account |
Header
- Page menu (right end): switches between the pages; its button names the page shown.
- Help (question mark, left of the page menu): opens and closes this panel; the page moves left while it is open.
- Shell (terminal icon, administrators): a shell on the router; pressed on the Shell page, it returns to the page it was opened from.
- Your name: opens your account; pressed there, it returns to the page it was opened from.
- Sign out, Settings (gear, but not on the account page) and Theme (light, dark or the system's).
Settings
The gear, hidden on the sign-in and the account page, sets how often the Overview and the Metrics tab read the router on their own: manually, or every 5, 10 or 30 seconds, 1, 5 or 15 minutes. The browser keeps the choice; Defaults sets it back.