Releases: donaldzou/WGDashboard
2024 November Release 1 (v4.1.0)
📣 What's New: v4.1.0
🎉 New Features
- Multi-Language Support: Now WGDashboard support the following languages on its user interface, big thanks to our user's contribution!
- Chinese Traditional
- Chinese Simplified
- Czech (@jursed)
- Dutch (@DaanSelen)
- English
- German (@orangeferdi)
- Italian (@3vis97)
- Russian (Pixnet)
- Ukrainian (@shuricksumy)
If you would like to contribute, please follow the instructions on Localization of WGDashboard. Thanks in advance!
- Backup & Restore WireGuard Configurations: Now you can back up your configurations, restore it after a change made to the configuration. You can also restore it even after deletion.
- Delete & Rename WireGuard Configuration: Now you can delete and rename configuration within WGDashboard
- Toggle WireGuard Configuration After Startup: Now you can set WireGuard configurations to be turned on after starting WGDashboard in Settings
- Delete & Download Peers in bulk
- Frontend Display of Peer's Configuration File
- Added Support on AlmaLinux and Pi OS
- Added OpenStreetMap on Ping and Traceroute Tool
🛠️ Some Adjustments
- Updated Docker configuration
- Updates on API endpoints
- UI Adjustments
- Added version number in navbar
- Added WGDashboard host and port settings
- Added peer delete confirmation
- Added domain support in DNS field for peers
🧐 Bugs Fixed
- Mobile UI issues in #353
- Removed WireGuard configuration error alert from Gunicorn start in #328
- Sometimes restrict peer might not be success in #357
- Weird SQLite error causing WGDashboard to crash in #366
🗂️ User Guides
Will continue to finish the sections
🥘 Experimental Features
- Cross-Server Access: Now you can access other servers that installed
v4
of WGDashboard through API key. - Desktop App: Thanks to Cross-Server Access, you can now download an ElectronJS based desktop app of WGDashboard, and use that to access WGDashboard on different servers.
For more information, please visit 🥘 Experimental Features
How to update
Solution 1 (v4.0+)
sudo ./wgd.sh update
Solution 2
If Solution 1 above is not working for you...
-
Change your directory to
wgdashboard
cd wgdashboard/src
-
Update the dashboard
git pull https://github.com/donaldzou/WGDashboard.git --force
-
Install
sudo ./wgd.sh install
2024 September Release 2 (v4.0.4)
📣 What's New: v4.0.4
🧐 Bugs Fixed
- Fixed issue where Preshared Key is not added when unrestricted peers by @donaldzou in #395
Full Changelog: v4.0.3...v4.0.4
2024 September Release 1 (v4.0.3)
2024 August Release 3 (v4.0.2)
📣 What's New: v4.0.2
🧐 Bugs Fixed
2024 August Release 2 (v4.0.1)
📣 What's New: v4.0.1
🧐 Bugs Fixed
- Fixed peer status is not refreshing correctly by @donaldzou in #306
2024 August Release 2 (v4.0)
📣 What's New: v4.0
🎉 New Features
- Updated dashboard design: Re-designed some of the section with more modern style and layout, the UI is faster and more responsive, it also uses less memory. But overall is still the same dashboard you're familiarized.
- Docker Solution: We now have 2 docker solutions! Thanks to @DaanSelen & @shuricksumy for providing them. For more information, please see the Docker section below.
- Peer Job Scheduler: Now you can schedule jobs for each peer to either restrict or delete the peer if the peer's total / upload / download data usage exceeded a limit, or you can set a specific datetime to restrict or delete the peer.
- Share Peer's QR Code with Public Link: You can share a peer's QR code and
.conf
file without the need to loging in. - WGDashboard's REST API: You can now request all the api endpoint used in the dashboard. For more details please review the API Documentation.
- Logging: Dashboard will now log all activity on the dashboard and API requests.
- Time-Based One-Time Password (TOTP): You can enable this function to add one more layer of security, and generate the TOTP with your choice of authenticator.
- Designs
- Real-time Graphs: You can view real-time data changes with graphs in each configuration.
- Night mode: You know what that means, it avoids bugs ;)
- Enforce Python Virtual Environment: I noticed newer Python version (3.12) does not allow to install packages globally, and plus I think is a good idea to use venv.
🧐 Other Changes
- Deprecated jQuery from the project, and migrated and rewrote the whole front-end with Vue.js. This allows the dashboard is future proofed, and potential cross server access with a desktop app.
- Rewrote the backend into a REST API structure
- Improved SQL query efficient
- Removed all templates, except for
index.html
where it will load the Vue.js app. - Parsing names in
.conf
- Minimized the need to read
.conf
, only when any.conf
is modified
🥘 New Experimental Features
- Cross-Server Access: Now you can access other servers that installed
v4
of WGDashboard through API key. - Desktop App: Thanks to Cross-Server Access, you can now download an ElectronJS based desktop app of WGDashboard, and use that to access WGDashboard on different servers.
I can't thank enough for all of you who wait for this release, and for those who are new to this project, welcome :)
Also, huge thanks to who contributed to this major release:
@bolgovrussia, @eduardorosabales, @Profik, @airgapper, @tokon2000, @bkeenke, @kontorskiy777, @bugsse, @Johnnykson, @DaanSelen, @shuricksumy and many others!
v4.0 Beta Release 3
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 #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
In progress
- Cross server access through any dashboard. And potentially, building an ElectronJS app :)
- Desktop App is hosted under WGDashboard Desktop
- Backup & restore function on db and WireGuard file. 🫶 to @tokon2000
Backlog
- Different language. 🫶 to @bkeenke
- Tracking when did peer connected and disconnected. 🫶 to @kontorskiy777
- Add instruction to have wg interface autostart on startup. 🫶 to #248
Potential
- Parsing comments in
.conf
. 🫶 to @bugsse, @Johnnykson at #293 (comment)
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 #294. Fixed in 7463767 - System service file did not configure correctly. 🫶 to #297. Fixed in 55f5582
- Replace
ifcfg
indashboard.py
due to stability of IPv6 interface. 🫶 to #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
v4.0 Beta Release 2
Roadmap on v4.0
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 #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
In progress
- Backup & restore function on db and WireGuard file. 🫶 to @tokon2000
Backlog
- Different language. 🫶 to @bkeenke
- Tracking when did peer connected and disconnected. 🫶 to @kontorskiy777
Potential
- Parsing comments in
.conf
. 🫶 to @bugsse, @Johnnykson at #293 (comment)
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 #294. Fixed in 7463767
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