jack
ab1515dffb
- 中央：config/(prometheus,alertmanager,grafana)、apps/(tile-cache,topology-editor) - 边缘：config/(vmagent,blackbox,targets)、apps/(onvif-exporter) - env: TRAEFIK_PROVIDER、prometheus/env.example 详细说明 - 文档：README/doc 重构，EDGE_CACHE 合并到 EDGE_AGENT_CONFIG - targets.csv 更新流程说明，ARCHITECTURE 图收窄 Made-with: Cursor
64 lines
2.4 KiB
Markdown
64 lines
2.4 KiB
Markdown
# 文档索引
|
||
|
||
本目录为项目文档入口。**首次部署**按「部署顺序」先中央、后边缘；**修改配置**按需查阅对应文档。
|
||
|
||
---
|
||
|
||
## 部署顺序
|
||
|
||
| 步骤 | 操作 | 验证 |
|
||
|------|------|------|
|
||
| **1. 中央** | `cd central-server && cp env.example .env && bash deploy.sh` | Grafana http://localhost:3000、Prometheus http://localhost:9091 |
|
||
| **2. 边缘** | `cd edge-agent && bash deploy.sh`（本机同机加 `--local`） | 边缘 http://localhost:9092；Grafana 选 VictoriaMetrics 可见 `probe_success{job="network-ping"}` |
|
||
| **3. 可选** | 多用户、告警通知 | [USER_MANAGEMENT](USER_MANAGEMENT.md)、[ALERTING](ALERTING.md) |
|
||
|
||
**边缘跨机**：编辑 `edge-agent/.env` 中 `CENTRAL_SERVER_HOST` 为中央 IP，再 `bash deploy.sh`。
|
||
|
||
**targets.csv**：部署时自动从 targets.csv 生成 target-onvif.json、target-ping.json；修改 targets.csv 后需手动 `cd config && ./update-configs.sh`，vmagent 每 5 分钟自动重载。
|
||
|
||
---
|
||
|
||
## 文档列表
|
||
|
||
### 架构与数据流
|
||
|
||
| 文档 | 说明 |
|
||
|------|------|
|
||
| [ARCHITECTURE](ARCHITECTURE.md) | 容器关系图、数据流向、端口与依赖 |
|
||
|
||
### 中央节点
|
||
|
||
| 文档 | 说明 |
|
||
|------|------|
|
||
| [CENTRAL_SERVER_CONFIG](CENTRAL_SERVER_CONFIG.md) | 中央目录结构、服务端口、关键配置 |
|
||
| [../central-server/CONFIGURATION.md](../central-server/CONFIGURATION.md) | 中央环境变量（.env）说明 |
|
||
|
||
### 边缘节点
|
||
|
||
| 文档 | 说明 |
|
||
|------|------|
|
||
| [EDGE_AGENT_CONFIG](EDGE_AGENT_CONFIG.md) | 边缘目录结构、vmagent、blackbox、缓存机制 |
|
||
| [TARGETS_AND_MONITORING](TARGETS_AND_MONITORING.md) | targets.csv 格式、update-configs.sh、监控类型 |
|
||
|
||
### 告警与多用户
|
||
|
||
| 文档 | 说明 |
|
||
|------|------|
|
||
| [ALERTING](ALERTING.md) | 告警规则、Alertmanager 配置、通知渠道 |
|
||
| [USER_MANAGEMENT](USER_MANAGEMENT.md) | Grafana 多用户、组织与数据隔离 |
|
||
|
||
### 扩展功能
|
||
|
||
| 文档 | 说明 |
|
||
|------|------|
|
||
| [ONVIF_ALTERNATIVES](ONVIF_ALTERNATIVES.md) | ONVIF 摄像头监控方案（SNMP、Frigate、Blackbox、自建） |
|
||
| [TIANDITU_CONFIG](TIANDITU_CONFIG.md) | 天地图底图、Grafana Geomap、tile-cache |
|
||
|
||
### 运维
|
||
|
||
| 文档 | 说明 |
|
||
|------|------|
|
||
| [DEPLOYMENT_GUIDE](DEPLOYMENT_GUIDE.md) | 完整部署步骤、检查清单、常见问题 |
|
||
| [TROUBLESHOOTING](TROUBLESHOOTING.md) | 故障排查 |
|
||
| [BEST_PRACTICES](BEST_PRACTICES.md) | 最佳实践与生产建议 |
|