# crypto_okx_hub 使用说明

**仓库:** [https://git.bz121.com/dekun/crypto_okx_hub.git](https://git.bz121.com/dekun/crypto_okx_hub.git)

OKX **期权多机中控**：在一个入口查看多台期权客户端的持仓总览，并在中控内打开客户端操作。

部署见 **[部署文档.md](./部署文档.md)**；架构见 **[设计文档.md](./设计文档.md)**。

---

## 1. 关联仓库（必读）

| 仓库 | 角色 | 地址 |
|------|------|------|
| **本仓库 crypto_okx_hub** | 中控：登录、实例登记、多机总览、内嵌/新标签打开 | [https://git.bz121.com/dekun/crypto_okx_hub.git](https://git.bz121.com/dekun/crypto_okx_hub.git) |
| **crypto_okx** | 期权客户端（执行机）：密钥、开平仓、模拟盘、持仓与提醒 | [https://git.bz121.com/dekun/crypto_okx.git](https://git.bz121.com/dekun/crypto_okx.git) |

- 每个策略 / 账户部署一台 **crypto_okx**，挂 **公网域名**。
- **中控只部署一次**（Ubuntu + PM2），在后台登记各客户端公网 URL 与 Bridge Token。
- **交易所 API 密钥只在客户端**；中控不存、不代下单。

---

## 2. 第一期能做什么

| 功能 | 说明 |
|------|------|
| 数据统计 | 多机 KPI 对比 + 余额曲线(不含权利金/浮盈);窗口可切换 |
| 多机持仓总览 | 按客户端卡片展示在线状态、sim/live、浮盈、持仓摘要 |
| 内嵌打开 | 在中控工作台 iframe 中打开该客户端 |
| 新标签打开 | 浏览器新标签直达同一客户端公网地址 |
| 实例管理 | 增删改：名称、公网 URL、Token、标签、是否启用 |
| 系统设置 | 修改中控登录账号；配置企业微信离线/故障告警 |

**不做：** 中控里直接下单、改客户端 env、保管 OKX 密钥。

---

## 3. 使用流程

1. 部署并登录中控（默认 **admin / admin123**）。
2. **系统设置** 中建议立刻修改密码；可配置中控企业微信 Webhook，用于客户端离线/故障推送。
3. **实例** 中添加客户端：名称、公网根地址、Bridge Token（与客户端 `HUB_BRIDGE_TOKEN` 一致）。
4. 打开 **总览**：确认各机在线。
5. 点 **打开** → 内嵌工作台；需要独立窗口时点 **新标签打开**。

---

## 4. 对客户端的要求

1. 公网 HTTPS（或浏览器与中控都能访问的 URL）。
2. 配置 `HUB_BRIDGE_TOKEN`，开放只读快照 API。
3. 允许被中控页面 iframe 嵌入（`/embed` + 短期 SSO）。

---

## 5. 网络说明

| 链路 | 谁连谁 | 要求 |
|------|--------|------|
| 总览拉数 | 中控服务器 → 客户端公网 URL | 中控出口能访问客户端 |
| 内嵌/新标签 | 操作员浏览器 → 客户端公网 URL | 操作员网络能打开客户端 |

---

## 6. 文档索引

| 文档 | 内容 |
|------|------|
| [设计文档.md](./设计文档.md) | 架构、数据表、API 约定 |
| [部署文档.md](./部署文档.md) | Ubuntu 一键部署 / PM2 |
| [deploy/README.md](./deploy/README.md) | 部署脚本说明 |
| [README.md](./README.md) | 仓库入口摘要 |