mirror of
https://github.com/towalink/wgfrontend.git
synced 2025-04-19 08:55:11 +00:00
Update README and prepare release
This commit is contained in:
parent
8a66b40750
commit
df72644ad1
13
CHANGELOG.md
13
CHANGELOG.md
@ -16,6 +16,19 @@ All notable changes to this project are documented in this file.
|
|||||||
|
|
||||||
- n/a
|
- n/a
|
||||||
|
|
||||||
|
## [0.3.0] - 2020-12-05
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- Execute a user-defined command on config changes
|
||||||
|
- Drop root privileges after binding to listening port
|
||||||
|
- Allow specifying bind interface and listening port in config file
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
|
||||||
|
- Update QR code also on description change
|
||||||
|
- Create QR code image directory (/var/lib/wgfrontend) with correct permissions
|
||||||
|
|
||||||
## [0.2.2] - 2020-12-02
|
## [0.2.2] - 2020-12-02
|
||||||
|
|
||||||
### Fixed
|
### Fixed
|
||||||
|
18
README.md
18
README.md
@ -30,6 +30,15 @@ Install using PyPi:
|
|||||||
pip3 install wgfrontend
|
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
|
## Quickstart
|
||||||
@ -69,6 +78,15 @@ Here is an example:
|
|||||||
# The WireGuard config file to read and write
|
# The WireGuard config file to read and write
|
||||||
wg_configfile = /etc/wireguard/wg_rw.conf
|
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
|
# The system user to be used for the frontend
|
||||||
user = wgfrontend
|
user = wgfrontend
|
||||||
|
|
||||||
|
4
setup.py
4
setup.py
@ -7,7 +7,7 @@ with open('README.md', 'r') as f:
|
|||||||
|
|
||||||
setup_kwargs = {
|
setup_kwargs = {
|
||||||
'name': 'wgfrontend',
|
'name': 'wgfrontend',
|
||||||
'version': '0.2.2',
|
'version': '0.3.0',
|
||||||
'author': 'The Towalink Project',
|
'author': 'The Towalink Project',
|
||||||
'author_email': 'pypi.wgfrontend@towalink.net',
|
'author_email': 'pypi.wgfrontend@towalink.net',
|
||||||
'description': 'web-based user interface for configuring WireGuard for roadwarriors',
|
'description': 'web-based user interface for configuring WireGuard for roadwarriors',
|
||||||
@ -19,7 +19,7 @@ setup_kwargs = {
|
|||||||
'include_package_data': True,
|
'include_package_data': True,
|
||||||
'install_requires': ['cherrypy',
|
'install_requires': ['cherrypy',
|
||||||
'jinja2',
|
'jinja2',
|
||||||
'qrcode',
|
'qrcode[pil]',
|
||||||
'wgconfig'
|
'wgconfig'
|
||||||
],
|
],
|
||||||
'entry_points': '''
|
'entry_points': '''
|
||||||
|
Loading…
x
Reference in New Issue
Block a user