Update README.md

This commit is contained in:
Donald Zou 2020-10-18 02:09:14 -04:00 committed by GitHub
parent 08651bda1e
commit 893784e7b9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -1,6 +1,19 @@
# Wireguard-Dashboard # Wireguard-Dashboard
## Intro ## Intro
Monitoring Wireguard is not convinient, need to login into server and type wg show. That's why this platform is being created, to view all configurations in a more straight forward way. Monitoring Wireguard is not convinient, need to login into server and type wg show. That's why this platform is being created, to view all configurations in a more straight forward way.
## Installation
**Requirement:**
- Wireguard
- Configuration files under **/etc/wireguard**
- Python 3.7
- Flask
**Install:**
1. `git clone https://github.com/donaldzou/Wireguard-Dashboard.git`
2. `cd Wireguard-Dashboard`
3. `python3 dashboard.py`
4. Access your server! e.g (http://your_server_ip:10086)
## Example ## Example
![Index Image](https://github.com/donaldzou/Wireguard-Dashboard/raw/main/static/index.png) ![Index Image](https://github.com/donaldzou/Wireguard-Dashboard/raw/main/static/index.png)
![Conf Image](https://github.com/donaldzou/Wireguard-Dashboard/raw/main/static/configuration.png) ![Conf Image](https://github.com/donaldzou/Wireguard-Dashboard/raw/main/static/configuration.png)