mirror of https://github.com/h44z/wg-portal synced 2025-06-04 03:48:20 +00:00

Go to file

Christoph Haas cd60761ea7 improve docs		2025-05-04 11:16:46 +02:00
.github	prepare for v2 release	2025-05-04 11:00:12 +02:00
.run	V2 alpha - initial version (#172 )	2023-08-04 13:34:18 +02:00
cmd	allow to encrypt keys in db, add browser-only key generator, add hints that private keys are stored on the server (#420 )	2025-05-02 18:48:35 +02:00
deploy/helm	feat(helm): add optional volumeName to persistence configuration #379 (#380 )	2025-02-27 22:58:15 +01:00
docs	improve docs	2025-05-04 11:16:46 +02:00
frontend	generating WG keypair in browser using Web Crypto API (#422 )	2025-05-03 07:58:41 +02:00
internal	docs: add reverse-proxy example, improve docker examples, fix slow_query_threshold documentation; feat: allow config.yml and config.yaml as configuration files	2025-05-03 22:21:56 +02:00
scripts	- fix docker image name	2023-10-26 15:08:11 +02:00
.dockerignore	chore: CI files update (#306 )	2024-09-23 21:54:22 +02:00
.gitignore	docs: add reverse-proxy example, improve docker examples, fix slow_query_threshold documentation; feat: allow config.yml and config.yaml as configuration files	2025-05-03 22:21:56 +02:00
config.yml.sample	add simple webhook feature for peer, interface and user events (#398 )	2025-04-19 21:29:26 +02:00
ct.yaml	Init Helm chart (#255 )	2024-07-04 22:37:30 +02:00
docker-compose.yml	prepare for v2 release	2025-05-04 11:00:12 +02:00
Dockerfile	update documentation for Docker usage (#419 ), include wireguard-tools in Docker image	2025-05-02 10:29:04 +02:00
go.mod	chore: update dependencies	2025-04-19 12:07:09 +02:00
go.sum	chore: update dependencies	2025-04-19 12:07:09 +02:00
LICENSE.txt	V2 alpha - initial version (#172 )	2023-08-04 13:34:18 +02:00
Makefile	Improve admin privilege handling for OAuth. Update documentation.	2025-01-18 11:55:56 +01:00
mkdocs.yml	prepare for v2 release	2025-05-04 11:00:12 +02:00
README.md	prepare for v2 release	2025-05-04 11:00:12 +02:00
SECURITY.md	chore: get rid of static code warnings	2025-02-28 16:11:55 +01:00

README.md

WireGuard Portal v2

Introduction

WireGuard Portal is a simple, web-based configuration portal for WireGuard server management. The portal uses the WireGuard wgctrl library to manage existing VPN interfaces. This allows for the seamless activation or deactivation of new users without disturbing existing VPN connections.

The configuration portal supports using a database (SQLite, MySQL, MsSQL, or Postgres), OAuth or LDAP (Active Directory or OpenLDAP) as a user source for authentication and profile data.

Features

Self-hosted - the whole application is a single binary
Responsive multi-language web UI written in Vue.js
Automatically selects IP from the network pool assigned to the client
QR-Code for convenient mobile client configuration
Sends email to the client with QR-code and client config
Enable / Disable clients seamlessly
Generation of wg-quick configuration file (wgX.conf) if required
User authentication (database, OAuth, or LDAP)
IPv6 ready
Docker ready
Can be used with existing WireGuard setups
Support for multiple WireGuard interfaces
Peer Expiry Feature
Handles route and DNS settings like wg-quick does
Exposes Prometheus metrics for monitoring and alerting
REST API for management and client deployment
Webhook for custom actions on peer, interface, or user updates

Documentation

For the complete documentation visit wgportal.org.

What is out of scope

Automatic generation or application of any iptables or nftables rules.
Support for operating systems other than linux.
Automatic import of private keys of an existing WireGuard setup.

Application stack

wgctrl-go and netlink for interface handling
Bootstrap, for the HTML templates
Vue.js, for the frontend

License

MIT License. MIT or https://opensource.org/licenses/MIT

Important

Since the project was accepted by the Docker-Sponsored Open Source Program, the Docker image location has moved to wgportal/wg-portal. Please update the Docker image from h44z/wg-portal to wgportal/wg-portal.