Improve documentation

This commit is contained in:
Henri 2020-11-27 21:02:05 +01:00
parent 16ce040ab9
commit 3220c1b548
6 changed files with 33 additions and 2 deletions

View File

@ -47,8 +47,15 @@ Note that the changes done by wgfrontend in the WireGuard configuration file do
---
## Details
## Screenshots
![screenshot: show a client config](https://raw.githubusercontent.com/towalink/wgfrontend/main/screenshots/show.png "Show a client config")
See additional screenshots in the "screenshots" folder.
---
## Details
### The wgfrontend configuration file
@ -100,7 +107,7 @@ Clone this repo to your local machine using `https://github.com/towalink/wgfront
Install the module temporarily to make it available in your Python installation:
```shell
pip3 install -e <path to root of "src" directory>
pip3 install -e <path to directory with setup.py>
```
---

BIN
screenshots/add.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

BIN
screenshots/edit.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

BIN
screenshots/list.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

BIN
screenshots/show.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 23 KiB

View File

@ -1,6 +1,30 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
"""wgfrontend.py: web-based user interface for configuring WireGuard for roadwarriors."""
"""
The Towalink Project
Copyright (C) 2020 Dirk Henrici
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
"""
__author__ = "Dirk Henrici"
__license__ = "AGPL3" # + author has right to release in parallel under different licenses
__email__ = "towalink.wgfrontend@henrici.name"
import setupenv
import webapp