PiVPN Web gives you a clean, responsive dashboard for your PiVPN WireGuard installation. Deployed as a single Docker container, it connects to your PiVPN host locally or over SSH and lets you manage every aspect of your VPN — without touching the command line.Documentation Index
Fetch the complete documentation index at: https://mintlify.com/AZhur771/pivpn-web/llms.txt
Use this file to discover all available pages before exploring further.
Quickstart
Deploy PiVPN Web in under five minutes with a single Docker command.
Configuration
All supported environment variables and their defaults explained.
API Reference
Explore the REST API that powers the dashboard.
User Management
Create admin, viewer, and tech user accounts.
What PiVPN Web does
PiVPN Web connects to your PiVPN WireGuard host — either on the same machine or over SSH — and exposes a web interface for day-to-day VPN operations. All state (sessions, users, banned clients) is persisted in a local SQLite database managed by TypeORM.Client Management
Create, delete, enable, and disable WireGuard peers from a single screen.
QR Codes & Configs
Show a scannable QR code or download the
.conf file for any client.Live Status
See which clients are currently connected, their last handshake, and real-time traffic stats.
Traffic Limits
Automatic per-client bandwidth enforcement with daily ban/unban scheduling.
Role-based Access
Separate admin, viewer, and tech accounts with bcrypt-hashed passwords.
SSH Connectivity
Manage a remote PiVPN host securely over SSH — no VPN required.
How it works
Install Docker and PiVPN
PiVPN Web requires Docker on the host machine and a working PiVPN WireGuard installation to manage.
Run the Docker container
Launch PiVPN Web with a single
docker run command, passing your SSH credentials and desired admin account as environment variables.Open the dashboard
Navigate to
http://<host>:3001 in your browser and sign in with the admin credentials you configured.PiVPN Web currently supports WireGuard only. OpenVPN-based PiVPN installations are not supported.