mirror of
https://github.com/wg-easy/wg-easy.git
synced 2025-10-05 07:37:03 +08:00
improve docs, add version script
This commit is contained in:
5
docs/content/examples/tutorials/adguard.md
Normal file
5
docs/content/examples/tutorials/adguard.md
Normal file
@@ -0,0 +1,5 @@
|
||||
---
|
||||
title: AdGuard Home
|
||||
---
|
||||
|
||||
TODO
|
34
docs/content/examples/tutorials/auto-updates.md
Normal file
34
docs/content/examples/tutorials/auto-updates.md
Normal file
@@ -0,0 +1,34 @@
|
||||
---
|
||||
title: Auto Updates
|
||||
---
|
||||
|
||||
## Docker Compose
|
||||
|
||||
With Docker Compose WireGuard Easy can be updated with a single command:
|
||||
|
||||
Replace `$DIR` with the directory where your `docker-compose.yml` is located.
|
||||
|
||||
```shell
|
||||
cd $DIR
|
||||
sudo docker compose -f up -d --pull always
|
||||
```
|
||||
|
||||
## Docker Run
|
||||
|
||||
```shell
|
||||
sudo docker stop wg-easy
|
||||
sudo docker rm wg-easy
|
||||
sudo docker pull ghcr.io/wg-easy/wg-easy
|
||||
```
|
||||
|
||||
And then run the `docker run -d \ ...` command from [Docker Run][docker-run] again.
|
||||
|
||||
[docker-run]: ./docker-run.md
|
||||
|
||||
## Podman
|
||||
|
||||
To update `wg-easy` (and every container that has auto updates enabled), you can run the following commands:
|
||||
|
||||
```shell
|
||||
sudo podman auto-update
|
||||
```
|
@@ -27,7 +27,7 @@ Follow the Docs here: <https://docs.docker.com/engine/install/> and install Dock
|
||||
2. Download docker compose file
|
||||
|
||||
```shell
|
||||
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
|
||||
```
|
||||
|
||||
3. Start `wg-easy`
|
||||
@@ -54,3 +54,18 @@ TODO
|
||||
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:
|
||||
|
||||
```shell
|
||||
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][auto-updates]
|
||||
|
||||
[auto-updates]: ./auto-updates.md
|
||||
|
5
docs/content/examples/tutorials/caddy.md
Normal file
5
docs/content/examples/tutorials/caddy.md
Normal file
@@ -0,0 +1,5 @@
|
||||
---
|
||||
title: Caddy
|
||||
---
|
||||
|
||||
TODO
|
43
docs/content/examples/tutorials/docker-run.md
Normal file
43
docs/content/examples/tutorials/docker-run.md
Normal file
@@ -0,0 +1,43 @@
|
||||
---
|
||||
title: Docker Run
|
||||
---
|
||||
|
||||
To setup the IPv6 Network, simply run once:
|
||||
|
||||
```bash
|
||||
docker network create \
|
||||
-d bridge --ipv6 \
|
||||
-d default \
|
||||
--subnet 10.42.42.0/24 \
|
||||
--subnet fdcc:ad94:bacf:61a3::/64 wg \
|
||||
```
|
||||
|
||||
<!-- ref: major version -->
|
||||
|
||||
To automatically install & run wg-easy, simply run:
|
||||
|
||||
```bash
|
||||
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`
|
5
docs/content/examples/tutorials/nginx.md
Normal file
5
docs/content/examples/tutorials/nginx.md
Normal file
@@ -0,0 +1,5 @@
|
||||
---
|
||||
title: NGINX
|
||||
---
|
||||
|
||||
TODO
|
@@ -19,16 +19,23 @@ sudo mkdir -p /etc/containers/volumes/wg-easy
|
||||
|
||||
Create a file `/etc/containers/systemd/wg-easy/wg-easy.container` with the following content:
|
||||
|
||||
<!-- ref: major version -->
|
||||
|
||||
```ini
|
||||
[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
|
||||
@@ -90,6 +97,16 @@ In the Admin Panel of your WireGuard server, go to the `Hooks` tab and add the f
|
||||
nft 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
|
||||
|
||||
Restart the container to apply the new hooks:
|
||||
|
||||
```shell
|
||||
sudo systemctl restart wg-easy
|
||||
```
|
||||
|
||||
<!--
|
||||
TODO: improve docs after better nftables support
|
||||
TODO: fix accept web ui port
|
||||
|
5
docs/content/examples/tutorials/traefik.md
Normal file
5
docs/content/examples/tutorials/traefik.md
Normal file
@@ -0,0 +1,5 @@
|
||||
---
|
||||
title: Traefik
|
||||
---
|
||||
|
||||
TODO
|
Reference in New Issue
Block a user