Agent2API

环境要求

• 已安装 Docker 环境（支持 amd64 / arm64）
• 主机端口 3065 可用（或通过环境变量改端口）
• 准备一个本地目录挂载到容器 /data，持久化 SQLite 库、配置与日志
• 调用方客户端需支持自定义 base_url 的 OpenAI 兼容接口

安装与启动步骤

1. 1启动 Docker 容器

   一条命令拉取镜像并后台运行，映射 3065 端口，把数据目录挂到 /data，重启策略为 unless-stopped。

   docker run -d --name agent2api --restart unless-stopped -p 3065:3065 -v ./data:/data aimodcc/agent2api:latest

   复制

2. 2打开面板注册管理员

   浏览器访问主机 3065 端口，首次进入会引导注册管理员账号，按页面提示完成即可。

3. 3创建网关 API Key

   登录后在「网关 Key」页新建一把 Key 给客户端用；未创建 Key 前服务端会拒绝转发请求。

4. 4填写客户端 base_url

   在支持自定义 base_url 的 OpenAI 客户端里填网关地址加 /v1，api_key 用上一步创建的网关 Key。

5. 5改用 compose 部署

   已用 docker run 的跳过此步；compose 用户把以下内容存为 compose.yaml 后执行启动命令。

   services:
     agent2api:
       image: aimodcc/agent2api:latest
       container_name: agent2api
       restart: unless-stopped
       ports:
         - "3065:3065"
       volumes:
         - ./data:/data

   复制

6. 6从源码构建镜像

   克隆仓库后执行构建启动；镜像内只含网关与面板，不含 Rust 工具链。

   git clone https://github.com/aimod-cc/agent2api.git
   cd agent2api
   docker compose up -d --build

   复制

关键配置

如何确认成功

浏览器能打开 http://<主机>:3065 并完成管理员注册登录，用网关 Key 调 /v1 能正常返回模型响应。

常见问题

注意事项

• 默认未配置网关 Key 时拒绝转发请求，先在面板建 Key 再接入客户端。
• 容器内默认开启自助更新入口，如需完全手动升级可设 AGENT2API_SELF_UPDATE=0。
• README 中桌面版安装包为 Windows NSIS 格式，默认安装到 C:\Program Files\Agent2API，安装需管理员授权。