mirror of
https://github.com/h44z/wg-portal.git
synced 2025-10-04 23:46:18 +00:00
9e6ad98c4e
* add dark/light image to doc * add dark/light image to doc * add funding info, prepare release v2.1
80 lines
3.8 KiB
Markdown
80 lines
3.8 KiB
Markdown
# WireGuard Portal v2
|
||
|
||
[](https://github.com/h44z/wg-portal/actions/workflows/docker-publish.yml)
|
||
[](https://opensource.org/licenses/MIT)
|
||
|
||
[](https://goreportcard.com/report/github.com/h44z/wg-portal)
|
||
|
||
|
||
[](https://hub.docker.com/r/wgportal/wg-portal/)
|
||
|
||
## Introduction
|
||
<!-- Text from this line # is included in docs/documentation/overview.md -->
|
||
**WireGuard Portal** is a simple, web-based configuration portal for [WireGuard](https://wireguard.com) server management.
|
||
The portal uses the WireGuard [wgctrl](https://github.com/WireGuard/wgctrl-go) 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 with dark-mode 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), Passkey support
|
||
* IPv6 ready
|
||
* Docker ready
|
||
* Can be used with existing WireGuard setups
|
||
* Support for multiple WireGuard interfaces
|
||
* Supports multiple WireGuard backends (wgctrl or MikroTik)
|
||
* 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
|
||
|
||
<!-- Text to this line # is included in docs/documentation/overview.md -->
|
||
|
||
|
||
## Documentation
|
||
|
||
For the complete documentation visit [wgportal.org](https://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](https://github.com/WireGuard/wgctrl-go) and [netlink](https://github.com/vishvananda/netlink) for interface handling
|
||
* [Bootstrap](https://getbootstrap.com/), for the HTML templates
|
||
* [Vue.js](https://vuejs.org/), for the frontend
|
||
|
||
## License
|
||
|
||
* MIT License. [MIT](LICENSE.txt) or <https://opensource.org/licenses/MIT>
|
||
|
||
## Contributors and Sponsors
|
||
|
||
Thanks so much for all your contributions! They’re truly appreciated and help keep WireGuard Portal moving ahead.
|
||
|
||
<a href="https://github.com/h44z/wg-portal/graphs/contributors">
|
||
<img src="https://contrib.rocks/image?repo=h44z/wg-portal" />
|
||
</a>
|
||
|
||
Want to support the project? You can buy me a coffee or join as a contributor - every bit of support helps!
|
||
[Become a sponsor!](https://github.com/sponsors/h44z)
|
||
|
||
|
||
> [!IMPORTANT]
|
||
> Since the project was accepted by the Docker-Sponsored Open Source Program, the Docker image location has moved to [wgportal/wg-portal](https://hub.docker.com/r/wgportal/wg-portal).
|
||
> Please update the Docker image from **h44z/wg-portal** to **wgportal/wg-portal**.
|