WGDashboard/README.md

41 lines
2.5 KiB
Markdown
Raw Normal View History

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!
<hr>
2021-04-12 23:18:57 -04:00
<p align="center">
2024-08-15 00:49:21 -04:00
<img alt="WGDashboard" src="./src/static/img/logo.png" width="128">
2021-04-12 23:18:57 -04:00
</p>
<h1 align="center">WGDashboard</h1>
2021-04-12 22:28:30 -04:00
2022-01-08 15:26:17 -05:00
2021-04-07 12:15:45 -04:00
<p align="center">
2024-08-15 00:53:23 -04:00
<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">
2024-08-15 00:56:28 -04:00
</p>
<p align="center">
2024-08-15 00:53:38 -04:00
<img src="https://forthebadge.com/images/badges/built-with-love.svg">
2021-04-07 12:15:45 -04:00
</p>
<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>
2022-02-27 15:50:55 -05:00
<a href="https://hits.seeyoufarm.com"><img src="https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2Fdonaldzou%2FWGDashboard&count_bg=%2379C83D&title_bg=%23555555&icon=github.svg&icon_color=%23E7E7E7&title=Visitor&edge_flat=false"/></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
2024-09-25 18:01:05 +08:00
<hr>
## [Official Documentation ➡️](https://donaldzou.github.io/WGDashboard-Documentation/)
> [!NOTE]
> To better manage documentation for this project. I've moved it to its own [repo](https://github.com/donaldzou/WGDashboard-Documentation). I will keep updating over there and leave this README only with important information.
- [💡 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)
- [🪜 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/)