Github wg-easy/README.md at master · WeeJeWel/wg-easy · GitHub
source link: https://github.com/WeeJeWel/wg-easy/blob/master/README.md
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
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, delete, enable & disable clients.
- Show a client's QR code.
- Download a client's configuration file.
- Statistics for which clients are connected.
- Gravatar support.
Installation
1. Install Docker
If you haven't installed Docker yet, install it by running:
$ curl -sSL https://get.docker.com | sh $ sudo sh get-docker.sh $ sudo usermod -aG docker $(whoami) $ bash
2. Configure WireGuard
Run these commands to prepare and configure WireGuard.
$ mkdir ~/.wg-easy $ cd ~/.wg-easy $ wget https://raw.githubusercontent.com/WeeJeWel/wg-easy/master/docker-compose.yml $ vim docker-compose.yml
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 WireGuard
Finally, run WireGuard. It will automatically start after a reboot.
$ docker-compose up --detach
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
.
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.
Recommend
About Joyk
Aggregate valuable and interesting links.
Joyk means Joy of geeK