1
0
mirror of https://github.com/donaldzou/WGDashboard.git synced 2024-11-22 15:20:09 +01:00
WGDashboard/README.md

50 lines
1.3 KiB
Markdown
Raw Normal View History

2020-10-19 02:20:02 +02:00
# Wireguard Dashboard
2021-03-24 07:07:01 +01:00
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.
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-03 03:12:46 +02:00
- **Wireguard**
2020-10-18 08:09:14 +02:00
- Configuration files under **/etc/wireguard**
- Python 3.7
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
![Index Image](https://github.com/donaldzou/Wireguard-Dashboard/raw/main/src/static/index.png)
2021-04-03 03:14:51 +02:00
![Conf Image](https://github.com/donaldzou/Wireguard-Dashboard/raw/main/src/static/configuration.png)