WGDashboard/README.md

88 lines
5.6 KiB
Markdown
Raw Normal View History

2025-01-13 01:41:25 +08:00
> [!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!
2024-09-23 03:12:06 +08:00
> [!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!
2025-01-13 01:41:25 +08:00
2025-06-05 00:18:22 +08:00
2025-04-22 22:33:22 +08:00
![](https://wgdashboard-resources.tor1.cdn.digitaloceanspaces.com/Posters/Banner.png)
2025-01-13 01:41:25 +08:00
2024-08-23 09:24:18 +08:00
2021-04-12 23:18:57 -04:00
<p align="center">
2025-04-22 22:26:29 +08:00
<img alt="WGDashboard" src="https://wgdashboard-resources.tor1.cdn.digitaloceanspaces.com/Logos/Logo-2-Rounded-512x512.png" width="128">
2021-04-12 23:18:57 -04:00
</p>
2025-05-22 17:05:25 +08:00
<h1 align="center">
<a href="https://wgdashboard.dev">WGDashboard</a>
</h1>
2021-04-07 12:15:45 -04:00
<p align="center">
2025-05-21 13:08:00 +08:00
<img src="https://img.shields.io/badge/Made_With-Python-blue?style=for-the-badge&logo=python&logoColor=ffffff">
<img src="https://img.shields.io/badge/Made_With-Vue.js-42b883?style=for-the-badge&logo=vuedotjs&logoColor=ffffff">
<img src="https://img.shields.io/badge/License-Apache_License_2.0-D22128?style=for-the-badge&logo=apache&logoColor=ffffff">
2021-04-07 12:15:45 -04:00
</p>
2025-04-07 15:14:07 +08:00
2021-04-07 12:15:45 -04:00
<p align="center">
2021-04-07 12:19:23 -04:00
<a href="https://github.com/donaldzou/wireguard-dashboard/releases/latest"><img src="https://img.shields.io/github/v/release/donaldzou/wireguard-dashboard"></a>
2022-04-06 21:05:24 -04:00
<a href="https://wakatime.com/badge/github/donaldzou/WGDashboard"><img src="https://wakatime.com/badge/github/donaldzou/WGDashboard.svg" alt="wakatime"></a>
2025-04-06 05:32:15 +08:00
<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>
2024-12-28 01:26:47 +08:00
<img src="https://img.shields.io/docker/pulls/donaldzou/wgdashboard?logo=docker&label=Docker%20Image%20Pulls&labelColor=ffffff">
2021-04-07 12:15:45 -04:00
</p>
2025-04-07 15:14:07 +08:00
<p align="center"><b>This project is supported by</b></p>
<p align="center">
2025-04-07 17:41:12 +08:00
<a href="https://m.do.co/c/a84cb9aac585">
2025-04-07 15:14:07 +08:00
<img src="https://opensource.nyc3.cdn.digitaloceanspaces.com/attribution/assets/SVG/DO_Logo_horizontal_blue.svg" width="201px">
</a>
2021-04-07 12:15:45 -04:00
</p>
2024-09-25 18:01:05 +08:00
<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>
2024-08-16 23:32:16 -04:00
<p align="center"><b><i>This project is not affiliate to the official WireGuard Project</i></b></p>
2021-05-04 21:26:40 -04:00
2025-05-22 17:19:56 +08:00
<h3 align="center">Looking for help or want to chat about this project?</h4>
2024-11-03 14:41:21 +08:00
<p align="center">
2025-05-22 17:19:56 +08:00
You can reach out at
2024-11-03 14:41:21 +08:00
</p>
<p align="center">
2025-05-20 23:56:43 +08:00
<a align="center" href="https://discord.gg/72TwzjeuWm" target="_blank"><img src="https://img.shields.io/discord/1276818723637956628?labelColor=ffffff&style=for-the-badge&logo=discord&label=Discord"></a>
2025-05-22 17:19:56 +08:00
<a align="center" href="https://www.reddit.com/r/WGDashboard/" target="_blank"><img src="https://img.shields.io/badge/Reddit-r%2FWGDashboard-FF4500?style=for-the-badge&logo=reddit"></a>
<a align="center" href="https://app.element.io/#/room/#wgd:matrix.org" target="_blank"><img src="https://img.shields.io/badge/Matrix_Chatroom-%23WGD-000000?style=for-the-badge&logo=matrix"></a>
2024-12-15 21:37:45 +08:00
</p>
2025-05-20 23:55:34 +08:00
<h3 align="center">Want to support this project?</h4>
<p align="center">
You can support via <br>
</p>
<p align="center">
2025-05-20 23:56:43 +08:00
<a align="center" href="https://github.com/sponsors/donaldzou" target="_blank"><img src="https://img.shields.io/badge/GitHub%20Sponsor-2e9a40?style=for-the-badge&logo=github"></a>
<a align="center" href="https://buymeacoffee.com/donaldzou" target="_blank"><img src="https://img.shields.io/badge/Buy%20me%20a%20coffee-ffdd00?style=for-the-badge&logo=buymeacoffee&logoColor=000000"></a>
<a align="center" href="https://patreon.com/c/DonaldDonnyZou/membership" target="_blank"><img src="https://img.shields.io/badge/Patreon-000000?style=for-the-badge&logo=patreon&logoColor=ffffff"></a>
2025-05-20 23:55:34 +08:00
</p>
2024-11-03 14:41:21 +08:00
2025-05-20 23:55:34 +08:00
<p align="center">
2025-05-29 00:24:07 +08:00
<b>or, visit our merch store and support us by purchasing a merch for only $USD 17.00 (Including shipping worldwide & duties)</b>
2025-05-20 23:55:34 +08:00
</p>
<p align="center">
2025-05-20 23:56:43 +08:00
<a align="center" href="https://merch.wgdashboard.dev" target="_blank"><img src="https://img.shields.io/badge/Merch%20from%20WGDashboard-926183?style=for-the-badge"></a>
2025-05-20 23:55:34 +08:00
</p>
2025-04-22 22:34:09 +08:00
2025-04-24 19:13:34 +08:00
<hr>
2025-05-22 17:05:25 +08:00
<h4 align="center">
for more information, visit our
</h4>
<h1 align="center">
<a href="https://wgdashboard.dev">Official Website</a>
</h1>
2025-04-24 19:13:34 +08:00
2025-03-16 00:42:40 +08:00
# Screenshots
2025-04-22 22:23:11 +08:00
<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=""/>
2025-05-20 23:55:34 +08:00
<img src="https://wgdashboard-resources.tor1.cdn.digitaloceanspaces.com/Documentation%20Images/traceroute.png" alt=""/>