docs: 更新README部署说明并加入截图展示

This commit is contained in:
meoacgx committed 2025-12-19 22:03:14 +08:00
1 parent 985a00b923
commit 998dfcbca7
14 files changed
+122 -376

No files matched your search

+2
View File
@@ -7,4 +7,6 @@
- `docs/import.md`:压缩包批量导入账号结构(推荐)
- `docs/sync.md`:同步功能说明(同步什么/为什么要同步/自动同步)
- `docs/reverse-proxy.md`:反向代理示例(Nginx/Caddy,含 WebSocket)
- `docs/api.md`:接口速查(面向二次开发)
- `docs/database.md`:数据库与主要表结构(面向排障/扩展)
- `docs/advanced.md`:架构/配置项/环境变量/数据持久化位置等
+27
View File
@@ -0,0 +1,27 @@
# 接口速查(简版)
本页用于二次开发/排查问题时快速定位接口;完整行为以代码为准。
## 账号
- `GET /api/accounts`:获取账号列表
- `GET /api/accounts/{id}`:获取账号详情
- `POST /api/accounts/login`:手机号登录(发送验证码)
- `POST /api/accounts/verify`:提交验证码/2FA
- `POST /api/accounts/import`:导入账号(Session/压缩包)
- `POST /api/accounts/{id}/sync`:同步该账号“创建的频道/群组”
- `DELETE /api/accounts/{id}`:删除账号
## 频道/群组
- `GET /api/channels`:频道列表(筛选)
- `GET /api/channels/{id}`:频道详情
- `POST /api/channels/{id}/admins`:设置管理员
- `POST /api/channels/{id}/invite`:邀请用户/Bot
## 任务
- `GET /api/tasks`:任务列表
- `GET /api/tasks/{id}`:任务详情
- `POST /api/tasks/{id}/cancel`:取消
- `POST /api/tasks/{id}/retry`:重试
+27
View File
@@ -0,0 +1,27 @@
# 数据库说明(简版)
默认使用 SQLite(Docker 下持久化到 `./docker-data/telegram-panel.db`)。
本页只列出核心表的“概念与用途”,避免把 README 写得太劝退;具体字段以 `src/TelegramPanel.Data/Migrations/` 为准。
## 核心表
- `Accounts`:账号信息、分类、最近状态检测结果缓存等
- `Channels`:频道信息(主要是账号创建的频道)与分组/展示字段
- `Groups`:群组信息(主要是账号创建的群组)
- `Bots` / `BotChannels`:机器人与其管理的频道(如果启用机器人管理)
- `BatchTasks`:批量任务(pending/running/completed/failed)
- `TaskLogs`:任务日志(用于任务中心展示与排障)
## 常见问题
### Docker 下数据库/Session 在哪?
统一在 `./docker-data`:
- `./docker-data/telegram-panel.db`
- `./docker-data/sessions/`
### 为什么刷新页面任务还在跑?
批量任务由后台服务从数据库拉取并执行,前端只是提交任务与展示进度(见 `BatchTasks`/`TaskLogs`)。