2021-04-06 04:41:55 +02:00
< h1 align = "center" > Wireguard Dashboard< / h1 >
2021-04-07 18:15:45 +02:00
< p align = "center" >
< img src = "http://ForTheBadge.com/images/badges/made-with-python.svg" >
< / p >
< p align = "center" >
2021-04-07 18:19:23 +02:00
< a href = "https://github.com/donaldzou/wireguard-dashboard/releases/latest" > < img src = "https://img.shields.io/github/v/release/donaldzou/wireguard-dashboard" > < / a >
2021-04-07 18:15:45 +02:00
< / p >
2021-04-06 22:51:37 +02:00
< p align = "center" > Monitoring Wireguard is not convinient, need to login into server and type < code > wg show< / code > . That's why this platform is being created, to view all configurations in a more straight forward way.< / p >
2021-04-03 03:12:46 +02:00
## 💡Features
- Add peers in configuration
- Manage peer names
- Delete peers
- And many more coming up! Welcome to contribute to this project!
## 📝Requirement
2020-10-23 23:51:11 +02:00
- Ubuntu 18.04.1 LTS, other OS might work, but haven't test yet.
2021-04-06 21:03:49 +02:00
- ‼️ Make sure you have **Wireguard** installed.‼️ < a href = "https://www.wireguard.com/install/" > How to install?</ a >
2020-10-18 08:09:14 +02:00
- Configuration files under ** /etc/wireguard**
2021-04-07 21:58:00 +02:00
- 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
```
2020-10-18 08:09:14 +02:00
2021-04-03 03:12:46 +02:00
## 🛠Install
**1. Install Python Dependencies**
```
2021-04-03 03:15:28 +02:00
$ python3 -m pip install flask tinydb
2021-04-03 03:12:46 +02:00
```
**2. Install Wireguard Dashboard**
```
2021-04-03 03:14:51 +02:00
$ git clone https://github.com/donaldzou/Wireguard-Dashboard.git
2021-04-03 03:15:28 +02:00
$ cd Wireguard-Dashboard/src
$ python3 dashboard.py
2021-04-03 03:12:46 +02:00
```
Access your server with port `10086` ! e.g (http://your_server_ip:10086)
**3. Install with Production Mode (Optional)**
```
2021-04-03 03:15:28 +02:00
$ cd Wireguard-Dashboard/src
$ export FLASK_APP=dashboard.py
$ export FLASK_RUN_HOST=0.0.0.0
$ export FLASK_ENV=development
$ export FLASK_DEBUG=0
$ flask run
2021-04-03 03:12:46 +02:00
```
2020-10-18 08:09:14 +02:00
2021-04-03 03:12:46 +02:00
## 🔍Example
2020-10-22 02:30:16 +02:00
2021-04-03 03:14:51 +02:00
2021-04-07 01:51:50 +02:00
2021-04-07 01:52:33 +02:00
## 🙌Contributors
2021-04-07 01:51:50 +02:00
< a href = "https://github.com/donaldzou/wireguard-dashboard/graphs/contributors" >
< img src = "https://contrib.rocks/image?repo=donaldzou/wireguard-dashboard" / >
< / a >
