From 711c3b78a3236fe780cb67e3e3b903d3f49f05aa Mon Sep 17 00:00:00 2001 From: Christoph Haas Date: Thu, 3 Dec 2020 09:06:02 +0100 Subject: [PATCH] Update readme, see issue #63 --- README.md | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 51c1e85..e079b23 100644 --- a/README.md +++ b/README.md @@ -77,13 +77,16 @@ version: '3.6' cap_add: - NET_ADMIN network_mode: "host" - command: wg-api --device wg0 --listen localhost:8182 + command: wg-api --device wg0 --listen :8182 ``` Please note that mapping ```/etc/wireguard``` to ```/data``` inside the docker, will erase your host's current configuration. If needed, please make sure to backup your files from ```/etc/wireguard```. A workaround would be to change the ```WG_INTERFACE_NAME``` to something different, as it will create a new interface (```wg-auto.conf``` for example), note that if you do so, you will have to adapt your daemon accordingly. +To get the value for **** take a look at the [WireGuard Status Display](#wireguard-status-display) section. If the status display should be disabled, remove the whole service from the docker-compose file or +use 127.0.0.1 as . + ### Directly without docker Fill free to download latest artifacts from my GitLab server: @@ -192,13 +195,21 @@ Wg Gen Web integrates a [WireGuard API implementation](https://github.com/jamesc In order to enable the Status API integration, the following settings need to be configured: ``` # https://github.com/jamescun/wg-api integration, user and password (basic auth) are optional -WG_STATS_API=http://localhost:8182 +WG_STATS_API=http://:8182 WG_STATS_API_USER= WG_STATS_API_PASS= ``` -To setup the WireGuard API take a look at [https://github.com/jamescun/wg-api/blob/master/README.md](https://github.com/jamescun/wg-api/blob/master/README.md). -Please fell free to test and report any bugs. +To setup the WireGuard API take a look at [https://github.com/jamescun/wg-api/blob/master/README.md](https://github.com/jamescun/wg-api/blob/master/README.md), or simply use the provided docker-compose file from above. + +### API_LISTEN_IP +Due to the fact that the wg-api container operates on the host network, the wg-gen-web container cannot directly talk to the API. Thus the docker-host gateway IP of the wg-gen-web container has to be used. If the default bridge network (docker0) is used, this IP should be `172.17.0.1`. If a custom network is used, you can find the gateway IP by inspecting the output of: +``` +docker network inspect +``` +Use the IP address found for **Gateway** as the **API_LISTEN_IP**. + +Please feel free to test and report any bugs. ## Need Help