Sign inSign up

rusian/wg-easy

By rusian

•Updated about 2 months ago

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

Image
Networking
Security
0

2.8K

rusian/wg-easy repository overview

⁠WireGuard Easy

Build & Publish Docker Image to Docker Hub Lint Docker Sponsor GitHub Stars

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 (WIP: available in nightly build)
  • Sessionless HTTP API authentication (WIP: available in nightly build)

⁠Requirements

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

⁠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 -d \
  --name=wg-easy \
  -e WG_HOST=<b>🚨YOUR_SERVER_IP</b> \
  -e PASSWORD=<b>🚨YOUR_ADMIN_PASSWORD</b> \
  -v ~/.wg-easy:/etc/wireguard \
  -p 51820:51820/udp \
  -p 51821:51821/tcp \
  --privileged=true \
  --cap-add=NET_ADMIN \
  --cap-add=SYS_MODULE \
  --sysctl="net.ipv4.conf.all.src_valid_mark=1" \
  --sysctl="net.ipv4.ip_forward=1" \
  --sysctl="net.ipv6.conf.all.forwarding=1" \
  --sysctl="net.ipv6.conf.all.src_valid_mark=1" \
  --restart unless-stopped \
 rusian/wg-easy:latest

💡 Replace YOUR_SERVER_IP with your WAN IP, or a Dynamic DNS hostname.

💡 Replace YOUR_ADMIN_PASSWORD with a password to log in on the Web UI.

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

💡 Your configuration files will be saved in ~/.wg-easy

⁠3. Sponsor

Are you enjoying this project? Buy Emile a beer!⁠ 🍻

⁠Options

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

EnvDefaultExampleDescription
PORT518216789TCP port for Web UI.
WEBUI_HOST0.0.0.0localhostIP address web UI binds to.
PASSWORD-foobar123When set, requires a password when logging in to the Web UI.
WG_HOST-vpn.myserver.comThe public hostname of your VPN server.
WG_DEVICEeth0ens6f0Ethernet device the wireguard traffic should be forwarded through.
WG_PORT5182012345The public UDP port of your VPN server. This will also change the port wireguard will listen to.
WG_INTERFACEwg0wg1The interface wireguard will use in the container. (Only needed if network_mode: host or --net=host is used)
WG_MTUnull1420The MTU the clients will use. Server uses default WG MTU.
WG_PERSISTENT_KEEPALIVE025Value in seconds to keep the "connection" open. If this value is 0, then connections won't be kept alive.
WG_DEFAULT_ADDRESS10.8.0.x10.6.0.xClients IPv4 address range.
WG_DEFAULT_ADDRESS6fd42:42:42::xfd86:ea04:1115::xClients IPv6 address range.
WG_DEFAULT_DNS84.200.69.8084.200.69.80, 84.200.70.40DNS server clients will use.
WG_DEFAULT_DNS62001:1608:10:25::1c04:b12f2001:1608:10:25::1c04:b12f, 2001:1608:10:25::9249:d69bDNSv6 server clients will use.
WG_ALLOWED_IPS0.0.0.0/0, ::/0192.168.15.0/24, 10.0.1.0/24Allowed IPs clients will use.
WG_PRE_UP...-See config.js⁠ for the default value.
WG_POST_UP...iptables ...See config.js⁠ for the default value.
WG_PRE_DOWN...-See config.js⁠ for the default value.
WG_POST_DOWN...iptables ...See config.js⁠ for the default value.

If you change WG_PORT, make sure to also change the exposed port.

⁠Updating

To update to the latest version, simply run:

docker stop wg-easy
docker rm wg-easy
docker pull rusian/wg-easy:latest

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

⁠Common Use Cases

Tag summary

Content type

Image

Digest

sha256:105ee3515…

Size

84.7 MB

Last updated

about 2 months ago

docker pull rusian/wg-easy:development