docs: 更新 README 文档至 v2.0
- 更新项目简介,添加新功能描述 - 更新技术栈(Vue 3, Playwright, Element Plus) - 更新项目结构,添加新模块说明 - 添加更新日志章节,记录 v2.0 主要变更: - 金山文档集成 - Vue 3 SPA 前端 - 用户自定义定时任务 - 安全防护系统 - 邮件通知系统 - 公告/反馈系统 - 截图引擎升级等 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
135
README.md
135
README.md
@@ -1,31 +1,48 @@
|
|||||||
# 知识管理平台自动化工具 - Docker部署版
|
# 知识管理平台自动化工具 - Docker部署版
|
||||||
|
|
||||||
这是一个基于 Docker 的知识管理平台自动化工具,支持多用户、定时任务、代理IP、VIP管理等功能。
|
这是一个基于 Docker 的知识管理平台自动化工具,支持多用户、定时任务、代理IP、VIP管理、金山文档集成等功能。
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 项目简介
|
## 项目简介
|
||||||
|
|
||||||
本项目是一个 **Docker 容器化应用**,使用 Flask + Requests + wkhtmltopdf + SQLite 构建,提供:
|
本项目是一个 **Docker 容器化应用**,使用 Flask + Vue 3 + Requests + Playwright + SQLite 构建,提供:
|
||||||
|
|
||||||
- 多用户注册登录系统
|
### 核心功能
|
||||||
- 自动化任务(HTTP 模拟)
|
- 多用户注册登录系统(支持邮箱绑定与验证)
|
||||||
- 定时任务调度
|
- 自动化浏览任务(纯 HTTP API 模拟,速度快)
|
||||||
- 截图管理
|
- 智能截图系统(基于 Playwright,支持线程池)
|
||||||
- VIP用户管理
|
- 用户自定义定时任务(支持随机延迟)
|
||||||
- 代理IP支持
|
- VIP 用户管理(账号数量限制、优先队列)
|
||||||
- 后台管理系统
|
|
||||||
|
### 集成功能
|
||||||
|
- **金山文档集成** - 自动上传截图到在线表格,支持姓名搜索匹配
|
||||||
|
- **邮件通知** - 任务完成通知、密码重置、邮箱验证
|
||||||
|
- **代理IP支持** - 动态代理API集成
|
||||||
|
|
||||||
|
### 安全功能
|
||||||
|
- 威胁检测引擎(JNDI/SQL注入/XSS/命令注入检测)
|
||||||
|
- IP/用户风险评分系统
|
||||||
|
- 自动黑名单机制
|
||||||
|
- 登录设备指纹追踪
|
||||||
|
|
||||||
|
### 管理功能
|
||||||
|
- 现代化 Vue 3 SPA 后台管理界面
|
||||||
|
- 公告系统(支持图片)
|
||||||
|
- Bug 反馈系统
|
||||||
|
- 任务日志与统计
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 技术栈
|
## 技术栈
|
||||||
|
|
||||||
- **后端**: Python 3.8+, Flask
|
- **后端**: Python 3.11+, Flask, Flask-SocketIO
|
||||||
- **数据库**: SQLite
|
- **前端**: Vue 3 + Vite + Element Plus (SPA)
|
||||||
- **自动化**: Requests + BeautifulSoup
|
- **数据库**: SQLite + 连接池
|
||||||
- **截图**: wkhtmltopdf / wkhtmltoimage
|
- **自动化**: Requests + BeautifulSoup (浏览), Playwright (截图)
|
||||||
|
- **截图**: Playwright (主) / wkhtmltoimage (备用)
|
||||||
- **容器化**: Docker + Docker Compose
|
- **容器化**: Docker + Docker Compose
|
||||||
- **前端**: HTML + JavaScript + Socket.IO
|
- **实时通信**: Socket.IO (WebSocket)
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -35,30 +52,46 @@
|
|||||||
zsglpt/
|
zsglpt/
|
||||||
├── app.py # 启动/装配入口
|
├── app.py # 启动/装配入口
|
||||||
├── routes/ # 路由层(Blueprint)
|
├── routes/ # 路由层(Blueprint)
|
||||||
|
│ ├── api_*.py # API 路由
|
||||||
|
│ ├── admin_api/ # 管理后台 API
|
||||||
|
│ └── pages.py # 页面路由
|
||||||
├── services/ # 业务服务层
|
├── services/ # 业务服务层
|
||||||
|
│ ├── tasks.py # 任务调度器
|
||||||
|
│ ├── screenshots.py # 截图服务
|
||||||
|
│ ├── kdocs_uploader.py # 金山文档上传服务
|
||||||
|
│ └── schedule_*.py # 定时任务相关
|
||||||
|
├── security/ # 安全防护模块
|
||||||
|
│ ├── threat_detector.py # 威胁检测引擎
|
||||||
|
│ ├── risk_scorer.py # 风险评分
|
||||||
|
│ ├── blacklist.py # 黑名单管理
|
||||||
|
│ └── middleware.py # 安全中间件
|
||||||
├── realtime/ # SocketIO 事件与推送
|
├── realtime/ # SocketIO 事件与推送
|
||||||
├── database.py # 数据库稳定门面(对外 API)
|
├── database.py # 数据库稳定门面(对外 API)
|
||||||
├── db/ # DB 分域实现 + schema/migrations
|
├── db/ # DB 分域实现 + schema/migrations
|
||||||
├── db_pool.py # 数据库连接池
|
├── db_pool.py # 数据库连接池
|
||||||
├── api_browser.py # Requests 自动化(主浏览流程)
|
├── api_browser.py # Requests 自动化(主浏览流程)
|
||||||
├── browser_pool_worker.py # 截图 WorkerPool
|
├── browser_pool_worker.py # Playwright 截图线程池
|
||||||
├── app_config.py # 配置管理
|
├── app_config.py # 配置管理
|
||||||
├── app_logger.py # 日志系统
|
├── app_logger.py # 日志系统
|
||||||
├── app_security.py # 安全模块
|
├── app_security.py # 安全工具函数
|
||||||
├── password_utils.py # 密码工具
|
├── password_utils.py # 密码哈希工具
|
||||||
├── crypto_utils.py # 加解密工具
|
├── crypto_utils.py # 加解密工具
|
||||||
├── email_service.py # 邮件服务
|
├── email_service.py # 邮件服务(SMTP)
|
||||||
├── requirements.txt # Python依赖
|
├── requirements.txt # Python依赖
|
||||||
├── requirements-dev.txt # 开发依赖(不进生产镜像)
|
├── requirements-dev.txt # 开发依赖(不进生产镜像)
|
||||||
├── pyproject.toml # ruff/black/pytest 配置
|
├── pyproject.toml # ruff/pytest 配置
|
||||||
├── Dockerfile # Docker镜像构建文件
|
├── Dockerfile # Docker镜像构建文件
|
||||||
├── docker-compose.yml # Docker编排文件
|
├── docker-compose.yml # Docker编排文件
|
||||||
├── templates/ # HTML模板(含 SPA fallback)
|
├── templates/ # HTML模板(SPA 入口)
|
||||||
├── app-frontend/ # 用户端前端源码(可选保留)
|
│ ├── app.html # 用户端 SPA 入口
|
||||||
├── admin-frontend/ # 后台前端源码(可选保留)
|
│ ├── admin.html # 管理端 SPA 入口
|
||||||
└── static/ # 前端构建产物(运行时使用)
|
│ └── email/ # 邮件模板
|
||||||
├── app/ # 用户端 SPA
|
├── app-frontend/ # 用户端 Vue 源码
|
||||||
└── admin/ # 后台 SPA
|
├── admin-frontend/ # 管理端 Vue 源码
|
||||||
|
├── static/ # 前端构建产物
|
||||||
|
│ ├── app/ # 用户端 SPA 资源
|
||||||
|
│ └── admin/ # 管理端 SPA 资源
|
||||||
|
└── tests/ # 测试用例
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
@@ -677,9 +710,9 @@ docker logs knowledge-automation-multiuser | grep "数据库"
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
**文档版本**: v1.0
|
**文档版本**: v2.0
|
||||||
**更新日期**: 2025-10-29
|
**更新日期**: 2026-01-08
|
||||||
**适用版本**: Docker多用户版
|
**适用版本**: Docker多用户版 + Vue SPA
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -710,3 +743,49 @@ docker logs -f knowledge-automation-multiuser
|
|||||||
```
|
```
|
||||||
|
|
||||||
完成!🎉
|
完成!🎉
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 更新日志
|
||||||
|
|
||||||
|
### v2.0 (2026-01-08)
|
||||||
|
|
||||||
|
#### 新功能
|
||||||
|
- **金山文档集成**: 自动上传截图到金山文档表格
|
||||||
|
- 支持姓名搜索匹配单元格
|
||||||
|
- 支持配置有效行范围
|
||||||
|
- 支持覆盖已有图片
|
||||||
|
- 离线状态监控与邮件通知
|
||||||
|
- **Vue 3 SPA 前端**: 用户端和管理端全面升级为现代化单页应用
|
||||||
|
- Element Plus UI 组件库
|
||||||
|
- 实时任务状态更新
|
||||||
|
- 响应式设计
|
||||||
|
- **用户自定义定时任务**: 用户可创建自己的定时任务
|
||||||
|
- 支持多时间段配置
|
||||||
|
- 支持随机延迟
|
||||||
|
- 支持选择指定账号
|
||||||
|
- **安全防护系统**:
|
||||||
|
- 威胁检测引擎(JNDI/SQL注入/XSS/命令注入)
|
||||||
|
- IP/用户风险评分
|
||||||
|
- 自动黑名单机制
|
||||||
|
- **邮件通知系统**:
|
||||||
|
- 任务完成通知
|
||||||
|
- 密码重置邮件
|
||||||
|
- 邮箱验证
|
||||||
|
- **公告系统**: 支持图片的系统公告
|
||||||
|
- **Bug反馈系统**: 用户可提交问题反馈
|
||||||
|
|
||||||
|
#### 优化
|
||||||
|
- **截图引擎升级**: 从 wkhtmltoimage 升级为 Playwright
|
||||||
|
- 更好的 JavaScript 渲染支持
|
||||||
|
- 线程池管理,按需启动
|
||||||
|
- **二次登录机制**: 刷新"上次登录时间"显示
|
||||||
|
- **API 预热**: 启动时预热连接,减少首次请求延迟
|
||||||
|
- **数据库连接池**: 提高并发性能
|
||||||
|
|
||||||
|
### v1.0 (2025-10-29)
|
||||||
|
- 初始版本
|
||||||
|
- 多用户系统
|
||||||
|
- 基础自动化任务
|
||||||
|
- 定时任务调度
|
||||||
|
- 代理IP支持
|
||||||
|
|||||||
Reference in New Issue
Block a user