mirror of https://github.com/WeeJeWel/wg-easy.git synced 2024-12-22 17:19:23 +08:00

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

Go to file

Emile Nijssen c50e7dce7a update order		2021-05-23 16:00:29 +02:00
.github/workflows	add linux/arm/v6	2021-05-23 14:32:10 +02:00
.wg-easy	wip	2021-05-23 15:55:50 +02:00
assets	wip	2021-05-22 22:21:09 +02:00
src	wip	2021-05-23 15:27:46 +02:00
.gitignore	wip	2021-05-23 13:36:47 +02:00
docker-compose.yml	update order	2021-05-23 16:00:29 +02:00
Dockerfile	use Node 14	2021-05-23 15:03:17 +02:00
package.json	v1.0.0	2021-05-23 14:47:50 +02:00
README.md	update readme	2021-05-23 15:59:50 +02:00

README.md

WireGuard Easy

Installation

1. Install Docker

Make sure you have Docker installed.

2. Configure

# Create a directory for the configuration files
$ mkdir ~/.wg-easy
$ cd ~/.wg-easy
$ curl https://raw.githubusercontent.com/WeeJeWel/wg-easy/master/docker-compose.yml
$ open docker-compose.yml

Then change WG_HOST=raspberrypi.local to your server's public address, e.g. WG_HOST=vpn.mydomain.com.

Optionally, set a Web UI password by uncommenting PASSWORD=foobar123 and change the password.

3. Run

$ docker compose up

The Web UI will be available on http://0.0.0.0:51821. You can create new clients there.

Options

These options can be configured in docker-compose.yml under environment.

Env	Default	Example	Description
`PASSWORD`	-	`foobar123`	When set, requires a password when logging in to the Web UI.
`WG_HOST`	-	`vpn.myserver.com`	The public hostname of your VPN server
`WG_PORT`	`51820`	`51820`	The public UDP port of your VPN server
`WG_DEFAULT_ADDRESS`	`10.8.0.x`	`10.6.0.x`	Clients IP address range
`WG_DEFAULT_DNS`	`1.1.1.1`	`8.8.8.8, 8.8.4.4`	DNS server clients will use

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