# wg-easy/wg-easy

The easiest way to run WireGuard VPN + Web-based Admin UI.

Repository: https://github.com/wg-easy/wg-easy
Canonical: https://ross.abutalabs.com/products/wg-easy
Homepage: https://wg-easy.github.io/wg-easy/latest/
Language: TypeScript
License: AGPL-3.0
License Family: copyleft
Last push: 2026-08-25T14:00:56+00:00

## Health v2 (maintenance only)
Score: 99/100 (v2, computed 2026-09-02T17:46:02.011165+00:00)
- activity 99, release rhythm 98, longevity 100
- inputs: {"age_days": 1929, "days_push": 8, "days_rel": 19, "gap_med": 27, "n_releases_24m": 10}
- flags: none
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 26771, forks 2559 (observed 2026-08-28T04:11:47.116617+00:00)

## What it is
wg-easy is an all-in-one Docker application that runs a WireGuard VPN server together with a web-based admin UI for managing it. It lets administrators create, edit, enable, and monitor VPN clients, view QR codes and config downloads, and track connection statistics.

## Use cases
- set up a WireGuard VPN server with a web admin panel
- manage VPN clients and generate QR codes for devices
- monitor which VPN clients are connected with traffic stats
- self-host a personal or small-business VPN on a Linux host
- manage VPN access with expiration and one-time links
- add 2FA or OIDC login to VPN administration

## When to choose
- you want the simplest Docker-based WireGuard setup with a UI
- you need client management, QR codes, and connection statistics out of the box
- you want features like client expiration, one-time links, and Prometheus metrics
- you prefer a self-hosted VPN admin panel with OIDC/2FA support

## When to avoid
- you need a VPN solution other than WireGuard
- you prefer managing WireGuard purely via config files without a web UI
- you cannot run Docker or a Linux host
- you need multi-node or clustered VPN management at scale

## Facets
- artifact type: application
- maturity: active
- function: vpn, web-framework, monitoring, auth, security, self-hosted, gui
- domain: networking, security, privacy, self-hosted, developer-tools
- platform: self-hosted
- tags: wireguard, vpn-management, web-ui, docker, network-administration, qr-code, prometheus-metrics, linux, web-server

## Member repositories
- wg-easy/wg-easy (main) score 99

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:11:47.116617+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-29T16:55:49.961366+00:00, confidence not recorded.
  - readme: https://github.com/wg-easy/wg-easy (fetched 2026-08-28T04:11:47.116617+00:00, sha 0c7b593cca11)
  - homepage: https://wg-easy.github.io/wg-easy/latest/ (fetched 2026-08-29T07:52:19.425121+00:00, sha 0032b00266b1)
- Data as of 2026-08-30T08:39:29.467469+00:00.
