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!
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.
Add peers for each WireGuard configuration
And many more coming up! Welcome to contribute to this project!
Ubuntu or Debian based OS, other might work, but haven't test yet. Tested on the following OS:
‼️ Make sure you have Wireguard and Wireguard-Tools (
wg-quick) installed.‼️ How to install?
Configuration files under /etc/wireguard
.conffile, please make sure you have
SaveConfig = trueunder
[Interface](Bug mentioned in #9)
Python 3.7+ & Pip3
Download Wireguard Dashboard
$ git clone -b v2.1 https://github.com/donaldzou/Wireguard-Dashboard.git
Install Python Dependencies
$ cd Wireguard-Dashboard/src $ python3 -m pip install -r requirements.txt
Install & run Wireguard Dashboard
$ sudo chmod -R 744 /etc/wireguard # Add read and execute permission of the wireguard config folder $ sudo chmod u+x wgd.sh $ ./wgd.sh start
pivpnuser, please use
sudo ./wgd.sh startto run if your current account does not have the permission to run
Access your server with port
10086 ! e.g (http://your_server_ip:10086), continue to read to on how to change port and ip that dashboard is running with.
1. Start/Stop/Restart Wireguard Dashboard
$ cd Wireguard-Dashboard/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
⚠️ For first time user please also read the next section.
Since version 2.0, Wireguard Dashboard 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:
||Dashboard login username||
||Password, will be hash with SHA256||
||The path of all the Wireguard configurations||
||IP address the dashboard will run with||
||Port the the dashboard will run with||
||Does the dashboard need authentication to access||
Latest Version: V2.1
All these settings will be able to configure within the dashboard in Settings on the sidebar, without changing the actual file. Except
auth_req due to security consideration.
$ cd wireguard-dashboard
$ sudo git pull https://github.com/donaldzou/wireguard-dashboard.git v2.1 --force
$ python3 -m pip install -r requirements.txt
$ ./wgd.sh start
git pull https://github.com/donaldzou/Wireguard-Dashboard.git v2.1to get the new update inside
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!