• This repository has been archived on 24/May/2021
  • Stars
    star
    105
  • Rank 328,196 (Top 7 %)
  • Language
    HTML
  • Created almost 4 years ago
  • Updated over 3 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

🚀 Web UI for PiVPN

🗑 THIS PROJECT IS DEPRECATED 🗑

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


PiVPN Web

Build & Publish Docker Image to Docker Hub Docker Docker Sponsor

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

More Repositories

1

node-google-backup

A Command-Line Utility to automatically backup Google Mail, Calendar & Contacts to local files.
JavaScript
222
star
2

how-to-be-a-great-programmer

100
star
3

decoravit

Beautiful code beautifier — App for macOS
JavaScript
41
star
4

node-webos

webOS remote for LG TVs
JavaScript
31
star
5

node-fprint-server

HTTP server for libfprint to enroll & identify remotely
JavaScript
21
star
6

node-denon-heos

Denon Heos client for Node.js
JavaScript
11
star
7

nginx-with-certbot

Dockerfile
10
star
8

node-hyperion-client

Hyperion Client for AmbiLight-clone Hyperion, using JSON websocket
JavaScript
9
star
9

com.mi.flora

Adds support for Xiaomi Mi Flora Plant Sensor in Homey.
JavaScript
5
star
10

node-icloud-backup

JavaScript
4
star
11

mi-flora-web

Read Xiaomi Mi Flora (plant sensor) in your browser
HTML
4
star
12

net.weejewel.ftpserver

A multi-user HTTP & FTP server for Homey Pro.
HTML
3
star
13

net.weejewel.fprintclient

Homey client for node-fprint-server
JavaScript
3
star
14

pi-stats

Raspberry Pi Statistics Web UI Dashboard
HTML
3
star
15

node-eetlijst

Eetlijst.nl client written in Node.js
JavaScript
2
star
16

net.weejewel.mqttserver

MQTT Server for Homey pro
HTML
2
star
17

com.zyxel

Homey app for Zyxel routers
JavaScript
1
star
18

com.github

GitHub app for Homey
JavaScript
1
star
19

noble-cli

Command Line utility to scan for Bluetooth Low Energy (BLE) devices
JavaScript
1
star
20

relayctrl

Webserver for Wemos D1 Mini that controls a Relay shield
Arduino
1
star
21

kaal

Module to help Kyle's code run regardless obvious typos
JavaScript
1
star
22

net.weejewel.clocks

Beautiful Clocks for Homey Dashboards.
JavaScript
1
star