部署教程

准备工作

开始部署前，请确保具备以下条件。

• 服务器要求：>= 2 核 CPU、4 GB 内存，并开放 80/443 端口。
• 必备工具：Docker 24+、Docker Compose、Git 与 Node.js 环境。
• 域名与证书：准备可访问的域名，建议配置 Let’s Encrypt 证书。

部署流程

推荐使用 Docker Compose 完成快速部署。

1. 克隆仓库：git clone 仓库并进入部署目录。
2. 配置变量：复制 env 示例，填充数据库、存储等参数。
3. 启动服务：运行 docker compose up -d 并检查日志确认启动。

环境变量配置

详细配置说明，确保所有服务正常运行。

安全配置最佳实践

生产环境必须进行的安全加固措施。

• JWT 密钥配置：修改 packages/server/src/config/config.default.ts 中的 jwtConfig.secretOrPrivateKey，使用复杂随机字符串替换默认的 'apiflow'。
• MongoDB 安全：设置强密码，开启认证，限制网络访问，定期更新密码。建议密码包含大小写字母、数字和特殊字符。
• 文件上传限制：配置文件大小限制（默认 5MB）和允许的文件类型，定期清理过期文件，设置正确的目录权限。
• HTTPS 配置：使用 Let's Encrypt 免费证书或购买商业证书，配置 nginx SSL，启用 HSTS 和安全响应头。

数据备份与恢复

定期备份数据以防止数据丢失。

1. MongoDB 备份：docker exec apiflow-mongo mongodump --username=admin --password=your_password --authenticationDatabase=admin --out=/backup
2. 文件备份：备份 /data/apiflow_upload 目录和 Docker volumes（mongo_data、server_logs）。
3. 定时备份：使用 cron 定时任务每天凌晨执行备份脚本，保留最近 7 天备份，异地存储备份文件。

日志与监控

及时发现和解决问题。

• 查看日志：docker logs -f apiflow-server 查看实时日志，日志文件位于 server_logs volume，支持按日期轮转。
• 健康检查：访问 http://your-domain/api/health 检查服务状态，返回 {"status":"ok"} 表示正常。
• 资源监控：使用 docker stats 查看容器资源使用情况，建议配置 Prometheus + Grafana 进行可视化监控和告警。

运维与更新

保障服务稳定的关键操作。

• 备份策略：定期导出数据库与对象存储中的文件。
• 升级流程：先拉取最新镜像，验证 staging 后再滚动更新生产。
• 监控报警：对请求量、响应时间与资源占用设置阈值告警。

常见排障

遇到问题时可以先对照以下提示。