From 893784e7b938080c78f4f87a9d7a8ad461ee8738 Mon Sep 17 00:00:00 2001 From: Donald Zou Date: Sun, 18 Oct 2020 02:09:14 -0400 Subject: [PATCH] Update README.md --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 64e4f312..f6019b60 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,19 @@ # Wireguard-Dashboard ## 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. +## 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 ![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)