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.
- Search, filter, sort, and paginate clients.
- Enable, disable, or delete multiple selected clients.
- Show a client's QR code.
- Download or copy a client's configuration, and export QR codes as PNG.
- Rotate client key pairs and add, rotate, or remove preshared keys.
- Statistics for which clients are connected.
- Tx/Rx charts for each connected client.
- Gravatar support.
- Automatic Light / Dark Mode
- Multilanguage Support
- One Time Links
- Client expiration with date and time
- Prometheus and JSON metrics support
- IPv6 support
- CIDR support
- 2FA support
- Per-client firewall filtering (requires iptables)
- OAuth support for Google and GitHub, plus generic OIDC providers such as Authelia and Authentik
- Experimental AmneziaWG support
[!NOTE]
To better manage documentation for this project, it has its own site here: https://wg-easy.github.io/wg-easy/latest
[!NOTE]
If you want to migrate from the old version to the new version, you can find the migration guide here: Migration Guide
Installation
This is a quick start guide to get you up and running with WireGuard Easy.
For a more detailed installation guide, please refer to the Getting Started page.
1. Install Docker
If you haven't installed Docker yet, install it by running as root:
curl -sSL https://get.docker.com | sh
exit
And log in again.
2. Run WireGuard Easy
The easiest way to run WireGuard Easy is with Docker Compose.
Just follow these steps in the detailed documentation.
You can also install WireGuard Easy with the docker run command or via podman.
Now setup a reverse proxy to be able to access the Web UI securely from the internet. This step is optional, just make sure to follow the guide here if you decide not to do it.
Donate
Are you enjoying this project? Consider donating.
Founder: Buy Emile a beer! 🍻
Maintainer: Buy kaaax0815 a coffee! ☕
Development
Prerequisites
- Docker
- Node LTS & corepack enabled
- Visual Studio Code
Dev Server
This starts the development server with docker
pnpm dev
Update Auto Imports
If you add something that should be auto-importable and VSCode complains, run:
cd src
pnpm install
cd ..
Test Cli
This starts the cli with docker
pnpm cli:dev
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
