mirror of https://github.com/donaldzou/WGDashboard.git synced 2024-11-04 23:10:14 +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 Zou 971e127cfd Update README.md		2021-07-03 10:30:54 -04:00
.github/ISSUE_TEMPLATE	Update issue templates	2021-04-10 12:49:34 -04:00
img	Push Logo	2021-04-12 23:16:12 -04:00
src	Delete wg0.conf	2021-07-02 14:35:34 -04:00
.all-contributorsrc	docs: update .all-contributorsrc [skip ci]	2021-04-13 02:29:48 +00:00
.gitignore	Commit June 2	2021-07-02 13:23:04 -04:00
LICENSE	Initial commit	2020-10-18 01:08:59 -04:00
README.md	Update README.md	2021-07-03 10:30:54 -04:00

README.md

I'm looking for someone that have experiences on migrating this project to a Docker app, with a complete solution ;) If you know how please comment in here.

Wireguard Dashboard

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.

📣 What's New: Version 2.1

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 (Bug report)
Fixed crash when too many peers (Bug report)

💡 Features

Add peers for each WireGuard configuration
Manage peer
Delete peers
And many more coming up! Welcome to contribute to this project!

📝 Requirement

Ubuntu or Debian based OS, other might work, but haven't test yet. Tested on the following OS:
- Ubuntu 18.04.1 LTS
- If you have tested on other OS and it works perfectly please provide it to me!
‼️ Make sure you have Wireguard and Wireguard-Tools (wg-quick) installed.‼️ How to install?
Configuration files under /etc/wireguard
- Note:
  - For [Interface] in the .conf file, please make sure you have SaveConfig = true under [Interface] (Bug mentioned in #9)
  - For peers, PublicKey & AllowedIPs is required.
Python 3.7+ & Pip3

🛠 Install

1. Download Wireguard Dashboard

$ git clone -b v2.1 https://github.com/donaldzou/Wireguard-Dashboard.git

2. Install Python Dependencies

$ cd Wireguard-Dashboard/src
$ python3 -m pip install -r requirements.txt

3. Install & run Wireguard Dashboard

$ chmod u+x wgd.sh
$ ./wgd.sh start

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.

🪜 Usage

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.

✂️ Dashboard Configuration

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:

`[Account]`

username - Username (Default: admin)

password - Password, will be hash with SHA256 (Default: admin).

`[Server]`

wg_conf_path - The path of all the Wireguard configurations (Default: /etc/wireguard)

app_ip - IP address the flask will run with (Default: 0.0.0.0)

app_port - Port the flask will run with (Default: 10086)

auth_req - Does the dashboard need authentication (Default: true)

If auth_req = false , user will not be access the Setting tab due to security consideration. User can only change the file directly in system.

version - Dashboard Version

All these settings will be able to configure within the dashboard in Settings on the sidebar, without changing the actual file. Except version and auth_req due to security consideration.

❓ How to update the dashboard?

Change your directory to wireguard-dashboard
```
$ cd wireguard-dashboard
```

Get the newest version

$ sudo git pull https://github.com/donaldzou/wireguard-dashboard.git v2.1 --force

Update and install all python dependencies

$ python3 -m pip install -r requirements.txt

Start the dashboard
```
$ ./wgd.sh start
```

⚠️ Update from v1.x.x

Stop the dashboard if it is running.
You can use git pull https://github.com/donaldzou/Wireguard-Dashboard.git v2.1 to get the new update inside Wireguard-Dashboard directory.
Proceed Step 2 & 3 in the Install step down below.