Document Fleet control center across README and core docs.

Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
dekun
2026-07-30 13:07:25 +08:00
parent d46eaf43ab
commit e7529e9dc4
5 changed files with 204 additions and 87 deletions
+117 -38
View File
@@ -1,34 +1,33 @@
# 中控(Fleet Control)使用说明
中控与策略机在**同一仓库**独立进程部署。中控跑在本地服务器,**不访问交易所**;只通过专用 API Token 读状态、启停、远程更新与免密登录策略
中控与策略机在**同一仓库**`eth_hedge_sim`),**独立进程**部署。中控通常跑在**本地局域网服务器**,**不访问交易所**;只通过专用 API Token 对多台策略机做:状态监控、启停、远程更新代码、免密进入策略
建议策略机与中控使用**同一 git 版本**(同 `main` / 同 tag),避免 `/api/fleet/*` 接口漂移。
## 架构一览
---
| 组件 | 端口 | PM2 名 | 目录 |
|------|------|--------|------|
| 策略机 | 5155 | `eth-hedge-api` | `backend/` + `frontend/` |
| 中控 | 5160 | `eth-hedge-control` | `control/backend` + `control/frontend` |
## 1. 架构
## 策略机:启用中控 Token
```text
本地中控 (5160) 云端策略机 × N (5155)
┌─────────────────┐ ┌──────────────────┐
│ control 前端/后端 │──X-Fleet-Token──│ eth-hedge-api │
│ 不连交易所 │──SSH 无需主路径──│ OKX/币安交易密钥 │
└─────────────────┘ └──────────────────┘
```
1. 部署含本功能的策略机代码(`deploy_remote.py` / 现有一键更新)。
2. 登录策略机 → **系统设置 → 登录账户 → 中控 API Token**
3. 粘贴中控生成的 Token 并保存(存哈希,不可回看明文)。
| 组件 | 端口 | PM2 名 | 代码目录 | 配置 |
|------|------|--------|----------|------|
| 策略机 | 5155 | `eth-hedge-api` | `backend/` + `frontend/` | 仓库根 `.env` |
| 中控 | 5160 | `eth-hedge-control` | `control/backend` + `control/frontend` | 仓库根 `.env.control` |
策略机 Fleet 接口(请求头 `X-Fleet-Token`):
中控浏览器**不直连**策略机 API(避免跨域与密钥进前端);一律由中控后端代理。
- `GET /api/fleet/status`
- `POST /api/fleet/start` / `pause`
- `POST /api/fleet/update`(本机跑 `deploy/lib/update.sh`
- `POST /api/fleet/issue-login`(签发一次性免密登录票)
---
免密登录兑换:`POST /api/auth/fleet-exchange` `{ "ticket": "..." }`,或打开 `/fleet-login?ticket=...`
## 2. 一键部署(manage.sh
## 中控:本地安装与一键部署
在目标机执行(与策略机同一安装命令入口):
目标机 Ubuntu 22.04
```bash
curl -fsSL https://git.bz121.com/dekun/eth_hedge_sim/raw/branch/main/deploy/manage.sh | bash
@@ -36,29 +35,109 @@ curl -fsSL https://git.bz121.com/dekun/eth_hedge_sim/raw/branch/main/deploy/mana
交互菜单:
1. **一键部署策略机** — 端口 5155 / `eth-hedge-api`
2. **一键部署中控机** — 端口 5160 / `eth-hedge-control`(自动补全 `.env.control`,已有值不覆盖)
3. 一键卸载
4. 更新策略机
5. 更新中控机
| 选项 | 作用 |
|------|------|
| 1) 一键部署策略机 | 克隆/构建,启动 `eth-hedge-api` :5155 |
| 2) 一键部署中控机 | 构建中控,启动 `eth-hedge-control` :5160;自动补全 `.env.control`**已有非空值不覆盖** |
| 3) 一键卸载 | 卸载策略相关(按现有 uninstall 逻辑) |
| 4) 更新策略机 | `git pull` + 构建 + reload 策略机 |
| 5) 更新中控机 | `control/deploy/update.sh` |
| 0) 退出 | — |
中控默认账号:`admin` / `admin123`;在中控 **系统设置** 可改用户名密码。
也可本机已安装后:
## 配对步骤
```bash
bash /opt/eth_hedge_sim/deploy/manage.sh
# 或仅更新中控
bash /opt/eth_hedge_sim/control/deploy/update.sh
# 开发机 SSH 触发中控(可选)
# CONTROL_HOST=... CONTROL_PASS=... python scripts/deploy_control.py
```
1. 中控 **系统设置** → 添加策略机(名称 + 公网 Base URL,如 `https://dc.hyf2.cc`)。
2.**生成 Token** → 复制明文(只显示一次)。
3. 登录该策略机 → 保存同一 Token。
4. 回到中控 **监控区**:应显示在线与 Token 已配对。
---
## 监控区操作
## 3. 中控登录与系统设置
- **启动 / 停止**:经 Token 调策略机 `/api/fleet/start|pause`LIVE 门禁仍在策略机侧)。
- **登录策略机**:中控代签一次性 ticket,新标签打开策略机并免密进入 `/plan`
- **更新代码 / 勾选更新**:中控调 `/api/fleet/update`,策略机本机 git pull + 构建 + reload**不会**自动 start 策略。
### 3.1 默认账号
## 安全注意
- 首次:`admin` / `admin123`(一键部署写入 `.env.control`,已有值不覆盖)。
- **改密后**:登录页与设置页**不再显示**默认账号提示。
- 登录框**不预填用户名**,并关闭浏览器自动填充。
- Fleet Token 可启停、更新、签发登录票,泄露后立即在两边轮换(中控重新生成 + 策略机覆盖保存)。
- 登录票约 60 秒、一次性;长期 Token 不会出现在浏览器地址栏。
- 中控建议仅内网访问;勿把 `.env.control` 与 Token 明文提交到 git。
### 3.2 系统设置(三个 Tab
1. **中控登录账户**
- 修改用户名/密码(改后旧会话作废)。
- **本地局域网免登录**:开关;开启后,从私网 IP(如 `192.168.x` / `10.x` / `172.1631.x` / 本机)访问可自动进入监控区,无需输密码。
2. **添加策略机** — 名称 + 公网 Base URL(如 `https://dc.hyf2.cc`)。
3. **策略机列表** — 生成/轮换 Token、删除。
### 3.3 `.env.control` 常用项
见仓库 [`.env.control.example`](../.env.control.example)
| 变量 | 说明 |
|------|------|
| `CONTROL_AUTH_USERNAME` / `PASSWORD` | 中控登录 |
| `CONTROL_AUTH_SECRET` | Token 加密与签名密钥(部署自动填默认值,有值不覆盖) |
| `CONTROL_LAN_AUTH_BYPASS` | `1`=局域网免登录,`0`=关闭 |
| `CONTROL_POLL_INTERVAL_SEC` | 监控轮询间隔 |
**勿提交** `.env.control` 到 git。
---
## 4. 策略机配对(API Token
1. 中控 **策略机列表****生成 Token**(明文只显示一次,中控侧加密保存)。
2. 登录该策略机 → **系统设置 → 登录账户 → 中控 API Token** → 粘贴保存(策略机存哈希)。
3. 中控监控区显示「已配对」;若 Token 不一致则「配对失败」并提示重新生成保存。
### 策略机 Fleet 接口(头:`X-Fleet-Token`,也可 `Authorization: Fleet <token>`
| 方法 | 路径 | 作用 |
|------|------|------|
| GET | `/api/fleet/status` | 状态摘要 + 持仓/策略详情 |
| POST | `/api/fleet/start` | 启动策略(LIVE 仍过策略机门禁) |
| POST | `/api/fleet/pause` | 停止/暂停 |
| POST | `/api/fleet/update` | 本机 `deploy/lib/update.sh`reload,不自动 start |
| POST | `/api/fleet/issue-login` | 签发一次性免密登录票 |
免密进策略页:中控拿到 ticket 后打开
`https://<策略机>/fleet-login?ticket=...`
`POST /api/auth/fleet-exchange` 兑换普通会话 → `/plan`
票约 **60 秒、一次性**;长期 Token **不进**浏览器地址栏。
---
## 5. 监控区
- **卡片**:在线/离线、SIM/LIVE、阶段、轮次、行情、Token 状态。
- **运行中**:卡片绿色;底部按钮显示「运行中」且不可点启动。
- **点击卡片**:放大弹层 — 策略详情 + 持仓腿表;**净浮盈 / 浮盈** 正绿负红加粗。
- **登录策略机**:免密新标签打开策略页。
- **更新代码 / 勾选更新**:**二次确认**后执行;会 reload 进程,**不会**自动 start。
中控**不做**:改策略参数、代开平仓、资金划转、直连交易所。
---
## 6. 安全边界
- 中控无交易所 API Key;交易密钥只在各策略机 `.env`
- Fleet Token 权限含启停/更新/签发登录票 → 泄露后两边立即轮换。
- 局域网免登录仅私网 IP;勿对公网暴露中控端口。
- 策略机 LIVE 启停仍走本机 `live_ready()` 等门禁,中控不能绕过。
---
## 7. 相关文档与入口
| 文档 | 内容 |
|------|------|
| 本文 | 中控安装、配对、监控、安全 |
| [更新说明](./更新说明.md) | 发版变更记录 |
| [代码结构](./代码结构.md) | 仓库目录(含 `control/` |
| [README](../README.md) | 总览与部署入口 |
产品文档索引(README「文档」一节)含本页链接。