91 lines
2.7 KiB
Markdown
91 lines
2.7 KiB
Markdown
# XUGOU - Lightweight Monitoring Platform Based on CloudFlare
|
|
|
|
<div align="center">
|
|
|
|
|
|
|
|
XUGOU is a lightweight system monitoring platform based on CloudFlare, providing system monitoring and status page functionality.
|
|
|
|
English | [简体中文](./README.md)
|
|
|
|
</div>
|
|
|
|
## 📅 Development Plan
|
|
|
|
Currently implemented features:
|
|
|
|
- ✅ System Monitoring - Client resource monitoring and data reporting
|
|
- ✅ HTTP Monitoring - API endpoint health detection and analysis
|
|
- ✅ Data Visualization - Real-time data display and historical trend analysis
|
|
- ✅ Status Page - Customizable service status page
|
|
- ✅ Alert Notifications - Anomaly event notifications through multiple channels (Email, Telegram, etc.)
|
|
- ❌ Mobile APP - Convenient monitoring status check on mobile devices
|
|
|
|
## ✨ Core Features
|
|
|
|
- 🖥️ **System Monitoring**
|
|
- Real-time monitoring of CPU, memory, disk, network and other system metrics
|
|
- Support for custom monitoring intervals
|
|
- Cross-platform support (agent written in Go, supporting all platforms where Go can compile)
|
|
|
|
- 🌐 **HTTP Monitoring**
|
|
- Support for HTTP/HTTPS endpoint monitoring
|
|
- Custom request methods, headers, and request bodies
|
|
- Response time, status code and content validation
|
|
|
|
- 📊 **Data Visualization**
|
|
- Real-time data chart display
|
|
- Custom dashboards
|
|
|
|
- 🌍 **Status Page**
|
|
- Customizable status page
|
|
- Support for multiple monitoring items
|
|
- Responsive design
|
|
|
|
## 🏗️ System Architecture
|
|
|
|
XUGOU adopts a modern system architecture, including the following components:
|
|
|
|
- **Agent**: Lightweight system monitoring client
|
|
- **Backend**: Backend service based on Cloudflare Workers
|
|
- **Frontend**: Modern frontend interface based on React + TypeScript
|
|
|
|
## 🚀 Quick Start
|
|
|
|
### Deployment Guide
|
|
|
|
Default username: admin Default password: admin123
|
|
|
|
[XUGOU wiki Deployment Guide](https://github.com/zaunist/xugou/wiki)
|
|
|
|
### Video Tutorial
|
|
|
|
Not yet available yet.
|
|
|
|
## FAQ
|
|
|
|
[XUGOU wiki FAQ](https://github.com/zaunist/xugou/wiki)
|
|
|
|
## ⭐ Support the Author
|
|
|
|
Support us in any way you can:
|
|
|
|
- Star the project and share it with your friends
|
|
- Support ongoing development through WeChat donations
|
|
|
|
<div align="center">
|
|
<img src="frontend/public/wechat-reward.png" alt="WeChat Reward Code" width="300">
|
|
</div>
|
|
|
|
## 🤝 Contribution
|
|
|
|
All forms of contributions are welcome, whether it's new features, bug fixes, or documentation improvements.
|
|
|
|
## 📄 License
|
|
|
|
This project is open-sourced under the MIT License. See the [LICENSE](./LICENSE) file for details.
|
|
|
|
## 🔥 Star History
|
|
|
|
[](https://www.star-history.com/#zaunist/xugou&Date)
|