README_EN.md
Rama main · réplica de lectura del repositorio original.
<div align="center">
<img src="./frontend/public/favicon.svg" alt="Ping Monitor" width="120" />
<h1>Ping Monitor</h1>
<p>A self-hosted host connectivity monitoring system</p>
<p>Automated ICMP ping checks · latency & packet-loss dashboards · geo-map visualization · multi-channel alerts</p>
<p>
<img src="https://img.shields.io/badge/Python-3.11-3776AB?style=for-the-badge&logo=python&logoColor=white" alt="Python 3.11" />
<img src="https://img.shields.io/badge/FastAPI-0.104-009688?style=for-the-badge&logo=fastapi&logoColor=white" alt="FastAPI" />
<img src="https://img.shields.io/badge/Vue-3-4FC08D?style=for-the-badge&logo=vuedotjs&logoColor=white" alt="Vue 3" />
<img src="https://img.shields.io/badge/Element_Plus-409EFF?style=for-the-badge&logo=element&logoColor=white" alt="Element Plus" />
<img src="https://img.shields.io/badge/ECharts-AA344D?style=for-the-badge&logo=apacheecharts&logoColor=white" alt="ECharts" />
</p>
<p>
<img src="https://img.shields.io/badge/MySQL-8.4-4479A1?style=flat-square&logo=mysql&logoColor=white" alt="MySQL 8.4" />
<img src="https://img.shields.io/badge/Redis-7-DC382D?style=flat-square&logo=redis&logoColor=white" alt="Redis 7" />
<img src="https://img.shields.io/badge/Docker-amd64%20%7C%20arm64-2496ED?style=flat-square&logo=docker&logoColor=white" alt="Docker amd64 arm64" />
</p>
<p>
<a href="README.md">简体中文</a>
·
<b>English</b>
</p>
<p>
<a href="https://ping.774966.xyz"><b>🚀 Live Demo</b></a>
·
<a href="#quick-start">Quick Start</a>
·
<a href="#features">Features</a>
·
<a href="#documentation">Documentation</a>
</p>
<p>
<a href="https://github.com/JunWan666/ping-monitor/stargazers"><img src="https://img.shields.io/github/stars/JunWan666/ping-monitor?style=flat-square&color=ffb547&logo=github" alt="Stars" /></a>
<a href="https://hub.docker.com/r/tannic666/ping-monitor"><img src="https://img.shields.io/docker/pulls/tannic666/ping-monitor?style=flat-square&logo=docker&logoColor=white" alt="Docker Pulls" /></a>
<img src="https://img.shields.io/badge/License-Apache--2.0-2EA44F?style=flat-square" alt="License" />
</p>
</div>
---
<sub>Visualization dashboard · node distribution, real-time latency, region coloring, fly-line links, latency leaderboard and live alerts</sub>
## Screenshots
| Admin Dashboard | Host Management |
|:---:|:---:|
|  |  |
| Statistics Board | Alert Records |
|:---:|:---:|
|  |  |
## Features
| Module | Description |
|---|---|
| 🎯 **Host Monitoring** | Single / batch host monitoring with live online status, latency and packet loss. Enable/disable, ping now, streaming ping |
| 📊 **Statistics Board** | `1h / 1d / 3d / 7d / 15d / 30d` views with latency and packet-loss trend charts |
| 🗺️ **Visualization Dashboard** | China / world map, region coloring, node fly-lines, monitoring center, fullscreen, public visitor toggle |
| 🌏 **Geo Location** | Automatic domain→IP resolution, multi-source IP geolocation (ip-api / ipwho.is / ip2location …), auto-complete of missing locations |
| 🔔 **Alerts** | ServerChan, DingTalk robot, Webhook, scheduled reports; trigger on state change or sustained anomaly |
| 🛠️ **Admin Console** | Fuzzy search, status filters, pagination, import/export, system logs, database backup & restore |
| 🐳 **Easy Deployment** | Local run / `docker compose` / multi-arch Docker Hub image (`amd64` + `arm64`) |
## Quick Start
### Option 1 · Docker Compose (MySQL + Redis)
```bash
git clone https://github.com/JunWan666/ping-monitor.git
cd ping-monitor/docker
docker compose up -d
```
Open `http://localhost:8000` — the first visit guides you through creating an admin account.
### Option 2 · Single container (SQLite, lightweight)
```bash
docker run -d --name ping-monitor \
-p 8000:8000 \
-v $PWD/data:/app/data \
-e DISABLE_NOTIFICATIONS=true \
tannic666/ping-monitor:v1.7.0
```
### Option 3 · Local development
```bash
# Backend
cd backend && pip install -r requirements.txt && python main.py
# Frontend (new terminal)
cd frontend && npm install && npm run dev
```
## Why Ping Monitor?
| Capability | Ping Monitor | Uptime Kuma | Gatus |
|---|:---:|:---:|:---:|
| ICMP ping latency / packet-loss focus | ✅ | Partial | Partial |
| Visualization dashboard (map + fly-lines) | ✅ | ❌ | ❌ |
| Automatic IP geolocation | ✅ | ❌ | ❌ |
| Host import / export | ✅ | Partial | ❌ |
| Chinese UI built-in | ✅ | i18n | i18n |
| Deployment | Docker / bare metal | Docker | Docker |
## Tech Stack
**Backend** · FastAPI · SQLAlchemy · APScheduler · ping3 · Redis (optional) · MySQL / SQLite
**Frontend** · Vue 3 · Vue Router · Element Plus · ECharts · Vite
**Deploy** · Multi-stage Docker build · Nginx
## Documentation
Full documentation is currently in Chinese — see the [Chinese README](README.md):
- [Deployment on Docker + Debian 11](docs/DEPLOYMENT_DOCKER_DEBIAN11.md)
- [MySQL + Redis deployment](docs/DEPLOYMENT_MYSQL_REDIS.md)
- [Environment variables](README.md#环境变量) · [API overview](README.md#api-概览)
## License
[Apache-2.0](LICENSE)
---
<div align="center">
**If this project helps you, please consider giving it a ⭐ Star — it really helps!**
[](https://star-history.com/#JunWan666/ping-monitor&Date)
</div>