AIHelms Docs
部署
使用 Docker Compose 安装、验证、升级和备份 AIHelms。
部署前准备
| 项目 | 要求 |
|---|---|
| Docker | 20.10 或更高 |
| Docker Compose | v2,命令为 docker compose |
| 主机配置 | 最低 4 核 CPU、8 GB 内存 |
| 磁盘 | 为业务数据、日志、上传文件和备份预留空间 |
| 网络 | 准备用户端地址、管理后台地址和客户端 Endpoint |
生产环境还应准备固定域名或 IP、时间同步、HTTPS 证书、备份位置和访问控制策略。
下载安装
git clone https://github.com/beizhu-1209/AIHelms.git
cd AIHelms
cp .env.example .env
先编辑 .env,再启动:
docker compose pull
docker compose up -d
docker compose ps
首次启动需要拉取镜像并初始化数据,请等待服务进入 running 或 healthy 状态。
必须确认的配置
| 配置 | 要求 |
|---|---|
| 数据存储密码 | 使用随机强密码,不使用示例值 |
| 登录签名密钥 | 使用足够长的随机值并安全备份 |
| 超级管理员初始密码 | 部署前修改,首次登录后再次修改 |
| 加密密钥 | 首次设置后妥善保存,升级和恢复时必须沿用 |
| 服务域名或 IP | 填写用户和客户端实际可访问的地址 |
| 平台版本 | 生产环境固定到明确版本,不使用不确定标签 |
完整字段和示例值以当前版本随附的 .env.example 为准。环境密钥不要提交到代码仓库。
访问地址
默认部署通常提供:
| 地址 | 用途 |
|---|---|
http://<host> | 用户端 |
http://<host>/admin | 管理后台 |
http://<host>/api/docs | 管理 API 文档 |
| 管理员配置的 Endpoint | Claude Code、Codex、WorkBuddy 等客户端 |
如果服务器位于公网,建议只允许公司出口、VPN 或受控反向代理访问。启用 HTTPS 后,确认模型广场显示的 Endpoint 与客户端实际使用的地址一致。
首次登录
- 打开
http://<host>/admin。 - 用户名填写
admin。 - 使用部署配置中的超级管理员初始密码。
- 登录后立即修改密码。
- 打开 Dashboard,确认页面可以正常加载。
初始密码只用于第一次创建管理员。平台已有 admin 后,修改部署文件不会自动重置现有密码。
部署验证
先检查服务:
docker compose ps
docker compose logs --tail=100 aihelms
docker compose logs --tail=100 nginx
再完成页面检查:
- 管理后台可以登录。
- 用户端可以登录并显示“我的 AI 身份”。
- 管理 API 健康检查正常。
- 管理员可以创建一个测试用户。
- 完成供应商、凭证、模型和部署配置后,测试用户可以调用模型。
网页能打开不代表模型已经接入成功。模型必须在管理后台完成凭证测试和模型连通性测试。
备份
备份至少要包含:
- 业务数据库。
- 上传的 Skill、图片和导出文件。
.env及其中的加密密钥。- 当前平台版本和部署文件。
备份文件应加密保存,并定期在独立环境验证能否恢复。不要等升级失败后才第一次检查备份。
升级
- 记录当前平台版本。
- 完成数据库、文件和环境配置备份。
- 阅读目标版本的更新说明。
- 修改版本并拉取新镜像。
- 重新启动服务。
docker compose pull
docker compose up -d
docker compose ps
升级后检查:
- 管理员和普通用户登录。
- 供应商、凭证、模型和部署。
- AI 身份和资源授权。
- 模型真实调用。
- 调用记录、成本和审批。
不要在没有备份和回退方案的情况下跨多个版本升级。
常见问题
| 现象 | 检查项 |
|---|---|
| 管理后台打不开 | 服务状态、Web 端口、域名解析和防火墙 |
| 用户能登录但客户端连不上 | Endpoint 是否为客户端可访问地址,网络策略是否放行 |
| 重启后凭证失效 | 恢复时是否沿用了原加密密钥 |
| 调用记录没有立即出现 | 稍等后刷新,仍异常时检查后台任务状态 |
| Skill 检查一直失败 | 上传包、任务状态、超时设置和数据目录权限 |
| 服务反复重启 | 查看对应服务日志,核对环境配置和依赖服务状态 |