mirror of
https://github.com/donaldzou/WGDashboard.git
synced 2025-07-07 13:47:00 +00:00
89 lines
5.3 KiB
Markdown
89 lines
5.3 KiB
Markdown
> [!TIP]
|
||
> 🎉 I'm excited to announce that WGDashboard is officially listed on DigitalOcean's Marketplace! For more information, please visit [Host WGDashboard & WireGuard with DigitalOcean](https://donaldzou.dev/WGDashboard-Documentation/host-wgdashboard-wireguard-with-digitalocean.html) for more information!
|
||
|
||
> [!NOTE]
|
||
> **Help Wanted 🎉**: Localizing WGDashboard to other languages! If you're willing to help, please visit https://github.com/donaldzou/WGDashboard/issues/397. Many thanks!
|
||
|
||
|
||
|
||
|
||
<p align="center">
|
||
<img alt="WGDashboard" src="https://wgdashboard-resources.tor1.cdn.digitaloceanspaces.com/Logos/Logo-2-Rounded-512x512.png" width="128">
|
||
</p>
|
||
<h1 align="center">WGDashboard</h1>
|
||
<p align="center">
|
||
<img src="https://forthebadge.com/images/badges/made-with-python.svg">
|
||
<img src="https://forthebadge.com/images/badges/made-with-javascript.svg">
|
||
<img src="https://forthebadge.com/images/badges/license-mit.svg">
|
||
</p>
|
||
<p align="center">
|
||
<img src="https://forthebadge.com/images/badges/built-with-love.svg">
|
||
</p>
|
||
|
||
<p align="center">
|
||
<a href="https://github.com/donaldzou/wireguard-dashboard/releases/latest"><img src="https://img.shields.io/github/v/release/donaldzou/wireguard-dashboard"></a>
|
||
<a href="https://wakatime.com/badge/github/donaldzou/WGDashboard"><img src="https://wakatime.com/badge/github/donaldzou/WGDashboard.svg" alt="wakatime"></a>
|
||
<a href="https://hitscounter.dev"><img src="https://hitscounter.dev/api/hit?url=https%3A%2F%2Fgithub.com%2Fdonaldzou%2FWGDashboard&label=Visitor&icon=github&color=%230a58ca"></a>
|
||
<img src="https://img.shields.io/docker/pulls/donaldzou/wgdashboard?logo=docker&label=Docker%20Image%20Pulls&labelColor=ffffff">
|
||
</p>
|
||
<p align="center"><b>This project is supported by</b></p>
|
||
<p align="center">
|
||
<a href="https://m.do.co/c/a84cb9aac585">
|
||
<img src="https://opensource.nyc3.cdn.digitaloceanspaces.com/attribution/assets/SVG/DO_Logo_horizontal_blue.svg" width="201px">
|
||
</a>
|
||
</p>
|
||
<p align="center">Monitoring WireGuard is not convenient, in most case, you'll need to login to your server and type <code>wg show</code>. That's why this project is being created, to view and manage all WireGuard configurations in a easy way.</p>
|
||
<p align="center">With all these awesome features, while keeping it <b>easy to install and use</b></p>
|
||
|
||
<p align="center"><b><i>This project is not affiliate to the official WireGuard Project</i></b></p>
|
||
|
||
|
||
<p align="center">
|
||
Join our Discord Server for quick help, or you wanna chat about this project!
|
||
</p>
|
||
<p align="center">
|
||
<a align="center" href="https://discord.gg/72TwzjeuWm"><img src="https://img.shields.io/discord/1276818723637956628?labelColor=ffffff&style=for-the-badge&logo=discord&label=Discord"></a>
|
||
</p>
|
||
<p align="center">
|
||
Alternatively, you can also reach out at our Matrix.org Chatroom :)
|
||
</p>
|
||
<p align="center">
|
||
<a href="https://app.element.io/#/room/#wgd:matrix.org">Matrix.org Chatroom</a>
|
||
</p>
|
||
|
||
|
||
<hr>
|
||
|
||
# [Demo](https://wgd-demo.donaldzou.dev)
|
||
If you would like to try out WGDashboard, feel free to access the link above. You won't be able to actually connect it with WireGuard since I blocked all Post/Pre script.
|
||
|
||
Username: `admin`
|
||
|
||
Password: `admin`
|
||
|
||
> **Please don't abuse server 🥺, and do not put any personal information on it.** If you can't access it, [please let me know here](https://github.com/donaldzou/WGDashboard/issues/695).
|
||
|
||
<hr>
|
||
|
||
# [Official Documentation](https://donaldzou.dev/WGDashboard-Documentations)
|
||
|
||
- [💡 Features](https://donaldzou.github.io/WGDashboard-Documentation/features.html)
|
||
- [📝 Requirements](https://donaldzou.github.io/WGDashboard-Documentation/requirements.html)
|
||
- [🛠 Install](https://donaldzou.github.io/WGDashboard-Documentation/install.html)
|
||
- [🐬 Docker Solutions](https://github.com/donaldzou/WGDashboard/tree/main/docker)
|
||
- [🪜 Usage](https://donaldzou.github.io/WGDashboard-Documentation/usage.html)
|
||
- [📖 API Documentation](https://donaldzou.github.io/WGDashboard-Documentation/api-documentation.html)
|
||
- [And much more...](https://donaldzou.github.io/WGDashboard-Documentation/)
|
||
|
||
# Screenshots
|
||
|
||
<img src="https://wgdashboard-resources.tor1.cdn.digitaloceanspaces.com/Documentation%20Images/sign-in.png" alt=""/>
|
||
<img src="https://wgdashboard-resources.tor1.cdn.digitaloceanspaces.com/Documentation%20Images/cross-server.png" alt=""/>
|
||
<img src="https://wgdashboard-resources.tor1.cdn.digitaloceanspaces.com/Documentation%20Images/index.png" alt=""/>
|
||
<img src="https://wgdashboard-resources.tor1.cdn.digitaloceanspaces.com/Documentation%20Images/new-configuration.png" alt="" />
|
||
<img src="https://wgdashboard-resources.tor1.cdn.digitaloceanspaces.com/Documentation%20Images/settings.png" alt="" />
|
||
<img src="https://wgdashboard-resources.tor1.cdn.digitaloceanspaces.com/Documentation%20Images/light-dark.png" alt="" />
|
||
<img src="https://wgdashboard-resources.tor1.cdn.digitaloceanspaces.com/Documentation%20Images/configuration.png" alt=""/>
|
||
<img src="https://wgdashboard-resources.tor1.cdn.digitaloceanspaces.com/Documentation%20Images/add-peers.png" alt="" />
|
||
<img src="https://wgdashboard-resources.tor1.cdn.digitaloceanspaces.com/Documentation%20Images/ping.png" alt=""/>
|
||
<img src="https://wgdashboard-resources.tor1.cdn.digitaloceanspaces.com/Documentation%20Images/traceroute.png" alt=""/> |