UniqueSoft/wg-portal
2
0
Fork 0
mirror of https://github.com/h44z/wg-portal synced 2025-02-26 05:49:14 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
339 Commits 6 Branches 30 Tags 16 MiB
Go 69.1%
Vue 20.3%
JavaScript 7.2%
Smarty 2.1%
Makefile 0.7%
Other 0.5%
master
Go to file
dependabot[bot] 67f076effe
Some checks failed
Docker / Build and Push (push) Has been cancelled
Details
github-pages / deploy (push) Has been cancelled
Details
Docker / release (push) Has been cancelled
Details
chore(deps): bump github.com/yeqown/go-qrcode/v2 in the patch group (#370) 
Bumps the patch group with 1 update: [github.com/yeqown/go-qrcode/v2](https://github.com/yeqown/go-qrcode).


Updates `github.com/yeqown/go-qrcode/v2` from 2.2.4 to 2.2.5
- [Release notes](https://github.com/yeqown/go-qrcode/releases)
- [Commits](https://github.com/yeqown/go-qrcode/compare/v2.2.4...v2.2.5)

---
updated-dependencies:
- dependency-name: github.com/yeqown/go-qrcode/v2
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-02-17 19:15:27 +01:00
.github Added issue and pull request templates (#355) 2025-01-28 21:43:31 +01:00
.run V2 alpha - initial version (#172) 2023-08-04 13:34:18 +02:00
cmd Remove Swagger Authorize button from published docs (#347) 2025-01-21 12:31:28 +01:00
deploy/helm automatic API access for default admin (#357) 2025-02-07 22:42:48 +01:00
docs api: fix ExpiredAt format (#368) 2025-02-17 08:03:43 +01:00
frontend frontend: fix locked user display (#367) 2025-02-17 08:18:36 +01:00
internal frontend: fix locked user display (#367) 2025-02-17 08:18:36 +01: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 Remove Swagger Authorize button from published docs (#347) 2025-01-21 12:31:28 +01:00
config.yml.sample Improve admin privilege handling for OAuth. Update documentation. 2025-01-18 11:55:56 +01:00
ct.yaml Init Helm chart (#255) 2024-07-04 22:37:30 +02:00
docker-compose.yml Update docker-compose.yml (fixes #308) 2024-11-24 18:53:28 +01:00
Dockerfile chore: update dependencies (#325) 2024-11-27 18:24:23 +01:00
go.mod chore(deps): bump github.com/yeqown/go-qrcode/v2 in the patch group (#370) 2025-02-17 19:15:27 +01:00
go.sum chore(deps): bump github.com/yeqown/go-qrcode/v2 in the patch group (#370) 2025-02-17 19:15:27 +01: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 [chart] Update helm chart (#349) 2025-01-23 13:42:51 +01:00
README.md [docs] big bang update (#348) 2025-01-23 08:06:55 +01:00
SECURITY.md Create SECURITY.md 2025-01-05 13:49:35 +01:00

README.md

WireGuard Portal (v2 - testing)

Build Status License: MIT GitHub last commit Go Report Card GitHub go.mod Go version GitHub code size in bytes Docker Pulls

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 instead.

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.

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 alertingt
  • REST API for management and client deployment

Screenshot

Documentation

For the complete documentation visit wgportal.org.

V2 TODOs

  • Audit UI

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

License