Codex Proxy RS

OpenAI 兼容的 ChatGPT / Codex 多账号代理网关

概览

Codex Proxy RS 是一个单进程网关：

• Rust/Axum 后端提供 Responses 兼容代理、管理端 API、SQLite 持久化和静态前端托管。
• Vue 管理端负责账号导入、API Key、用量统计、请求记录、运行参数、模型映射和系统更新。
• 运行数据默认写入仓库 .runtime/；Docker 部署也使用这套宿主机目录挂载。

环境

• Rust 1.95
• Node 24 或兼容版本，pnpm 11（只在开发前端或构建镜像时需要）
• Docker / Docker Compose（部署或验证镜像时需要）

本地运行

本地直接运行后端时，配置文件由 CPR_CONFIG_FILE 指定；未指定时读取当前工作目录下的 config.yaml。

cp deploy/config.example.yaml .runtime/config.yaml

如果直接用本地二进制而不是 Docker，确保 .runtime/config.yaml 里的路径是宿主机路径：

database:
  url: 'sqlite://.runtime/data/codex-proxy-rs.sqlite'

logging:
  directory: .runtime/logs

admin:
  default_password: '<set-a-long-random-password>'

启动：

mkdir -p .runtime/data .runtime/logs
CPR_CONFIG_FILE=.runtime/config.yaml cargo run --manifest-path backend/Cargo.toml

服务默认监听 0.0.0.0:8080。本机访问通常使用 http://127.0.0.1:8080。

Docker 部署

Compose 默认把宿主机 .runtime 映射进容器：

• .runtime/config.yaml -> /app/config.yaml
• .runtime/data -> /app/data
• .runtime/logs -> /app/logs

初始化配置：

mkdir -p .runtime/data .runtime/logs
cp deploy/config.example.yaml .runtime/config.yaml
# 编辑 .runtime/config.yaml，设置 admin.default_password

Docker 配置文件里路径保持容器路径：

database:
  url: 'sqlite:///app/data/codex-proxy-rs.sqlite'

logging:
  directory: /app/logs

构建并启动：

docker compose -f deploy/docker-compose.yml build
docker compose -f deploy/docker-compose.yml up -d

默认只绑定宿主机 127.0.0.1:8080。如需覆盖路径：

CPR_CONFIG_FILE=/path/to/config.yaml \
CPR_DATA_DIR=/path/to/data \
CPR_LOG_DIR=/path/to/logs \
docker compose -f deploy/docker-compose.yml up -d

API

客户端 API Key 在管理端创建。OpenAI 兼容接口通过 Authorization: Bearer <key> 鉴权。

端点	说明
POST /v1/responses	OpenAI Responses 兼容接口
POST /v1/responses/review	Review 模型请求入口
POST /v1/responses/compact	Compact 请求入口
GET /v1/models	模型列表
GET /v1/models/{id}	模型详情
GET /v1/models/{id}/info	模型运行信息
GET /v1/models/catalog	管理端可见模型目录
/api/admin/*	管理端 API

示例：

curl http://127.0.0.1:8080/v1/responses \
  -H 'Authorization: Bearer <your-api-key>' \
  -H 'Content-Type: application/json' \
  -d '{"model":"gpt-5.5","input":"Say hello","stream":true}'

管理端

生产环境前端由后端直接托管，不需要单独 Node 服务。开发前端时：

pnpm --dir frontend install
pnpm --dir frontend dev

生产构建：

pnpm --dir frontend build
CPR_CONFIG_FILE=.runtime/config.yaml cargo run --manifest-path backend/Cargo.toml

管理端功能：

• 账号导入、OAuth 授权、连接测试、quota 刷新、token 刷新。
• 客户端 API Key 管理。
• Dashboard、请求记录、Token 用量、模型用量和账号额度。
• 运行参数、模型别名、账号选择策略。
• 版本检查、在线更新、更新日志、重启和回滚。

配置与运行数据

配置文件只承载启动必需项。账号、API Key、模型映射、账号选择策略和多数运行参数由管理端写入 SQLite。

.runtime 约定：

.runtime/config.yaml                # 本地或 Docker 启动配置，路径按运行环境写
.runtime/data/codex-proxy-rs.sqlite # SQLite 数据库
.runtime/data/installation_id       # 上游 installation id
.runtime/data/update-state.json     # 在线更新状态
.runtime/data/update.lock           # 在线更新锁
.runtime/logs/                      # 日志

发布与更新

当前版本记录在 release/version.yaml，发布平台记录在 release/platforms.yaml。

发布命令：

release/publish 1.0.4

该命令会更新版本文件、生成版本提交、创建 v<version> tag 并推送。GitHub Actions 随后构建 Release 归档和 GHCR 多平台镜像。

在线更新由主服务处理，管理端调用 /api/admin/system/*：

• 查询 GitHub Release。
• 下载当前平台对应的归档和 checksums.txt。
• 校验 checksum 后替换二进制和 web/dist。
• 重启时，Docker 模式依赖 restart: unless-stopped 拉起新容器进程；非 Docker 模式会先安排新进程延迟启动，再关闭当前进程。

项目结构

backend/       Rust/Axum 后端、SQLite migration、集成测试
frontend/      Vue 3 管理端
deploy/        Dockerfile、Compose、部署配置模板
docs/          架构和维护文档
release/       版本、平台和发布脚本
skills/        项目本地 Codex skill

开发检查

cargo fmt --manifest-path backend/Cargo.toml --check
cargo clippy --manifest-path backend/Cargo.toml --all-targets --all-features --locked -- -D warnings
cargo test --manifest-path backend/Cargo.toml --test main --locked
pnpm --dir frontend build
docker compose -f deploy/docker-compose.yml config

License

MIT