Bernd Storath 36055157be use eslint module		5 months ago
.github	Feat: Info (#1666)	5 months ago
.vscode	Feat: SQLite (#1619)	6 months ago
assets	refactor: optimize build config, factorize code, enhance SVG icons	1 year ago
docs	WIP: Feat: UI, General Improvements (#1397)	6 months ago
src	use eslint module	5 months ago
.dockerignore	improve docker	6 months ago
.editorconfig	Feat expiration date (#1296)	12 months ago
.gitignore	Chore: Remove multi interface support (#1657)	6 months ago
CHANGELOG.md	Feat: Info (#1666)	5 months ago
Dockerfile	Feat: Info (#1666)	5 months ago
Dockerfile.dev	fixed Dockerfile HEALTHCHECK syntax (#1686)	6 months ago
LICENSE	WIP: Feat: UI, General Improvements (#1397)	6 months ago
README.md	Chore: TODOs (#1695)	5 months ago
contributing.md	contributing.md: remove stackoverflow link	2 years ago
docker-compose.dev.yml	load ipv6 iptables module	6 months ago
docker-compose.yml	load ipv6 iptables module	6 months ago
package.json	update packages	5 months ago
pnpm-lock.yaml	Add Nuxt, ESM, Typescript (#1244)	6 months ago

README.md

WireGuard Easy

You have found the easiest way to install & manage WireGuard on any Linux host!

Features

All-in-one: WireGuard + Web UI.
Easy installation, simple to use.
List, create, edit, delete, enable & disable clients.
Show a client's QR code.
Download a client's configuration file.
Statistics for which clients are connected.
Tx/Rx charts for each connected client.
Gravatar support.
Automatic Light / Dark Mode
Multilanguage Support
Traffic Stats
One Time Links
Client Expiration
Prometheus metrics support
IPv6 support
CIDR support

Requirements

A host with a kernel that supports WireGuard (all modern kernels).
A host with Docker installed.

Versions

💡 We follow semantic versioning (semver)

We offer multiple Docker image tags to suit your needs. The table below is in a particular order, with the first tag being the most recommended:

tag	Branch	Example	Description
`15`	latest minor for that major tag	`ghcr.io/wg-easy/wg-easy:15`	latest features for specific major versions, no breaking changes
`latest`	latest tag	`ghcr.io/wg-easy/wg-easy:latest` or `ghcr.io/wg-easy/wg-easy`	stable as possible get bug fixes quickly when needed, see Releases for more information.
`15.0`	latest patch for that minor tag	`ghcr.io/wg-easy/wg-easy:15.0`	latest patches for specific minor version
`15.0.0`	specific tag	`ghcr.io/wg-easy/wg-easy:15.0.0`	specific release, don't use this as this will not get updated
`nightly`	`master`	`ghcr.io/wg-easy/wg-easy:nightly`	mostly unstable gets frequent package and code updates, deployed against `master`.
`development`	pull requests	`ghcr.io/wg-easy/wg-easy:development`	used for development, testing code from PRs before landing into `master`.

Installation

1. Install Docker

If you haven't installed Docker yet, install it by running:

curl -sSL https://get.docker.com | sh
sudo usermod -aG docker $(whoami)
exit

And log in again.

2. Run WireGuard Easy

The easiest way to run WireGuard Easy is with Docker Compose.

Just download docker-compose.yml, make necessary adjustments and execute docker compose up -d.

The Web UI will now be available on http://0.0.0.0:51821.

Are you enjoying this project? Consider donating.

Founder: Buy Emile a beer! 🍻

Maintainer: Buy kaaax0815 a coffee! ☕

License

This project is licensed under the AGPL-3.0-only License - see the LICENSE file for details

This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with Jason A. Donenfeld, ZX2C4 or Edge Security

"WireGuard" and the "WireGuard" logo are registered trademarks of Jason A. Donenfeld