OpenAgents

环境要求

• 已安装 Git，用于克隆 OpenAgents 仓库
• 已安装 Docker 与 Docker Compose（v2，使用 docker compose 命令）
• 如使用本地 GPU 推理，需安装 Nvidia Container Toolkit
• 自备 OpenAI 或兼容服务的 API Key（使用非官方 OpenAI 服务时需准备 API Base）
• 如使用 Kaggle 数据集，需准备 Kaggle 用户名与 Key

安装与启动步骤

1. 1克隆项目仓库

   把 OpenAgents 源码拉到本地，后续所有配置和构建都在项目根目录进行。

   git clone https://github.com/xlang-ai/OpenAgents.git
   cd OpenAgents

   复制

2. 2配置 Kaggle 凭据

   只有要用 Kaggle 数据集时才需要，打开根目录 Dockerfile 第 12 行，把 ENV 里的用户名和 Key 改成自己的真实信息。

3. 3配置后端访问地址

   如果不是在本机运行，需要打开 frontend/Dockerfile 第 15 行，把 NEXT_PUBLIC_BACKEND_ENDPOINT 改成后端服务可访问的 IP 地址。

4. 4构建镜像

   在项目根目录执行构建，会拉取并编译前后端等多个服务的镜像，耗时较久，请保证网络稳定。

   docker compose build

   复制

5. 5填写模型密钥

   编辑 docker-compose.yml 第 36 行：使用官方 OpenAI 只需填 OPENAI_API_KEY；使用 FastChat 等非官方服务还要修改 OPENAI_API_BASE。

6. 6启动全部服务

   后台启动所有容器，执行后等待服务初始化完成；如需 GPU 需先取消 docker-compose.yml 第 56-62 行注释。

   docker compose up -d

   复制

关键配置

如何确认成功

docker compose up -d 执行后无报错且容器持续运行，即视为服务已启动；若某服务异常可查看其容器日志排查。

常见问题

注意事项

• 所有文件修改都在项目根目录完成：Dockerfile、frontend/Dockerfile、docker-compose.yml，注意行号对应关系。
• 非本机运行时必须把前端后端地址改成外部可访问的 IP，否则前端无法连上后端。
• Docker 版本官方标注为开发中，功能与响应速度可能不稳定，追求稳定请使用源码部署方式。
• 涉及 API Key、Kaggle Key 等敏感信息不要提交到公开仓库。