107 lines
2.6 KiB
Markdown
107 lines
2.6 KiB
Markdown
# ///
|
|
# README.md
|
|
# 描述：WXAuto Center 项目说明
|
|
# 作者：User
|
|
# 创建日期：2026-04-06
|
|
# 更新日期：2026-04-07
|
|
# ///
|
|
|
|
# WXAuto Center
|
|
|
|
微信多节点中控系统 - 模块化、可扩展的微信管理平台。
|
|
|
|
## 功能特性
|
|
|
|
- **多节点管理** - 同时管理多个微信节点
|
|
- **消息发送** - 支持单发、群发、批量发送
|
|
- **插件系统** - 支持自定义插件扩展、表单化配置、通知功能
|
|
- **定时任务** - 支持 Cron 表达式的定时任务
|
|
- **Webhook 通知** - 支持 Bark、钉钉、企业微信等
|
|
- **外部接口** - 提供 RESTful API 供外部调用
|
|
- **监控告警** - 节点健康监控和告警
|
|
|
|
## 快速开始
|
|
|
|
### 1. 启动服务
|
|
|
|
```bash
|
|
docker compose up -d
|
|
```
|
|
|
|
### 2. 访问后台
|
|
|
|
打开浏览器访问 http://localhost:8080
|
|
|
|
### 3. 默认配置
|
|
|
|
- API Key: `your-external-api-key`
|
|
|
|
## 目录结构
|
|
|
|
```
|
|
wxauto_api/
|
|
├── api/ # API 路由
|
|
├── services/ # 业务服务（含插件通知服务）
|
|
├── plugins/ # 插件系统
|
|
│ ├── base.py # 插件基类
|
|
│ ├── plugin_config_schema.py # 表单化配置系统
|
|
│ └── advanced_sender_plugin.py # 高级多节点推送插件
|
|
├── static/ # 前端静态文件
|
|
└── doc/ # 开发文档
|
|
```
|
|
|
|
## 文档
|
|
|
|
- [API 文档](doc/wxauto_center/API.md)
|
|
- [插件开发指南](doc/wxauto_center/PLUGIN.md)
|
|
- [架构文档](doc/wxauto_center/ARCHITECTURE.md)
|
|
- [数据库文档](doc/wxauto_center/DATABASE.md)
|
|
|
|
## API 示例
|
|
|
|
### 发送消息
|
|
|
|
```bash
|
|
curl -X POST "http://localhost:8080/api/v1/messages/send" \
|
|
-H "X-API-Key: your-external-api-key" \
|
|
-H "Content-Type: application/json" \
|
|
-d '{"node_id": "wx1", "who": "文件传输助手", "msg": "Hello"}'
|
|
```
|
|
|
|
### 插件管理
|
|
|
|
```bash
|
|
# 获取所有插件
|
|
curl "http://localhost:8080/api/v1/plugins/" \
|
|
-H "X-API-Key: your-external-api-key"
|
|
|
|
# 获取插件表单Schema
|
|
curl "http://localhost:8080/api/v1/plugins/advanced_sender/schema" \
|
|
-H "X-API-Key: your-external-api-key"
|
|
|
|
# 获取插件日志
|
|
curl "http://localhost:8080/api/v1/plugins/advanced_sender/logs?lines=50" \
|
|
-H "X-API-Key: your-external-api-key"
|
|
```
|
|
|
|
### 配置告警通知
|
|
|
|
```bash
|
|
curl -X POST "http://localhost:8080/api/v1/webhook/" \
|
|
-H "X-API-Key: your-api-key" \
|
|
-H "Content-Type: application/json" \
|
|
-d '{
|
|
"name": "插件通知",
|
|
"url": "https://api.day.app/your-bark-key",
|
|
"format": "bark",
|
|
"event_types": ["plugin_notification"]
|
|
}'
|
|
```
|
|
|
|
## 技术栈
|
|
|
|
- **后端**: Python 3.11 + FastAPI
|
|
- **数据库**: PostgreSQL
|
|
- **缓存**: Redis
|
|
- **容器**: Docker
|