guowenlong/github-copilot-api repository overview

⁠Copilot API Docker Hub 使用文档（中文）

⁠1. 镜像信息

• 镜像名：guowenlong/github-copilot-api
• 推荐标签：latest（或固定版本如 v1.2.2）
• 默认端口：4141

⁠2. 快速部署（推荐：Docker Compose）

⁠2.1 新建 docker-compose.yml

services:
  copilot-api:
    image: guowenlong/github-copilot-api:latest
    container_name: github-copilot-api
    restart: unless-stopped
    ports:
      - "4141:4141"
    environment:
      GH_TOKEN: "ghu_xxxxxxxxxxxxxxxxxxxx"
    volumes:
      - copilot-data:/root/.local/share/copilot-api
    healthcheck:
      test: ["CMD", "wget", "--spider", "-q", "http://localhost:4141/"]
      interval: 30s
      timeout: 5s
      start_period: 10s
      retries: 3

volumes:
  copilot-data:

⁠2.2 启动

docker compose up -d

⁠2.3 查看运行状态

docker compose ps
docker compose logs -f copilot-api

⁠3. 单容器部署（docker run）

docker volume create copilot-data

docker run -d \
  --name github-copilot-api \
  --restart unless-stopped \
  -p 4141:4141 \
  -e GH_TOKEN=ghu_xxxxxxxxxxxxxxxxxxxx \
  -v copilot-data:/root/.local/share/copilot-api \
  guowenlong/github-copilot-api:latest

⁠4. 部署后如何使用

服务启动后，地址为：

• 根地址：http://你的服务器IP:4141/
• 管理后台：http://你的服务器IP:4141/admin

⁠4.1 在客户端中配置反代地址

将你的客户端 Base URL 指向：

• OpenAI 风格：http://你的服务器IP:4141/v1

如需鉴权，在请求头带上任一方式：

• Authorization: Bearer <你的APIKey>
• X-Api-Key: <你的APIKey>

⁠4.2 管理后台首次使用

1. 打开 /admin
2. 默认管理员密码：admin123
3. 首次登录会要求修改管理员密码
4. 在“API 密钥”页面添加或删除 API Key

⁠5. 已支持的主要接口

⁠5.1 OpenAI 协议（常用）

• POST /v1/chat/completions
• POST /v1/responses
• POST /v1/embeddings
• GET /v1/models

⁠5.2 Anthropic / Claude 协议

• POST /v1/messages

⁠5.3 Provider 路由（高级）

• POST /:provider/v1/messages
• GET /:provider/v1/models

⁠6. 功能说明

⁠6.1 基础功能

• GitHub Copilot Token 代理转发
• OpenAI 兼容接口（chat/responses/embeddings/models）
• Claude messages 兼容接口
• 管理后台（密码登录、API Key 管理、模型查看、配额查看）
• 数据持久化（容器重启不丢配置）

⁠6.2 特殊功能

• 同时支持 OpenAI 与 Claude 两套协议路径
• 支持按 provider 路由到不同上游
• 支持通过管理后台动态维护 API Key
• 支持模型列表与能力信息查询（/v1/models）

⁠7. 常见问题（部署侧）

⁠Q1：启动后访问 401 未授权？

说明已启用 API Key 鉴权。请在请求头携带：

• Authorization: Bearer <API Key> 或
• X-Api-Key: <API Key>

⁠Q2：管理员后台进不去？

确认访问路径是 /admin，并检查容器日志：

docker compose logs -f copilot-api

⁠Q3：重建容器后配置丢失？

请确认挂载了持久化卷：

• /root/.local/share/copilot-api

⁠8. 安全建议

• 生产环境务必修改管理员默认密码
• 建议始终启用 API Key 鉴权
• 建议仅内网开放管理后台 /admin
• 建议配合反向代理（Nginx/Caddy）启用 HTTPS