From 41be7747615e2b08c72b4a544cdbe50c3a26e7bd Mon Sep 17 00:00:00 2001 From: Bernd Storath <999999bst@gmail.com> Date: Fri, 23 Aug 2024 08:32:47 +0200 Subject: [PATCH] rename features, fix formatting --- .github/CODEOWNERS | 2 +- README.md | 10 +++++----- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index f27cc17..628ffb8 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1,6 +1,6 @@ # Copyright (c) Emile Nijssen (WeeJeWel) # Founder and Codeowner of WireGuard Easy (wg-easy) -# Maintained by Philip Heiduck (pheiduck) and Bernd Storath (kaaax0815) +# Maintained by Philip Heiduck (pheiduck) and Bernd Storath (kaaax0815) * @WeeJeWel * @pheiduck * @kaaax0815 diff --git a/README.md b/README.md index b72c382..e58f7fc 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,7 @@ 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, edit, delete, enable & disable clients. @@ -23,9 +24,9 @@ You have found the easiest way to install & manage WireGuard on any Linux host! * Gravatar support. * Automatic Light / Dark Mode * Multilanguage Support -* UI_TRAFFIC_STATS (default off) -* WG_ENABLE_ONE_TIME_LINKS (default off) -* WG_ENABLE_EXPIRES_TIME (default off) +* Traffic Stats (default off) +* One Time Links (default off) +* Client Expiry (default off) ## Requirements @@ -109,7 +110,7 @@ These options can be configured by setting environment variables using `-e KEY=" | `WG_HOST` | - | `vpn.myserver.com` | The public hostname of your VPN server. | | `WG_DEVICE` | `eth0` | `ens6f0` | Ethernet device the wireguard traffic should be forwarded through. | | `WG_PORT` | `51820` | `12345` | The public UDP port of your VPN server. WireGuard will listen on that (othwise default) inside the Docker container. | -| `WG_CONFIG_PORT`| `51820` | `12345` | The UDP port used on [Home Assistant Plugin](https://github.com/adriy-be/homeassistant-addons-jdeath/tree/main/wgeasy) +| `WG_CONFIG_PORT`| `51820` | `12345` | The UDP port used on [Home Assistant Plugin](https://github.com/adriy-be/homeassistant-addons-jdeath/tree/main/wgeasy) | `WG_MTU` | `null` | `1420` | The MTU the clients will use. Server uses default WG MTU. | | `WG_PERSISTENT_KEEPALIVE` | `0` | `25` | Value in seconds to keep the "connection" open. If this value is 0, then connections won't be kept alive. | | `WG_DEFAULT_ADDRESS` | `10.8.0.x` | `10.6.0.x` | Clients IP address range. | @@ -127,7 +128,6 @@ These options can be configured by setting environment variables using `-e KEY=" | `MAX_AGE` | `0` | `1440` | The maximum age of Web UI sessions in minutes. `0` means that the session will exist until the browser is closed. | | `UI_ENABLE_SORT_CLIENTS` | `false` | `true` | Enable UI sort clients by name | - > If you change `WG_PORT`, make sure to also change the exposed port. ## Updating