🗑 THIS PROJECT IS DEPRECATED 🗑

Please uninstall PiVPN and upgrade to WireGuard Easy. It's much simpler and better! 🎉

PiVPN Web

PiVPN Web is an open-source Web UI for PiVPN (when using WireGuard).

Features

A beautiful & easy to use UI
Easy installation: just one command
List, create, delete, enable & disable users
Show a user's QR code
Download a user's configuration file
See which users are connected
Log in with your Linux username & password
Connects to your local PiVPN installation — or remote over SSH
Gravatar support 😏

Requirements

Docker installed
PiVPN installed (WireGuard, not OpenVPN)
SSH enabled

Installation

1. Install Docker

# Install Docker
curl -fsSL https://get.docker.com -o get-docker.sh
sudo sh get-docker.sh

# Add user 'pi' to group 'docker'
sudo usermod -aG docker pi

2. Install PiVPN

curl -L https://install.pivpn.io | bash

See https://pivpn.io for detailed instructions.

3. Install PiVPN Web

Run this command once to automatically start the service on boot.

docker run -d -p 51821:51821 --name pivpn-web --restart=unless-stopped weejewel/pivpn-web

💡 Remove the restart=always flag to prevent auto-start on boot.

💡 You can set the environment variable SSH_HOST to a hostname/IP to connect to a different PiVPN server than PiVPN Web is running on.

💡 There's also a docker-compose.yml file.

Usage

Open http://<ip-of-your-pi>:51821 and log in with your Raspberry Pi username & password.

💡 The default Raspbian username is pi and the default password is raspberry.

💡 When a client's name is a valid Gravatar e-mail, they will be shown with their avatar.

Supported environment variables

Variable	Default	Comment
PORT	51821	The listening port (number)
SSH_HOST	172.17.0.1	The SSH host to connect to (ip)
SSH_PORT	22	The SSH port to connect to (number)
ENABLE_2FA	no	Enable 2FA login support (yes/no)

Updating

Run these commands to update to the latest version.

docker stop pivpn-web
docker rm pivpn-web
docker pull weejewel/pivpn-web
docker run -d -p 51821:51821 --name pivpn-web --restart=unless-stopped weejewel/pivpn-web

cyrilschreiber3 / pivpn-web