mirror of https://github.com/donaldzou/WGDashboard.git synced 2024-11-04 15:00:23 +01:00

Simplest dashboard for WireGuard VPN written in Python w/ Flask

css dashboard flask-application html5 linux python python3 vpn wireguard wireguard-dashboard wireguard-vpn

Go to file

Donald Cheng Hong Zou 34cd3aaaca Slow Performance Fixed		2021-12-23 21:26:24 -05:00
.github	Create FUNDING.yml	2021-09-04 17:16:31 -04:00
img	v2.2 beta 4	2021-08-14 17:13:16 -04:00
src	Slow Performance Fixed	2021-12-23 21:26:24 -05:00
.all-contributorsrc	docs: update .all-contributorsrc [skip ci]	2021-12-21 18:53:40 +00:00
.gitignore	Update .gitignore	2021-12-19 18:16:45 -05:00
LICENSE	Initial commit	2020-10-18 01:08:59 -04:00
README.md	docs: update README.md [skip ci]	2021-12-21 18:53:39 +00:00

README.md

Hi! I'm planning the next major update for this project, please let me know if you have any suggestions or feature requests ;) You can create an issue with the "Feature request" template. Cheers!

Help Wanted

If anyone know a better way to distribute releases of python application other than GitHub, please let me know in #103!

Please provide your OS name and version if you can run the dashboard on it perfectly in #31, since I only tested on Ubuntu. Thank you!

WGDashboard

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 and manage them in a easier way.

Note: This project is not affiliate to the official WireGuard Project ;)

📣 What's New: v2.3

🎉 New Features
- Update directly from wgd.sh: Now you can update WGDashboard directly from the bash script.
- Displaying Peers: You can switch the display mode between list and table in the configuration page.
🪚 Bug Fixed
- Peer DNS Validation Fails #67: Added DNS format check. [❤️ @realfian]
- configparser.NoSectionError: No section: 'Interface' #66: Changed permission requirement for etc/wireguard from 744 to 755. [❤️ @ramalmaty]
- Feature request: Interface not loading when information missing #73: Fixed when Configuration Address and Listen Port is missing will crash the dashboard. [❤️ @js32]
- Remote Peer, MTU and PersistentKeepalives added #70: Added MTU, remote peer and Persistent Keepalive. [❤️ @realfian]
- Fixes DNS check to support search domain #65: Added allow input domain into DNS. [❤️@davejlong]
🧐 Other Changes
- Moved Add Peer Button into the right bottom corner.

Table of Content

💡 Features
📝 Requirement
🛠 Install
🪜 Usage
- Start/Stop/Restart WGDashboard
- Autostart WGDashboard on boot
✂️ Dashboard Configuration
- Dashboard Configuration file
- Generating QR code and peer configuration file (.conf)
❓ How to update the dashboard?
🔍 Screenshot
⏰ Changelog
🛒 Dependencies
✨ Contributors

💡 Features

No need to re-configure existing WireGuard configuration! It can search for existed configuration files.
Easy to use interface, provided username and password protection to the dashboard
Add peers and edit (Allowed IPs, DNS, Private Key...)
View peers and configuration real time details (Data Usage, Latest Handshakes...)
Share your peer configuration with QR code or file download
Testing tool: Ping and Traceroute to your peer's ip
And more functions are coming up!

📝 Requirement

Recommend the following OS, tested by our beloved users:
- Ubuntu 18.04.1 LTS - 20.04.1 LTS [@Me]
- Debian GNU/Linux 10 (buster) [❤️ @robchez]
- AlmaLinux 8.4 (Electric Cheetah) [❤️ @barry-smithjr]
- CentOS 7 [❤️ @PrzemekSkw]
If you have tested on other OS and it works perfectly please provide it to me in #31. Thank you!
WireGuard and WireGuard-Tools (wg-quick) are installed.

Don't know how? Check this official documentation

Configuration files under /etc/wireguard, but please note the following sample

[Interface]
...
SaveConfig = true
# Need to include this line to allow WireGuard Tool to save your configuration, 
# or if you just want it to monitor your WireGuard Interface and don't need to
# make any changes with the dashboard, you can set it to false.

[Peer]
PublicKey = abcd1234
AllowedIPs = 1.2.3.4/32
# Must have for each peer

Python 3.7+ & Pip3

🛠 Install

Download WGDashboard

git clone -b v2.3.1 https://github.com/donaldzou/WGDashboard.git wgdashboard

Open the WGDashboard folder
```
cd wgdashboard/src
```

Install WGDashboard

sudo chmod u+x wgd.sh
sudo ./wgd.sh install

Give read and execute permission to root of the WireGuard configuration folder, you can change the path if your configuration files are not stored in /etc/wireguard
```
sudo chmod -R 755 /etc/wireguard
```
Run WGDashboard
```
./wgd.sh start
```
Note:

For pivpn user, please use sudo ./wgd.sh start to run if your current account does not have the permission to run wg show and wg-quick.
Access dashboard

Access your server with port 10086 (e.g. http://your_server_ip:10086), using username admin and password admin. See below how to change port and ip that the dashboard is running with.

🪜 Usage

Start/Stop/Restart WGDashboard

cd wgdashboard/src
-----------------------------
./wgd.sh start    # Start the dashboard in background
-----------------------------
./wgd.sh debug    # Start the dashboard in foreground (debug mode)
-----------------------------
./wgd.sh stop     # Stop the dashboard
-----------------------------
./wgd.sh restart  # Restart the dasboard

Autostart WGDashboard on boot (>= v2.2)

In the src folder, it contained a file called wg-dashboard.service, we can use this file to let our system to autostart the dashboard after reboot. The following guide has tested on Ubuntu, most Debian based OS might be the same, but some might not. Please don't hesitate to provide your system if you have tested the autostart on another system.

Changing the directory to the dashboard's directory
```
cd wgdashboard/src
```
Get the full path of the dashboard's directory
```
pwd
#Output: /root/wgdashboard/src
```
For this example, the output is /root/wireguard-dashboard/src, your path might be different since it depends on where you downloaded the dashboard in the first place. Copy the the output to somewhere, we will need this in the next step.
Edit the service file, the service file is located in wireguard-dashboard/src, you can use other editor you like, here will be using nano
```
nano wg-dashboard.service
```
You will see something like this:
```
[Unit]
After=network.service

[Service]
WorkingDirectory=<your dashboard directory full path here>
ExecStart=/usr/bin/python3 <your dashboard directory full path here>/dashboard.py
Restart=always


[Install]
WantedBy=default.target
```
Now, we need to replace both <your dashboard directory full path here> to the one you just copied from step 2. After doing this, the file will become something like this, your file might be different:
```
[Unit]
After=netword.service

[Service]
WorkingDirectory=/root/wgdashboard/src
ExecStart=/usr/bin/python3 /root/wgdashboard/src/dashboard.py
Restart=always


[Install]
WantedBy=default.target
```
Be aware that after the value of WorkingDirectory, it does not have a / (slash). And then save the file after you edited it
Copy the service file to systemd folder
```
$ cp wg-dashboard.service /etc/systemd/system/wg-dashboard.service
```
To make sure you copy the file successfully, you can use this command cat /etc/systemd/system/wg-dashboard.service to see if it will output the file you just edited.

Enable the service

$ sudo chmod 664 /etc/systemd/system/wg-dashboard.service
$ sudo systemctl daemon-reload
$ sudo systemctl enable wg-dashboard.service
$ sudo systemctl start wg-dashboard.service  # <-- To start the service

Check if the service run correctly

$ sudo systemctl status wg-dashboard.service

And you should see something like this

● wg-dashboard.service
     Loaded: loaded (/etc/systemd/system/wg-dashboard.service; enabled; vendor preset: enabled)
     Active: active (running) since Tue 2021-08-03 22:31:26 UTC; 4s ago
   Main PID: 6602 (python3)
      Tasks: 1 (limit: 453)
     Memory: 26.1M
     CGroup: /system.slice/wg-dashboard.service
             └─6602 /usr/bin/python3 /root/wgdashboard/src/dashboard.py

Aug 03 22:31:26 ubuntu-wg systemd[1]: Started wg-dashboard.service.
Aug 03 22:31:27 ubuntu-wg python3[6602]:  * Serving Flask app "WGDashboard" (lazy loading)
Aug 03 22:31:27 ubuntu-wg python3[6602]:  * Environment: production
Aug 03 22:31:27 ubuntu-wg python3[6602]:    WARNING: This is a development server. Do not use it in a production deployment.
Aug 03 22:31:27 ubuntu-wg python3[6602]:    Use a production WSGI server instead.
Aug 03 22:31:27 ubuntu-wg python3[6602]:  * Debug mode: off
Aug 03 22:31:27 ubuntu-wg python3[6602]:  * Running on all addresses.
Aug 03 22:31:27 ubuntu-wg python3[6602]:    WARNING: This is a development server. Do not use it in a production deployment.
Aug 03 22:31:27 ubuntu-wg python3[6602]:  * Running on http://0.0.0.0:10086/ (Press CTRL+C to quit)

If you see Active: followed by active (running) since... then it means it run correctly.

Stop/Start/Restart the service

sudo systemctl stop wg-dashboard.service      # <-- To stop the service
sudo systemctl start wg-dashboard.service     # <-- To start the service
sudo systemctl restart wg-dashboard.service   # <-- To restart the service

And now you can reboot your system, and use the command at step 6 to see if it will auto start after the reboot, or just simply access the dashboard through your browser. If you have any questions or problem, please report it in the issue page.

✂️ Dashboard Configuration

Dashboard Configuration file

Since version 2.0, WGDashboard will be using a configuration file called wg-dashboard.ini, (It will generate automatically after first time running the dashboard). More options will include in future versions, and for now it included the following config:

	Description	Default	Available in Setting
`[Account]`
`username`	Dashboard login username	`admin`	Yes
`password`	Password, will be hash with SHA256	`admin` hashed in SHA256	Yes
`[Server]`
`wg_conf_path`	The path of all the Wireguard configurations	`/etc/wireguard`	Yes
`app_ip`	IP address the dashboard will run with	`0.0.0.0`	Yes
`app_port`	Port the the dashboard will run with	`10086`	Yes
`auth_req`	Does the dashboard need authentication to access	`true`	No
	If `auth_req = false` , user will not be access the Setting tab due to security consideration. User can only edit the file directly in system.
`version`	Dashboard Version	`v2.2`	No

Except auth_req due to security consideration.

Generating QR code and peer configuration file (.conf)

Starting version 2.2, dashboard can now generate QR code and configuration file for each peer. Here is a template of what each QR code encoded with and the same content will be inside the file:

[Interface]
PrivateKey = QWERTYUIOPO234567890YUSDAKFH10E1B12JE129U21=
Address = 0.0.0.0/32
DNS = 1.1.1.1

[Peer]
PublicKey = QWERTYUIOPO234567890YUSDAKFH10E1B12JE129U21=
AllowedIPs = 0.0.0.0/0
Endpoint = 0.0.0.0:51820

	Description	Default Value	Available in Peer setting
`[Interface]`
`PrivateKey`	The private key of this peer	Private key generated by WireGuard (`wg genkey`) or provided by user	Yes
`Address`	The `allowed_ips` of your peer	N/A	Yes
`DNS`	The DNS server your peer will use	`1.1.1.1` - Cloud flare DNS, you can change it when you adding the peer or in the peer setting.	Yes
`[Peer]`
`PublicKey`	The public key of your server	N/A	No
`AllowedIPs`	IP ranges for which a peer will route traffic	`0.0.0.0/0` - Indicated a default route to send all internet and VPN traffic through that peer.	Yes
`Endpoint`	Your wireguard server ip and port, the dashboard will search for your server's default interface's ip.	`<your server default interface ip>:<listen port>`	Yes

❓ How to update the dashboard?

Change your directory to wireguard-dashboard
```
cd wireguard-dashboard/src
```
Update the dashboard
```
sudo ./wgd.sh update
```

🔍 Screenshot

⏰ Changelog

v2.2.1 - Aug 16, 2021

Bug Fixed:

Added support for full subnet on Allowed IP
Peer setting Save button

v2.2 - Aug 14, 2021

🎉 New Features
- Add new peers: Now you can add peers directly on dashboard, it will generate a pair of private key and public key. You can also set its DNS, endpoint allowed IPs. Both can set a default value in the setting page. [❤️ in #44]
- QR Code: You can add the private key in peer setting of your existed peer to create a QR code. Or just create a new one, dashboard will now be able to auto generate a private key and public key ;) Don't worry, all keys will be generated on your machine, and will delete all key files after they got generated. [❤️ in #29]
- Peer configuration file download: Same as QR code, you now can download the peer configuration file, so you don't need to manually input all the details on the peer machine! [❤️ in #40]
- Search peers: You can now search peers by their name.
- Autostart on boot: Added a tutorial on how to start the dashboard to on boot! Please read the tutorial below. [❤️ in #29]
- Click to copy: You can now click and copy all peer's public key and configuration's public key.
- ....
🪚 Bug Fixed
- When there are comments in the wireguard config file, will cause the dashboard to crash.
- Used regex to search for config files.
🧐 Other Changes
- Moved all external CSS and JavaScript file to local hosting (Except Bootstrap Icon, due to large amount of SVG files).
- Updated Python dependencies
  - Flask: v1.1.2 => v2.0.1
  - Jinja: v2.10.1 => v3.0.1
  - icmplib: v2.1.1 => v3.0.1
- Updated CSS/JS dependencies
  - Bootstrap: v4.5.3 => v4.6.0
- UI adjustment
  - Adjusted how peers will display in larger screens, used to be 1 row per peer, now is 3 peers in 1 row.

v2.1 - Jul 2, 2021

Added Ping and Traceroute tools!
Adjusted the calculation of data usage on each peers
Added refresh interval of the dashboard
Bug fixed when no configuration on fresh install (#23)
Fixed crash when too many peers (#22)

v2.0 - May 5, 2021

Added login function to dashboard
- I'm not using the most ideal way to store the username and password, feel free to provide a better way to do this if you any good idea!
Added a config file to the dashboard
Dashboard config can be change within the Setting tab on the side bar
Adjusted UI
And much more!

v1.1.2 - Apr 3, 2021

Resolved issue #3.

v1.1.1 - Apr 2, 2021

Able to add a friendly name to each peer. Thanks #2 !

v1.0 - Dec 27, 2020

Added the function to remove peers

🛒 Dependencies

CSS/JS
- Bootstrap v4.6.0
- Bootstrap Icon v1.4.0
- jQuery v3.5.1
Python
- Flask v2.0.1
- TinyDB v4.3.0
- ifcfg v0.21
- icmplib v2.1.1
- flask-qrcode v3.0.0

✨ Contributors

Thanks goes to these wonderful people (emoji key):

_antonioag95
⚠️ 💻

_tonjo
💻

_{Richard Newton}
💻

_{David Long}
💻

_{Markus Neubauer}
💻

This project follows the all-contributors specification. Contributions of any kind welcome!