TODO
+| Env | +Default | +Example | +Description | +
|---|---|---|---|
PORT |
+51821 |
+6789 |
+TCP port for Web UI. | +
HOST |
+0.0.0.0 |
+localhost |
+IP address web UI binds to. | +
INSECURE |
+false |
+true |
+If access over http is allowed | +
sudo curl -o $URL/docker-compose.yml https://raw.githubusercontent.com/wg-easy/wg-easy/master/docker-compose.yml
+sudo curl -o $DIR/docker-compose.yml https://raw.githubusercontent.com/wg-easy/wg-easy/master/docker-compose.yml
- Start
wg-easy
@@ -1117,6 +1378,13 @@ sudo mkdir -p 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
diff --git a/Pre-release/examples/tutorials/caddy/index.html b/Pre-release/examples/tutorials/caddy/index.html
new file mode 100644
index 00000000..33753834
--- /dev/null
+++ b/Pre-release/examples/tutorials/caddy/index.html
@@ -0,0 +1,1223 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Caddy - wg-easy
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/Pre-release/examples/tutorials/docker-run/index.html b/Pre-release/examples/tutorials/docker-run/index.html
new file mode 100644
index 00000000..5111500d
--- /dev/null
+++ b/Pre-release/examples/tutorials/docker-run/index.html
@@ -0,0 +1,1256 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Docker Run - wg-easy
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Docker Run
+
+To setup the IPv6 Network, simply run once:
+ docker network create \
+ -d bridge --ipv6 \
+ -d default \
+ --subnet 10.42.42.0/24 \
+ --subnet fdcc:ad94:bacf:61a3::/64 wg \
+
+
+
+To automatically install & run wg-easy, simply run:
+ docker run -d \
+ --net wg \
+ -e INSECURE=true \
+ --name wg-easy \
+ --ip6 fdcc:ad94:bacf:61a3::2a \
+ --ip 10.42.42.42 \
+ -v ~/.wg-easy:/etc/wireguard \
+ -v /lib/modules:/lib/modules:ro \
+ -p 51820:51820/udp \
+ -p 51821:51821/tcp \
+ --cap-add NET_ADMIN \
+ --cap-add SYS_MODULE \
+ --sysctl net.ipv4.ip_forward=1 \
+ --sysctl net.ipv4.conf.all.src_valid_mark=1 \
+ --sysctl net.ipv6.conf.all.disable_ipv6=0 \
+ --sysctl net.ipv6.conf.all.forwarding=1 \
+ --sysctl net.ipv6.conf.default.forwarding=1 \
+ --restart unless-stopped \
+ ghcr.io/wg-easy/wg-easy:15
+
+The Web UI will now be available on http://0.0.0.0:51821.
+
+💡 Your configuration files will be saved in ~/.wg-easy
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/Pre-release/examples/tutorials/dockerless/index.html b/Pre-release/examples/tutorials/dockerless/index.html
index 040d7de4..a0b1fec3 100644
--- a/Pre-release/examples/tutorials/dockerless/index.html
+++ b/Pre-release/examples/tutorials/dockerless/index.html
@@ -15,10 +15,10 @@
-
+
-
+
@@ -299,7 +299,7 @@
-
-
+
Examples
@@ -559,7 +559,7 @@
- Migrate
+ Metrics
@@ -569,6 +569,77 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ -
+
+
+
+
+
+
+
+
+
+
+
diff --git a/Pre-release/examples/tutorials/nginx/index.html b/Pre-release/examples/tutorials/nginx/index.html
new file mode 100644
index 00000000..31d5e2f6
--- /dev/null
+++ b/Pre-release/examples/tutorials/nginx/index.html
@@ -0,0 +1,1223 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
NGINX - wg-easy
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/Pre-release/examples/tutorials/podman/index.html b/Pre-release/examples/tutorials/podman/index.html
index 6d92a9f5..a228b691 100644
--- a/Pre-release/examples/tutorials/podman/index.html
+++ b/Pre-release/examples/tutorials/podman/index.html
@@ -15,9 +15,11 @@
-
+
+
+
@@ -302,7 +304,7 @@
-
-
+
Examples
@@ -562,7 +564,7 @@
- Migrate
+ Metrics
@@ -572,6 +574,77 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+ -
+
+
+ Restart the Container
+
+
+
@@ -939,6 +1153,28 @@
+
+
+
+
+
+
+ -
+
+
+
+
+ Traefik
+
+
+
+
+
+
+
+
+
+
@@ -1021,6 +1257,15 @@
+
+
+ -
+
+
+ Restart the Container
+
+
+
@@ -1068,15 +1313,22 @@
sudo mkdir -p /etc/containers/volumes/wg-easy
Create a file /etc/containers/systemd/wg-easy/wg-easy.container with the following content:
[Container]
ContainerName=wg-easy
-Image=ghcr.io/wg-easy/wg-easy:latest
+Image=ghcr.io/wg-easy/wg-easy:15
+AutoUpdate=registry
Volume=/etc/containers/volumes/wg-easy:/etc/wireguard:Z
Network=wg-easy.network
PublishPort=51820:51820/udp
PublishPort=51821:51821/tcp
+# this is used to allow access over HTTP
+# remove this when using a reverse proxy
+Environment=INSECURE=true
+
AddCapability=NET_ADMIN
AddCapability=SYS_MODULE
AddCapability=NET_RAW
@@ -1120,6 +1372,11 @@ sudo systemctl startnft delete table inet wg_table
If you don't have iptables loaded on your server, you could see many errors in the logs or in the UI. You can ignore them.
+Restart the container to apply the new hooks:
+sudo systemctl restart wg-easy
+