mlius/wg-easy repository overview

⁠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 (default off)
• One Time Links (default off)
• Client Expiry (default off)
• Prometheus metrics support

⁠Requirements

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

⁠Versions

We provide more than 1 docker image tag, the following will help you decide which one suites the best for you.

⁠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

To automatically install & run wg-easy, simply run:

docker run --detach \
  --name wg-easy \
  --env LANG=de \
  --env WG_HOST=<🚨YOUR_SERVER_IP> \
  --env PASSWORD_HASH='<🚨YOUR_ADMIN_PASSWORD_HASH>' \
  --env PORT=51821 \
  --env WG_PORT=51820 \
  --volume ~/.wg-easy:/etc/wireguard \
  --publish 51820:51820/udp \
  --publish 51821:51821/tcp \
  --cap-add NET_ADMIN \
  --cap-add SYS_MODULE \
  --sysctl 'net.ipv4.conf.all.src_valid_mark=1' \
  --sysctl 'net.ipv4.ip_forward=1' \
  --restart unless-stopped \
  ghcr.io/wg-easy/wg-easy

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

The Prometheus metrics will now be available on http://0.0.0.0:51821/metrics. Grafana dashboard 21733⁠

WireGuard Easy can be launched with Docker Compose as well - just download docker-compose.yml⁠, make necessary adjustments and execute docker compose up --detach.

⁠3. Sponsor

Are you enjoying this project? Buy Emile a beer!⁠ 🍻
Donation to core component: WireGuard⁠

⁠Options

These options can be configured by setting environment variables using -e KEY="VALUE" in the docker run command.

⁠Updating

To update to the latest version, simply run:

docker stop wg-easy
docker rm wg-easy
docker pull ghcr.io/wg-easy/wg-easy

And then run the docker run -d \ ... command above again.

With Docker Compose WireGuard Easy can be updated with a single command: docker compose up --detach --pull always (if an image tag is specified in the Compose file and it is not latest, make sure that it is changed to the desired one; by default it is omitted and defaults to latest⁠).
The WireGuared Easy container will be automatically recreated if a newer image was pulled.

⁠Common Use Cases

• Using WireGuard-Easy with Pi-Hole⁠
• Using WireGuard-Easy with nginx/SSL⁠

For less common or specific edge-case scenarios, please refer to the detailed information provided in the Wiki⁠.