mirror of
https://github.com/donaldzou/WGDashboard.git
synced 2024-09-30 00:20:17 +02:00
52 lines
1.4 KiB
Markdown
52 lines
1.4 KiB
Markdown
<h1 align="center"> Wireguard Dashboard</h1>
|
|
<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>
|
|
|
|
## 💡Features
|
|
|
|
- Add peers in configuration
|
|
- Manage peer names
|
|
- Delete peers
|
|
- And many more coming up! Welcome to contribute to this project!
|
|
|
|
## 📝Requirement
|
|
|
|
- Ubuntu 18.04.1 LTS, other OS might work, but haven't test yet.
|
|
- ‼️ Make sure you have **Wireguard** installed.‼️ <a href="https://www.wireguard.com/install/">How to install?</a>
|
|
- Configuration files under **/etc/wireguard**
|
|
- Python 3.7
|
|
|
|
## 🛠Install
|
|
|
|
|
|
|
|
**1. Install Python Dependencies**
|
|
|
|
```
|
|
$ python3 -m pip install flask tinydb
|
|
```
|
|
|
|
**2. Install Wireguard Dashboard**
|
|
|
|
```
|
|
$ git clone https://github.com/donaldzou/Wireguard-Dashboard.git
|
|
$ cd Wireguard-Dashboard/src
|
|
$ python3 dashboard.py
|
|
```
|
|
|
|
Access your server with port `10086` ! e.g (http://your_server_ip:10086)
|
|
|
|
**3. Install with Production Mode (Optional)**
|
|
|
|
```
|
|
$ 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
|
|
```
|
|
|
|
## 🔍Example
|
|
|
|
|