From 24a0a9f5ee61e49739348c7a6d671860c051e801 Mon Sep 17 00:00:00 2001 From: Khanh Ngo Date: Tue, 13 Dec 2022 22:48:00 +0100 Subject: [PATCH] Update readme --- README.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 1f9fbe8..2dad719 100644 --- a/README.md +++ b/README.md @@ -96,10 +96,10 @@ These environment variables are used to set the defaults used in `New Client` di These environment variables only apply to the docker container. -| Variable | Description | -|-----------------------|----------------------------------------------------------------------------------| -| `WGUI_MANAGE_START` | Start/stop WireGaurd when the container is started/stopped. (default `false`) | -| `WGUI_MANAGE_RESTART` | Auto restart WireGuard when we Apply Config changes in the UI. (default `false`) | +| Variable | Description | Default | +|-----------------------|---------------------------------------------------------------|---------| +| `WGUI_MANAGE_START` | Start/stop WireGaurd when the container is started/stopped | `false` | +| `WGUI_MANAGE_RESTART` | Auto restart WireGuard when we Apply Config changes in the UI | `false` | ## Auto restart WireGuard daemon @@ -151,7 +151,7 @@ systemctl start wgui.{path,service} ### Using openrc -Create and `chmod +x` /usr/local/bin/wgui +Create `/usr/local/bin/wgui` file and make it executable ```sh cd /usr/local/bin/ @@ -163,7 +163,7 @@ EOF chmod +x wgui ``` -Create and `chmod +x` /etc/init.d/wgui +Create `/etc/init.d/wgui` file and make it executable ```sh cd /etc/init.d/ @@ -190,7 +190,8 @@ rc-update add wgui default Set `WGUI_MANAGE_RESTART=true` to manage Wireguard interface restarts. Using `WGUI_MANAGE_START=true` can also replace the function of `wg-quick@wg0` service, to start Wireguard at boot, by running the container with `restart: unless-stopped`. These settings can also pick up changes to Wireguard Config File -Path, after restarting the container. Please make sure you have `--cap-add=NET_ADMIN` in your container config to make this +Path, after restarting the container. Please make sure you have `--cap-add=NET_ADMIN` in your container config to make +this feature work. ## Build