128e7998e8
* feat(plugin): add the complete plugin development and management workflow Introduce the isolated plugin runtime, manifest v2 SDK, middleware and host capabilities, installation and configuration management, and cpr-plugin packaging CLI. Separate shared UI and examples into companion repositories. Consolidate plugin persistence, enforce stable key ordering, and release superseded private state atomically. Align documentation, dependency ownership and release integration. Co-authored-by: Codex <noreply@openai.com> * chore(deps): bump debian from `8820086` to `3783cc0` in /deploy Bumps debian from `8820086` to `3783cc0`. --- updated-dependencies: - dependency-name: debian dependency-version: bookworm-slim dependency-type: direct:production ... Signed-off-by: dependabot[bot] <support@github.com> --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: Zyy <zyycn@users.noreply.github.com> Co-authored-by: Codex <noreply@openai.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Note
本项目提供 Responses API，不支持
/v1/chat/completions，接入前请确认客户端支持 Responses 协议
功能
| 场景 | 能力 |
|---|---|
| 客户端接入 | Responses HTTP / SSE / WebSocket、Images、模型目录与 standalone Search |
| 多账号与路由 | OpenAI、xAI 及插件 Provider，账号分组、模型范围、出站代理与安全重试 |
| 使用与管理 | 管理端、Key 自助用量页、费用限额、请求记录与错误诊断 |
| 插件扩展 | 制品访问域确认、自动默认配置，中间件、管理页面和其他声明能力 |
| 运维 | 单副本部署，PostgreSQL / Redis、S3/R2 备份与同一大版本内在线更新 |
快速预览
无需部署，打开 快速预览服务 即可体验管理端的系统概览、账号分组、代理管理与用量统计
| 登录信息 | 默认值 |
|---|---|
| 地址 | https://codex-proxy-rs.ainz.cc |
| 登录身份 | 管理员 |
| 账号 | admin@cpr.local |
| 密码 | 039c18de2aeac46d23ead7766bb07bbbe3747233c66a128e |
预览服务运行已发布版本，展示的账号、代理与使用记录均为模拟数据，每天北京时间 00:00 自动生成当天数据。
这是公开共享的功能预览环境，不提供真实模型调用；请勿导入真实账号、密钥或其他敏感信息
快速开始
使用 Docker Compose 部署版本固定的发布镜像，同时启动 PostgreSQL 和 Redis。 以下命令适用于 Linux amd64/arm64，需要 Docker Engine、Docker Compose Plugin、curl 和 OpenSSL。已有部署请先看 升级说明，不要覆盖原配置
一键安装
请确保当前用户能访问 Docker，并可通过 sudo 或 root 设置目录权限
curl -fsSL https://raw.githubusercontent.com/zyycn/codex-proxy-rs/main/deploy/install.sh -o install.sh && bash install.sh
安装脚本 默认安装到当前目录下的 codex-proxy-rs/，下载同一正式 Release 的部署文件，
自动生成密码、设置目录权限并启动服务。完成后会显示访问地址和管理员密码，请保存密码，再按下方步骤
添加账号与客户端密钥
可在执行 bash install.sh 时传入环境变量：
| 变量 | 用途 | 默认值 |
|---|---|---|
INSTALL_DIR |
安装目录，建议使用绝对路径 | 当前目录下的 codex-proxy-rs/ |
CPR_RELEASE_TAG |
指定发布标签 | 最新正式版本 |
ADMIN_PASSWORD |
管理员初始密码，至少 12 位，不能包含 $，不能使用常见弱口令 |
随机生成 |
例如，自定义安装目录：
INSTALL_DIR="$HOME/services/codex-proxy-rs" bash install.sh
重复运行时请使用同一安装目录。检测到 deploy/config.yaml 后，脚本保留现有配置和部署文件，
忽略传入的管理员密码，也不执行版本升级
手动安装
自行下载部署文件、配置密码和启动服务的完整步骤见 部署文档
登录管理端
部署完成后，打开 http://127.0.0.1:8080，使用 admin@cpr.local 和管理员密码登录。
API Key 持有者可在同一登录页切换登录身份，进入 /key-usage 查看自己的用量、趋势、请求日志、额度与健康时间线；不能访问管理员页面。
页面右上角的「密钥配置」支持复制 Codex 配置文件和导入 CCSwitch，导入时同时启用当前 Key 的日／周额度查询，默认刷新间隔为 30 分钟
默认地址只能在服务器本机访问，从其他设备使用时，需要配置 HTTPS 反向代理
添加账号与客户端密钥
- 在「账号」中添加账号，完成授权或导入
- 按需建立账号分组，再创建客户端密钥并选择可用分组，不选分组表示可使用全部账号
- 打开密钥的「使用密钥」，复制客户端配置
客户端接入
Codex CLI / 桌面端：在「使用密钥」中按操作系统复制配置，或通过 CCSwitch 导入。 合并到客户端配置后重启 Codex。完整步骤、生图配置与排障见客户端配置
其他 Responses API 客户端：填写以下信息：
| 配置 | 值 |
|---|---|
| Base URL | http://127.0.0.1:8080/v1；远程接入使用服务器的 HTTPS 地址 |
| API Key | 管理端创建的客户端密钥 |
查询该密钥可见的模型目录：
curl http://127.0.0.1:8080/v1/models \
-H 'Authorization: Bearer <client-api-key>'
文档
| 任务 | 文档 |
|---|---|
| 部署与使用 | 部署、备份与恢复 · 客户端接入与生图 |
| 接口集成 | API 参考 · 模型定价 |
| 使用插件 | 安装、配置与使用 |
| 开发插件 | SDK 与合同 · 打包工具 |
| 开发宿主 | 贡献与验证 · 系统架构 · 管理端主题 · 数据库迁移 |
社区
欢迎到 Discussions 讨论区交流： 使用问答、 想法讨论、 实验反馈与 经验分享
感谢 LINUX DO 社区提供开放、友善的技术交流平台
许可证
本项目基于 Apache License 2.0 开源