https://github.com/h44z/wg-portal

WireGuard Configuration Portal with LDAP connection
https://github.com/h44z/wg-portal

ldap ui usermanagement vpn webinterface wireguard

Last synced: 1 day ago
JSON representation

WireGuard Configuration Portal with LDAP connection

• Host: GitHub
• URL: https://github.com/h44z/wg-portal
• Owner: h44z
• License: mit
• Created: 2020-11-05T18:33:12.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2025-04-03T04:46:39.000Z (12 days ago)
• Last Synced: 2025-04-06T08:06:40.759Z (9 days ago)
• Topics: ldap, ui, usermanagement, vpn, webinterface, wireguard
• Language: Go
• Homepage: https://wgportal.org/
• Size: 11.5 MB
• Stars: 1,059
• Watchers: 27
• Forks: 133
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt
  • Security: SECURITY.md

Awesome Lists containing this project

• awesome-wireguard - h44z/wg-portal - Supports LDAP and more (Projects / User Interface)
• awesome-technostructure - h44z/wg-portal - portal: WireGuard Configuration Portal with LDAP connect ([💾 sysadmin-devops](https://github.com/stars/ketsapiwiq/lists/sysadmin-devops))
• awesome-technostructure - h44z/wg-portal - portal: WireGuard Configuration Portal with LDAP connect ([💾 sysadmin-devops](https://github.com/stars/ketsapiwiq/lists/sysadmin-devops))

README

        
# WireGuard Portal (v2 - testing)

[![Build Status](https://github.com/h44z/wg-portal/actions/workflows/docker-publish.yml/badge.svg?event=push)](https://github.com/h44z/wg-portal/actions/workflows/docker-publish.yml)

[![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](https://opensource.org/licenses/MIT)

![GitHub last commit](https://img.shields.io/github/last-commit/h44z/wg-portal/master)

[![Go Report Card](https://goreportcard.com/badge/github.com/h44z/wg-portal)](https://goreportcard.com/report/github.com/h44z/wg-portal)

![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/h44z/wg-portal)

![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/h44z/wg-portal)

[![Docker Pulls](https://img.shields.io/docker/pulls/h44z/wg-portal.svg)](https://hub.docker.com/r/wgportal/wg-portal/)

> [!CAUTION]

> Version 2 is currently under development and may contain bugs and breaking changes.

> It is not advised to use this version in production. Use version [v1](https://github.com/h44z/wg-portal/tree/stable) instead.

> [!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**.

## Introduction

**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 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

![Screenshot](docs/assets/images/screenshot.png)

## 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

* [Gin](https://github.com/gin-gonic/gin), HTTP web framework written in Go

* [Bootstrap](https://getbootstrap.com/), for the HTML templates

* [Vue.js](https://vuejs.org/), for the frontend

## License

* MIT License. [MIT](LICENSE.txt) or