jostreff/wireguard-ui
1
0
Fork 0
mirror of https://github.com/ngoduykhanh/wireguard-ui.git synced 2025-04-19 19:59:13 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update readme

Browse source
This commit is contained in:
Khanh Ngo 2022-12-13 22:48:00 +01:00
parent ea55b36a6f
commit 24a0a9f5ee
No known key found for this signature in database
GPG key ID: A5AE8DA0242B0C4C
1 changed files with 8 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -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. These environment variables only apply to the docker container.
| Variable | Description | | Variable | Description | Default |
|-----------------------|----------------------------------------------------------------------------------| |-----------------------|---------------------------------------------------------------|---------|
| `WGUI_MANAGE_START` | Start/stop WireGaurd when the container is started/stopped. (default `false`) | | `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. (default `false`) | | `WGUI_MANAGE_RESTART` | Auto restart WireGuard when we Apply Config changes in the UI | `false` |
## Auto restart WireGuard daemon ## Auto restart WireGuard daemon
@ -151,7 +151,7 @@ systemctl start wgui.{path,service}
### Using openrc ### Using openrc
Create and `chmod +x` /usr/local/bin/wgui Create `/usr/local/bin/wgui` file and make it executable
```sh ```sh
cd /usr/local/bin/ cd /usr/local/bin/
@ -163,7 +163,7 @@ EOF
chmod +x wgui chmod +x wgui
``` ```
Create and `chmod +x` /etc/init.d/wgui Create `/etc/init.d/wgui` file and make it executable
```sh ```sh
cd /etc/init.d/ cd /etc/init.d/
@ -190,7 +190,8 @@ rc-update add wgui default
Set `WGUI_MANAGE_RESTART=true` to manage Wireguard interface restarts. 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 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 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. feature work.
## Build ## Build