From 3f19b05d286473b6901556766aaba20eb8c1e554 Mon Sep 17 00:00:00 2001 From: Donald Zou Date: Wed, 7 Apr 2021 17:25:21 -0400 Subject: [PATCH] Update README.md --- README.md | 27 ++++++++++++++++++++++----- 1 file changed, 22 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index efc7c65..87bedd6 100644 --- a/README.md +++ b/README.md @@ -9,25 +9,42 @@

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.

-## 💡Features +## 💡 Features - Add peers in configuration - Manage peer names - Delete peers - And many more coming up! Welcome to contribute to this project! -## 📝Requirement +## 📝 Requirement - Ubuntu 18.04.1 LTS, other OS might work, but haven't test yet. - ‼️ Make sure you have **Wireguard** installed.‼️ How to install? - Configuration files under **/etc/wireguard** + + ***Example `.conf` file*** + ``` + [Interface] + Address = 192.168.0.1/24 + SaveConfig = true + PostUp = iptables -A FORWARD -i wg0 -j ACCEPT; iptables -A FORWARD -o wg0 -j ACCEPT; iptables -t nat -A POSTROUTING -o eth0 -j MASQUERADE + PostDown = iptables -D FORWARD -i wg0 -j ACCEPT; iptables -D FORWARD -o wg0 -j ACCEPT; iptables -t nat -D POSTROUTING -o eth0 -j MASQUERADE + ListenPort = 12345 + PrivateKey = ABCDEFGHIJKLMNOPQRSTUVWXYZ1234 + + [Peer] + PublicKey = HABCDEFGHIJKLMNOPQRSTUVWXYZ123123123123 + AllowedIPs = 192.168.0.2/32 + Endpoint = 8.8.8.8:12345 + + ... + ``` - Python 3.7+ & Pip3 - - To install Python 3 and Pip 3, for example on Debian bases OS (i.e Ubuntu): ``` $ sudo apt-get install python3 python3-pip ``` -## 🛠Install +## 🛠 Install **1. Install Python Dependencies** @@ -45,7 +62,7 @@ $ python3 dashboard.py Access your server with port `10086` ! e.g (http://your_server_ip:10086) -**3. Install with Production Mode (Optional)** +**3. Install with Production Mode (Optional), not tested yet. Proceed with caution.** ``` $ cd Wireguard-Dashboard/src