refactor: 模块化重构 v3.4.0
🎯 重构目标: - 将 3700+ 行单文件拆分为多个模块 - 清晰的职责分离,便于维护和扩展 📁 模块结构: - config.py: 配置常量和路径 - database.py: 数据库操作 - utils.py: 工具函数(日志、进程、cron等) - routes_cron.py: Cron管理API - routes_system.py: 系统监控API - routes_config.py: 配置管理API - routes_email.py: 邮件通知API - routes_project.py: 项目管理API - templates.py: HTML模板 - app.py: 主入口文件 ✨ 优势: - 易于维护:每个模块职责明确 - 易于扩展:新增功能只需添加对应模块 - 易于测试:模块独立,便于单元测试 - 易于理解:新人能快速上手 📝 更新 README.md,详细说明项目结构和API接口
This commit is contained in:
265
README.md
265
README.md
@@ -1,155 +1,182 @@
|
||||
# 项目服务管理面板 v3.0.0
|
||||
# 项目服务管理面板
|
||||
|
||||
统一管理所有 Web 服务项目,提供状态检测、启动/停止控制、日志查看、Docker 监控等功能。
|
||||
统一的 Web 服务项目管理平台,支持项目监控、系统资源监控、Cron 任务管理。
|
||||
|
||||
## 端口
|
||||
## 版本信息
|
||||
|
||||
- **服务端口**: 16022
|
||||
- **访问地址**: http://localhost:16022
|
||||
- **当前版本**: v3.4.0
|
||||
- **端口**: 16022
|
||||
- **更新日期**: 2026-06-01
|
||||
|
||||
## 功能
|
||||
## 功能特性
|
||||
|
||||
### 项目管理
|
||||
- 项目列表展示(状态、端口、版本)
|
||||
- 服务状态健康检测
|
||||
- 启动/停止/重启控制
|
||||
- 日志查看(实时滚动)
|
||||
- Git 仓库链接
|
||||
- 自定义链接入口
|
||||
- 新增外部服务
|
||||
### 1. 项目服务管理
|
||||
- 📊 项目状态实时监控
|
||||
- 🚀 一键启动/停止/重启服务
|
||||
- 🔗 自定义链接入口
|
||||
- 📝 项目配置管理
|
||||
- 🌐 外部服务监控
|
||||
|
||||
### Docker 监控(v3.0.0 新增)
|
||||
- **容器监控**:CPU、内存、网络 I/O、磁盘 I/O 使用情况
|
||||
- **容器控制**:启动、停止、重启容器
|
||||
- **容器日志**:实时查看容器日志
|
||||
- **镜像管理**:查看镜像列表、大小、悬空镜像
|
||||
- **系统信息**:Docker 版本、磁盘占用、运行状态统计
|
||||
- **资源清理**:一键清理未使用的容器、镜像、卷
|
||||
### 2. 系统资源监控
|
||||
- 💻 CPU 使用率 + 温度监控
|
||||
- 🎯 内存使用率
|
||||
- 💾 磁盘使用率
|
||||
- 📡 网络上传/下载速度
|
||||
- ⏱️ 实时监控模式
|
||||
- ⚠️ 预警阈值设置
|
||||
|
||||
### 系统资源监控
|
||||
- CPU、内存、磁盘使用率
|
||||
- 网络流量和实时网速
|
||||
- CPU 温度监控
|
||||
- 进程列表
|
||||
- 阈值告警(弹窗 + 桌面通知 + 邮件)
|
||||
### 3. Cron 任务管理
|
||||
- 📋 任务列表查看
|
||||
- ➕ 添加/编辑/删除任务
|
||||
- 🔄 启用/禁用切换
|
||||
- 📚 版本历史记录
|
||||
- 🔙 回退到历史版本
|
||||
- 🔗 从系统 crontab 同步
|
||||
|
||||
### Cron 管理
|
||||
- Cron 任务增删改查
|
||||
- 历史版本回退
|
||||
- 分类管理
|
||||
- 从系统同步
|
||||
### 4. 配置管理
|
||||
- 📤 导出完整配置(JSON)
|
||||
- 📥 导入配置文件
|
||||
- ⚙️ 统一配置文件管理
|
||||
- 💾 自动备份旧配置
|
||||
|
||||
## 启动方式 ⭐
|
||||
## 项目结构(模块化)
|
||||
|
||||
**重要:必须使用 `nohup + disown` 方式启动,脱离进程树!**
|
||||
|
||||
```bash
|
||||
cd ~/.openclaw/workspace-coder/works/project-panel
|
||||
nohup python3 app.py > logs/app.log 2>&1 & disown
|
||||
```
|
||||
project-panel/
|
||||
├── app_main.py # 主入口文件
|
||||
├── config.py # 配置常量
|
||||
├── database.py # 数据库操作
|
||||
├── utils.py # 工具函数
|
||||
├── routes_cron.py # Cron 管理 API
|
||||
├── routes_system.py # 系统监控 API
|
||||
├── routes_config.py # 配置管理 API
|
||||
├── routes_email.py # 邮件通知 API
|
||||
├── routes_project.py # 项目管理 API
|
||||
├── templates.py # HTML 模板
|
||||
├── projects.json # 项目配置文件
|
||||
├── alert_config.json # 预警和网页设置
|
||||
├── cron_manager.db # Cron 任务数据库
|
||||
└── logs/ # 日志目录
|
||||
```
|
||||
|
||||
### 为什么需要 disown?
|
||||
|
||||
如果通过 OpenClaw 的 exec 启动服务,当 OpenClaw 清理进程时(如超时、重启),会发送 SIGTERM 杀掉所有子进程。
|
||||
|
||||
使用 `nohup + disown` 可以:
|
||||
1. `nohup` - 让进程忽略 SIGHUP(终端关闭信号)
|
||||
2. `disown` - 从 shell 进程树中移除,避免被连带杀掉
|
||||
3. `> logs/app.log 2>&1` - 重定向输出到日志文件
|
||||
|
||||
### ❌ 错误方式
|
||||
|
||||
```bash
|
||||
# 不要用这种方式(会被 OpenClaw 杀掉)
|
||||
python3 app.py
|
||||
```
|
||||
|
||||
### ✅ 正确方式
|
||||
|
||||
```bash
|
||||
nohup python3 app.py > logs/app.log 2>&1 & disown
|
||||
```
|
||||
|
||||
## 项目配置
|
||||
|
||||
项目配置在 `projects.json` 中,每个项目包含:
|
||||
## 配置文件说明
|
||||
|
||||
### projects.json
|
||||
```json
|
||||
{
|
||||
"id": "project-id",
|
||||
"name": "项目名称",
|
||||
"ports": [19000],
|
||||
"directory": "works/project-dir",
|
||||
"start_cmd": "nohup python3 app.py > logs/app.log 2>&1 & disown",
|
||||
"health_url": "http://localhost:19000/api/health",
|
||||
"admin_url": "http://localhost:19000/admin",
|
||||
"git_repo": "http://192.168.2.8:12007/coder/project",
|
||||
"version": "v1.0.0"
|
||||
"server": {
|
||||
"name": "服务器名称",
|
||||
"description": "服务器描述"
|
||||
},
|
||||
"projects": [
|
||||
{
|
||||
"id": "项目ID",
|
||||
"name": "项目名称",
|
||||
"type": "web",
|
||||
"ports": [端口列表],
|
||||
"directory": "工作目录",
|
||||
"start_cmd": "启动命令",
|
||||
"stop_cmd": "停止命令",
|
||||
"health_url": "健康检查URL",
|
||||
"description": "项目描述"
|
||||
}
|
||||
],
|
||||
"external_services": [...]
|
||||
}
|
||||
```
|
||||
|
||||
## 端口规范
|
||||
|
||||
所有 Web 服务必须使用 **19000-19100** 端口范围:
|
||||
|
||||
| 端口 | 项目 |
|
||||
|------|------|
|
||||
| 19000 | PDF翻译助手 V2 |
|
||||
| 19001 | LLM Index RAG |
|
||||
| 19009 | 碎片信息记录 |
|
||||
| 19010 | ParamHub Python |
|
||||
| 19013 | 项目服务管理面板(本服务) |
|
||||
| 19014 | Xian Favor 收藏系统 |
|
||||
| 19020 | AI对话系统 |
|
||||
| 19007 | LLM Proxy |
|
||||
| 19011 | 产品参数爬取系统 |
|
||||
| 19004 | 技术论坛 |
|
||||
| 19015 | 多智能体竞标调度系统 |
|
||||
### alert_config.json
|
||||
```json
|
||||
{
|
||||
"thresholds": {
|
||||
"cpu": 80,
|
||||
"memory": 85,
|
||||
"disk": 90,
|
||||
"interval": 60
|
||||
},
|
||||
"web_settings": {
|
||||
"external_ip": "121.40.164.32",
|
||||
"refresh_interval": 30
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## API 接口
|
||||
|
||||
- `GET /api/projects` - 获取所有项目列表
|
||||
- `GET /api/project/:id` - 获取单个项目详情
|
||||
- `POST /api/project/:id/start` - 启动项目
|
||||
- `POST /api/project/:id/stop` - 停止项目
|
||||
- `POST /api/project/:id/restart` - 重启项目
|
||||
- `GET /api/project/:id/logs` - 获取项目日志
|
||||
### 项目管理
|
||||
- `GET /api/projects` - 获取项目列表
|
||||
- `POST /api/projects/<id>/start` - 启动项目
|
||||
- `POST /api/projects/<id>/stop` - 停止项目
|
||||
- `POST /api/projects/<id>/restart` - 重启项目
|
||||
- `POST /api/projects/add` - 添加项目
|
||||
|
||||
## 监控
|
||||
### 系统监控
|
||||
- `GET /api/system/stats` - 获取系统资源信息
|
||||
- `GET /api/system/processes` - 获取进程列表
|
||||
- `GET /api/system/docker` - 获取 Docker 容器状态
|
||||
|
||||
服务监控由 `service-monitor` 负责,每 20 分钟检查一次,发送邮件通知。
|
||||
### Cron 管理
|
||||
- `GET /api/cron/tasks` - 获取任务列表
|
||||
- `POST /api/cron/tasks` - 添加任务
|
||||
- `PUT /api/cron/tasks/<id>` - 更新任务
|
||||
- `DELETE /api/cron/tasks/<id>` - 删除任务
|
||||
- `POST /api/cron/tasks/<id>/toggle` - 启用/禁用
|
||||
- `POST /api/cron/sync` - 从系统同步
|
||||
|
||||
## 故障排查
|
||||
### 配置管理
|
||||
- `GET /api/config/export` - 导出配置
|
||||
- `POST /api/config/import` - 导入配置
|
||||
- `GET /api/web-settings` - 获取网页设置
|
||||
- `POST /api/web-settings` - 保存网页设置
|
||||
|
||||
### 服务频繁停止?
|
||||
### 预警配置
|
||||
- `GET /api/alerts` - 获取预警配置
|
||||
- `POST /api/alerts` - 保存预警配置
|
||||
|
||||
检查是否使用了正确的启动方式:
|
||||
1. 确认使用了 `nohup + disown`
|
||||
2. 确认日志目录存在:`mkdir -p logs/`
|
||||
3. 查看日志:`cat logs/app.log`
|
||||
## 使用方法
|
||||
|
||||
### OpenClaw 杀进程?
|
||||
### 启动服务
|
||||
```bash
|
||||
python3 app_main.py
|
||||
```
|
||||
|
||||
如果日志突然停止(约凌晨 01:10),可能是被 OpenClaw 清理进程杀掉了。
|
||||
### 访问面板
|
||||
打开浏览器访问:`http://localhost:16022/`
|
||||
|
||||
**证据:**
|
||||
- OpenClaw 日志:`[tools] exec failed: Command aborted by signal SIGTERM`
|
||||
- 服务日志最后记录时间:01:09 左右
|
||||
### 导出配置
|
||||
点击页面头部"导出配置"按钮,下载 JSON 配置文件
|
||||
|
||||
**解决:** 使用 `disown` 脱离进程树。
|
||||
### 导入配置
|
||||
点击"导入配置"按钮,上传配置文件即可应用
|
||||
|
||||
## Git 仓库
|
||||
## 依赖项
|
||||
|
||||
http://192.168.2.8:12007/coder/project-panel
|
||||
- Python 3.12+
|
||||
- Flask
|
||||
- psutil (系统监控)
|
||||
- croniter (Cron 表达式解析)
|
||||
|
||||
## 更新日志
|
||||
|
||||
### v1.0.1
|
||||
- 添加 README.md 文档
|
||||
- 记录正确的启动方式(nohup + disown)
|
||||
- 记录端口规范
|
||||
### v3.4.0 (2026-06-01)
|
||||
- 🎯 **模块化重构**: 将 3700+ 行单文件拆分为多个模块
|
||||
- 📁 **清晰结构**: config、database、utils、routes、templates 分离
|
||||
- 🔧 **易于维护**: 每个模块职责明确,便于扩展和维护
|
||||
|
||||
### v1.0.0
|
||||
- 项目服务管理面板
|
||||
- 状态检测、启动/停止控制
|
||||
- 日志查看
|
||||
### v3.3.5 (2026-06-01)
|
||||
- ✨ 统一配置文件管理
|
||||
- 📤 配置导入/导出功能
|
||||
- 🔄 Cron 任务同步优化(清空旧任务)
|
||||
- ⚙️ 网页设置持久化
|
||||
|
||||
### v3.3.4
|
||||
- 🌐 对外 IP 默认值调整
|
||||
- 🐛 Bug 修复
|
||||
|
||||
## 开发者
|
||||
|
||||
黄庄4号程序员 - hz4th_coder@tphai.com
|
||||
|
||||
## 许可证
|
||||
|
||||
内部使用项目
|
||||
Reference in New Issue
Block a user