Update README.md
This commit is contained in:
parent
c52670b07a
commit
65b432bc99
28
README.md
28
README.md
|
@ -1,11 +1,11 @@
|
|||
# WireGuard Easy
|
||||
|
||||
[](https://github.com/WeeJeWel/wg-easy/actions/workflows/deploy.yml)
|
||||
[](https://github.com/WeeJeWel/wg-easy/actions/workflows/lint.yml)
|
||||
[](https://hub.docker.com/r/weejewel/wg-easy)
|
||||
[](https://hub.docker.com/r/weejewel/wg-easy)
|
||||
[](https://github.com/sponsors/WeeJeWel)
|
||||

|
||||
[](https://github.com/WeeJeWel/wg-easy/actions/workflows/deploy.yml)
|
||||
[](https://github.com/peterlewis/wg-easy/actions/workflows/lint.yml)
|
||||
[](https://hub.docker.com/r/peterlewis/wg-easy)
|
||||
[](https://hub.docker.com/r/peterlewis/wg-easy)
|
||||
[](https://github.com/sponsors/WeeJeWel)
|
||||

|
||||
|
||||
You have found the easiest way to install & manage WireGuard on any Linux host!
|
||||
|
||||
|
@ -73,7 +73,7 @@ The Web UI will now be available on `http://0.0.0.0:51821`.
|
|||
|
||||
### 3. Sponsor
|
||||
|
||||
Are you enjoying this project? [Buy me a beer!](https://github.com/sponsors/WeeJeWel) 🍻
|
||||
Are you enjoying this project? [Buy WeeJeWel a beer!](https://github.com/sponsors/WeeJeWel) 🍻
|
||||
|
||||
## Options
|
||||
|
||||
|
@ -89,10 +89,10 @@ These options can be configured by setting environment variables using `-e KEY="
|
|||
| `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. |
|
||||
| `WG_ALLOWED_IPS` | `0.0.0.0/0, ::/0` | `192.168.15.0/24, 10.0.1.0/24` | Allowed IPs clients will use. |
|
||||
| `WG_PRE_UP` | `...` | - | See [config.js](https://github.com/WeeJeWel/wg-easy/blob/master/src/config.js#L19) for the default value. |
|
||||
| `WG_POST_UP` | `...` | `iptables ...` | See [config.js](https://github.com/WeeJeWel/wg-easy/blob/master/src/config.js#L20) for the default value. |
|
||||
| `WG_PRE_DOWN` | `...` | - | See [config.js](https://github.com/WeeJeWel/wg-easy/blob/master/src/config.js#L27) for the default value. |
|
||||
| `WG_POST_DOWN` | `...` | `iptables ...` | See [config.js](https://github.com/WeeJeWel/wg-easy/blob/master/src/config.js#L28) for the default value. |
|
||||
| `WG_PRE_UP` | `...` | - | See [config.js](https://github.com/peterlewis/wg-easy/blob/master/src/config.js#L19) for the default value. |
|
||||
| `WG_POST_UP` | `...` | `iptables ...` | See [config.js](https://github.com/peterlewis/wg-easy/blob/master/src/config.js#L20) for the default value. |
|
||||
| `WG_PRE_DOWN` | `...` | - | See [config.js](https://github.com/peterlewis/wg-easy/blob/master/src/config.js#L27) for the default value. |
|
||||
| `WG_POST_DOWN` | `...` | `iptables ...` | See [config.js](https://github.com/peterlewis/wg-easy/blob/master/src/config.js#L28) for the default value. |
|
||||
|
||||
> If you change `WG_PORT`, make sure to also change the exposed port.
|
||||
|
||||
|
@ -103,12 +103,12 @@ To update to the latest version, simply run:
|
|||
```bash
|
||||
docker stop wg-easy
|
||||
docker rm wg-easy
|
||||
docker pull weejewel/wg-easy
|
||||
docker pull peterlewis/wg-easy
|
||||
```
|
||||
|
||||
And then run the `docker run -d \ ...` command above again.
|
||||
|
||||
## Common Use Cases
|
||||
|
||||
* [Using WireGuard-Easy with Pi-Hole](https://github.com/WeeJeWel/wg-easy/wiki/Using-WireGuard-Easy-with-Pi-Hole)
|
||||
* [Using WireGuard-Easy with nginx/SSL](https://github.com/WeeJeWel/wg-easy/wiki/Using-WireGuard-Easy-with-nginx-SSL)
|
||||
* [Using WireGuard-Easy with Pi-Hole](https://github.com/peterlewis/wg-easy/wiki/Using-WireGuard-Easy-with-Pi-Hole)
|
||||
* [Using WireGuard-Easy with nginx/SSL](https://github.com/peterlewis/wg-easy/wiki/Using-WireGuard-Easy-with-nginx-SSL)
|
||||
|
|
Loading…
Reference in New Issue