Roadmap on v4.0

[donaldzou]

Roadmap on v4.0

I will keep updating this comment :)

Updates on the new features everyone requested 😄

• Traffic statistic on configuration page
• API interface w/ API Key (Still need to finish documentation).
• Block peers without deleting it (YES, we now have restrict). 🫶 to @xiki808.
• Remove peer after period or condition. 🫶 to Request feature that removes peers by time value #86, @poorp, @upgo7502, @rlrexyz, @Profik .
• Accept y/Y in .wgd.sh. 🫶 to @nicedevil007

Features still needs to work on

Done

• Add traffic information on main page. 🫶 to @bolgovrussia
• Reset Peer or Configuration's data usage. 🫶 to @eduardorosabales
• An interface facing the client to download with QR Code: Maybe a better way is to create an unique link, that link to a page where only show the QR code and a button to download, and the link can expire at a time. 🫶 to @Profik
• Restart button for configuration. 🫶 to @airgapper
• Parsing comments in .conf. 🫶 to @bugsse, @Johnnykson at Roadmap on v4.0 #293 (comment)
• Cross server access through any dashboard. And potentially, building an ElectronJS app :)
  • Desktop App is hosted under WGDashboard Desktop
• Add instruction to have wg interface autostart on startup. 🫶 to Switch to make wgX interface to auto start on boot #248

In progress

Testing under different OS with Python 3.10, 3.11 & 3.12

Debian Based OS

Ubuntu 20.04

sudo add-apt-repository ppa:deadsnakes/ppa -y && \
sudo apt-get install python3.10 python3.10-distutils -y && \
sudo apt-get update -y && \
sudo apt install wireguard-tools net-tools --no-install-recommends -y && \
git clone -b v4 https://github.com/donaldzou/WGDashboard.git && \
cd WGDashboard/src && \
chmod +x ./wgd.sh && \
./wgd.sh install && \
sudo sh -c 'echo "net.ipv4.ip_forward=1" >> /etc/sysctl.conf' && \
sudo sysctl -p

Ubuntu 22.04, 24.02

sudo apt-get update && \
sudo apt install wireguard-tools net-tools && \
git clone -b v4 https://github.com/donaldzou/WGDashboard.git && \
cd ./WGDashboard/src && \
chmod +x ./wgd.sh && \
./wgd.sh install && \
sudo echo "net.ipv4.ip_forward=1" >> /etc/sysctl.conf && \
sudo sysctl -p /etc/sysctl.conf

Debian 11.10

apt-get install sudo -y && sudo apt-get update && sudo apt install -y git iptables build-essential zlib1g-dev libncurses5-dev libgdbm-dev libnss3-dev libssl-dev libreadline-dev libffi-dev libsqlite3-dev wget libbz2-dev wireguard-tools net-tools && wget https://www.python.org/ftp/python/3.10.0/Python-3.10.0.tgz && tar -xvf Python-3.10.0.tgz && cd Python-3.10.0 && sudo ./configure --enable-optimizations && sudo make && sudo make altinstall && cd .. && git clone -b v4 https://github.com/donaldzou/WGDashboard.git && cd ./WGDashboard/src && chmod +x ./wgd.sh && ./wgd.sh install && sudo sh -c 'echo "net.ipv4.ip_forward=1" >> /etc/sysctl.conf' && sudo sysctl -p

Debian 12.6

apt-get install sudo git iptables -y \ 
sudo apt-get update && \
sudo apt install wireguard-tools net-tools && \
git clone -b v4 https://github.com/donaldzou/WGDashboard.git && \
cd ./WGDashboard/src && \
chmod +x ./wgd.sh && \
./wgd.sh install && \
sudo echo "net.ipv4.ip_forward=1" >> /etc/sysctl.conf && \
sudo sysctl -p /etc/sysctl.conf

• Ubuntu 20.04.6 LTS (Focal Fossa)
  • Had to install Python 3.10 ahead. Everything else is smooth
• Ubuntu 22.04.4 LTS (Jammy Jellyfish)
  • Ran perfectly, without any issue
• Ubuntu 24.04 LTS (Noble Numbat)
  • Ran perfectly, without any issue
• Debian 12.6 (bookworm)
  • Need to install sudo, git, iptables ahead. Everything else is smooth
• Debian 11.10 (bullseye)
  • Need to install sudo, git, iptables and Python 3.10 ahead. Everything else is smooth

Red-Hat / Fedora Based

RHEL 9.4, CentOS 9-Stream

sudo yum install wireguard-tools net-tools git python3.11 -y && \
git clone -b v4 https://github.com/donaldzou/WGDashboard.git && \
cd ./WGDashboard/src && \
chmod +x ./wgd.sh && \
./wgd.sh install && \
sudo echo "net.ipv4.ip_forward=1" >> /etc/sysctl.conf && \
sudo sysctl -p /etc/sysctl.conf && \
firewall-cmd --zone=public --add-port=10086/tcp --permanent && \
firewall-cmd --zone=public --add-port=51820/udp --permanent && \
firewall-cmd --reload

• Red Hat Enterprise Linux 9.4
  • Had to install Python 3.11 and git, everything else is smooth.
• CentOS 9
  • Had to install Python 3.11 and git, everything else is smooth.
• Fedora Linux 38
• Fedora Linux 39
• Fedora Linux 40

Backlog

• Backup & restore function on db and WireGuard file. 🫶 to @tokon2000
• Different language. 🫶 to @bkeenke
• Tracking when did peer connected and disconnected. 🫶 to @kontorskiy777

Potential

New feature for v4.0 will cut off from here, other feature will release in later releases 😃

Bugs needs to be fix

• FireFox and Safari is not showing time picker with datetime-local input element. Will replace it with a JS plugin 🫶 to v4.0 Dashboard UI issue on Firefox  #294. Fixed in 7463767
• System service file did not configure correctly. 🫶 to Autostart WGDashboard on boot #297. Fixed in 55f5582
• Replace ifcfg in dashboard.py due to stability of IPv6 interface. 🫶 to RuntimeError: Got results that don't belong to a device #255

Features not consider at the moment. Sorry 🥹

• Using SSO for login: The reason is I'm trying to keep the dashboard simple and not adding 3rd party service to add more complexity. 🫶 to @pradhyumk
• Add rounding to 2 decimals on traffic. 🫶 to @bolgovrussia
• Remove "Peer" keyword on each peer: I'd like to keep the uniform design of each information. 🫶 to @ghost
• Email configuration, thinking of using SendGrid or MailChip to avoid the hassle of creating domain and such. 🫶 to @adrinux

[Johnnykson]

Parsing comments in .conf: I've tried to implement the function, but I can't guaranteed the stability since there are tons way of writing comments in a config file. 🫶 to @bugsse

I suggest implementing comment analysis only for one template, choose any, so that there is generally the possibility of importing configurations, and users themselves will edit manually for this template either in the configs themselves or in the scripts that create them. I propose to choose a template based on this script https://github.com/angristan/wireguard-install/blob/master/wireguard-install.sh

[donaldzou]

Parsing comments in .conf: I've tried to implement the function, but I can't guaranteed the stability since there are tons way of writing comments in a config file. 🫶 to @bugsse

I suggest implementing comment analysis only for one template, choose any, so that there is generally the possibility of importing configurations, and users themselves will edit manually for this template either in the configs themselves or in the scripts that create them. I propose to choose a template based on this script https://github.com/angristan/wireguard-install/blob/master/wireguard-install.sh

I think you gave me a direction! I'll look into it and maybe squeeze it in the v4 release. I don't think is too hard to implement.

[Profik]

@donaldzou
Hi!
Is it possible for you to set a speed limit for each peer? Can you do it through the Linux Traffic Control utility?

[donaldzou]

Hi @Profik , I've used the tc -- Linux Traffic Control to limit speed on the entire configuration (interface), but not on specific peer. But I'm thinking, you can use the tc command to limit the tx -- transmit rate on the peer's machine (if it is running Linux as well)

or check this out: https://serverfault.com/questions/191560/how-can-i-do-traffic-shaping-in-linux-by-ip

[Profik]

@donaldzou
Let's say there are 5 users (smartphones), one of them decided to watch YouTube, then he will take the entire channel, the other 4 will have brakes on the Internet. What should I do in this situation?

[donaldzou]

@donaldzou

Let's say there are 5 users (smartphones), one of them decided to watch YouTube, then he will take the entire channel, the other 4 will have brakes on the Internet. What should I do in this situation?

In this case you might need to look into packet capturing on your server, and if it detect any packet that is going to YouTube, then you can maybe just tc to limit the other peers to none? Just a general idea I can think of :)

Maybe try using WireShark to capture traffic on your WG interface and start from there?

[DaanSelen]

Regarding languages I can contribute Dutch.

[Profik]

@donaldzou I can offer a translation into Russian.

[donaldzou]

Closing this issue, refer to the new road map #354

[donaldzou]

Hi @DaanSelen and @Profik, if you guys are still willing to contribute localization, please visit #397 ;)