Basic Installation
Requirements
- You need to have a host that you can manage
- You need to have a domain name or a public IP address
- You need a supported architecture (x86_64, arm64)
- You need curl installed on your host
Install Docker
Follow the Docs here: https://docs.docker.com/engine/install/ and install Docker on your host.
Install wg-easy
- Create a directory for the configuration files (you can choose any directory you like):
DIR=/docker/wg-easy
sudo mkdir -p $DIR
- Download docker compose file
sudo curl -o $DIR/docker-compose.yml https://raw.githubusercontent.com/wg-easy/wg-easy/master/docker-compose.yml
- Start
wg-easy
sudo docker-compose -f $DIR/docker-compose.yml up -d
Setup Firewall
If you are using a firewall, you need to open the following ports:
- UDP 51820 (WireGuard)
- TCP 51821 (Web UI)
These ports can be changed, so if you change them you have to update your firewall rules accordingly.
Setup Reverse Proxy
TODO
Access the Web UI
Open your browser and navigate to https://<your-domain>:51821
or https://<your-ip>:51821
.
Follow the instructions to set up your WireGuard VPN.
Update wg-easy
To update wg-easy
to the latest version, run:
sudo docker-compose -f $DIR/docker-compose.yml pull
sudo docker-compose -f $DIR/docker-compose.yml up -d
Auto Update
If you want to enable auto-updates, follow the instructions here: Auto Updates