mirror
/
wg-easy
mirror of https://github.com/wg-easy/wg-easy
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
140 Commits
4 Branches
28 Tags
20 MiB
 
 
 
 
 
Tree: 75d3d24fc2
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '75d3d24fc2'
${ noResults }
Yamzik 75d3d24fc2
Port initial commit 		4 years ago
.github Update issue templates 4 years ago
data/www Port initial commit 4 years ago
src Port initial commit 4 years ago
.dockerignore Port initial commit 4 years ago
.gitignore Port initial commit 4 years ago
Alpine.Wireguard.Dockerfile Port initial commit 4 years ago
Application.Deploy.Dockerfile Port initial commit 4 years ago
Application.Runtime.Dockerfile Port initial commit 4 years ago
Builder.Dockerfile Port initial commit 4 years ago
Builder.Former.dockerfile Port initial commit 4 years ago
Cargo.lock Port initial commit 4 years ago
Cargo.toml Port initial commit 4 years ago
Installer.Dockerfile Port initial commit 4 years ago
LICENSE.md add license 5 years ago
README.md Port initial commit 4 years ago
docker-compose.deploy.yml Port initial commit 4 years ago
docker-compose.installer.yml Port initial commit 4 years ago
docker-compose.yml Port initial commit 4 years ago
image_deploy.sh Port initial commit 4 years ago
image_runtime.sh Port initial commit 4 years ago
install.sh Port initial commit 4 years ago
release.sh Port initial commit 4 years ago

README.md

WireGuard Easy

Build & Publish Docker Image to Docker Hub Lint Docker 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, clients (enable & disable are currently broken).
  • 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.

Requirements

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

Flaws

  • Application state r/w race contitions due to this is stored on the disk with no caching
  • Enabling/disabling clients is currently unavailable due to former flaw

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 compose -f docker-compose.deploy.yml up -d

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

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

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

💡 Your configuration files will be saved in ./data

3. Sponsor

Are you enjoying this project? Buy Weejewel a beer! 🍻

Options

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

Env Default Example Description
PASSWORD - foobar123 When set, requires a password when logging in to the Web UI.
HOST - vpn.myserver.com The public hostname of your VPN server.
WG_PORT 51820 12345 The public UDP port of your VPN server. WireGuard will always listen on 51820 inside the Docker container.
MTU null 1420 The MTU the clients will use. Server uses default WG MTU.
PERSISTENT_KEEPALIVE 0 25 Value in seconds to keep the "connection" open. If this value is 0, then connections won't be kept alive.
DEFAULT_ADDRESS 10.8.0.1 10.6.0.1 Clients IP address range.
DEFAULT_DNS 1.1.1.1 8.8.8.8, 8.8.4.4 DNS server clients will use.
ALLOWED_IPS 0.0.0.0/0, ::/0 192.168.15.0/24, 10.0.1.0/24 Allowed IPs clients will use.
PRE_UP ... - See config.js for the default value.
OST_UP ... iptables ... See config.js for the default value.
PRE_DOWN ... - See config.js for the default value.
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 rs-wg
docker rm rs-wg
docker pull yamzeg/rs-wg

And then run the docker compose -f \ ... command above again.

Common Use Cases