Mirrors/wgfrontend
1
0
Fork 0
mirror of https://github.com/towalink/wgfrontend.git synced 2025-12-21 02:06:18 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README and prepare release

Browse Source
This commit is contained in:
Henri
2020-12-05 15:11:19 +01:00
parent 8a66b40750
commit df72644ad1
3 changed files with 33 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@@ -30,6 +30,15 @@ Install using PyPi:
pip3 install wgfrontend
```
Note: In the case you get an error regarding the imaging library needed for generating QR Codes, try to install it via the operating system packages:
```shell
# For Alpine:
apk add py3-pillow
# For Debian:
apt install python3-pil
```
---
## Quickstart
@@ -69,6 +78,15 @@ Here is an example:
# The WireGuard config file to read and write
wg_configfile = /etc/wireguard/wg_rw.conf
# The command to be executed when the WireGuard config has changed
on_change_command = "sudo /etc/init.d/wgfrontend_interface restart"
# The interface to bind to for the web server
socket_host = 0.0.0.0
# The port to bind to for the web server
socket_port = 8080
# The system user to be used for the frontend
user = wgfrontend