Files
claude_dev 1803610f23 docs: 新增 NAS Docker 迭代部署方案
新增 docs/deployment/nas-deploy-plan.md,固化应用层/镜像层分离的部署流程(rsync + docker restart)。CLAUDE.md 参考文档段加入索引。
2026-07-04 20:13:03 +08:00

153 lines
3.3 KiB
Markdown

# 部署文档
本目录包含 Sanguo VeighNa 平台的部署相关文档。
## 文档列表
### Docker 部署
- **[docker-deployment.md](./docker-deployment.md)** - Docker 容器部署指南
- 前置要求和安装
- 快速开始步骤
- 配置说明
- 生产部署建议
### Synology NAS 部署
- **[synology-nas.md](./synology-nas.md)** - Synology NAS 专用部署指南
- NAS 环境配置
- 数据持久化设置
- 自动备份配置
- 故障排除
## 快速链接
### 部署方式对比
| 方式 | 适用场景 | 难度 | 推荐度 |
|------|----------|------|--------|
| Docker Compose | 开发/测试/小规模部署 | 简单 | ⭐⭐⭐⭐⭐ |
| Synology NAS | 家庭 NAS 部署 | 中等 | ⭐⭐⭐⭐ |
| Kubernetes | 大规模/高可用部署 | 复杂 | ⭐⭐⭐ |
### 部署检查清单
- [ ] 硬件要求满足(内存、存储)
- [ ] Docker/Docker Compose 已安装
- [ ] 网络端口已开放
- [ ] 数据目录已创建
- [ ] 环境变量已配置
- [ ] SSL 证书已准备(生产环境)
- [ ] 备份策略已制定
## 配置文件
### 环境变量示例
```env
# 数据目录
DATA_DIR=/volume1/docker/stock/sanguo_vnpy
# 端口配置
HTTP_PORT=8000
WS_PORT=8080
# 时区
TZ=Asia/Shanghai
# 日志级别
VNPY_LOG_LEVEL=INFO
# 安全配置
JWT_SECRET_KEY=your-secure-secret-key
```
### 目录结构
```
{DATA_DIR}/
├── data/ # 数据库和数据文件
├── logs/ # 运行日志
├── config/ # 配置文件
├── temp/ # 临时文件
├── redis/ # Redis 持久化
└── nginx/ # Nginx 相关
```
## 数据备份
### 重要提示
**所有重要数据都存储在配置的 DATA_DIR 中**,请确保:
1. 该目录有足够的存储空间
2. 定期备份该目录
3. 备份包含所有子目录
### 备份命令
```bash
# 创建备份
tar czf vnpy_backup_$(date +%Y%m%d).tar.gz {DATA_DIR}
# 恢复备份
tar xzf vnpy_backup_YYYYMMDD.tar.gz -C /
```
## 故障排除
### 常见问题
1. **容器无法启动**
- 检查端口占用: `netstat -tulpn | grep :8000`
- 查看日志: `docker-compose logs vnpy`
2. **数据丢失**
- 确保使用绑定挂载
- 检查 DATA_DIR 配置
3. **性能问题**
- 调整资源限制
- 增加 Worker 数量
## 相关文档
- [开发文档](../development.md)
- [运维文档](../operations/)
- [API 文档](../api/)
- [用户指南](../user_guide/)
---
## 部署历史
### Phase 1 后端部署 (2026-07-04)
**部署内容:**
- ✅ 修复 VeighNa 模块加载问题
- ✅ 修复循环导入问题
- ✅ 成交监控 API (4 个端点)
- ✅ 资金监控 API (3 个端点)
- ✅ 全局配置 API (2 个端点)
**部署文件:**
- `sanguo_web/api/__init__.py` - 注册新路由
- `sanguo_web/api/deps.py` - 修复循环导入
- `sanguo_web/services/main_service.py` - 添加 offset 和 gateway_name 字段
- `sanguo_web/api/routes/trades.py` - 成交监控路由
- `sanguo_web/api/routes/accounts.py` - 资金监控路由
- `sanguo_web/api/routes/settings.py` - 全局配置路由
- `run_web.py` - 添加 vnpy_v4.4.0 路径
**备份位置:** `~/.sanguo_projects/sanguo_vnpy_v2/backup_20260704_170319/`
**验证结果:**
- 总路由数:52
- Trades 路由:4 个
- Accounts 路由:3 个
- Settings 路由:2 个
---
**最后更新**: 2026-07-04