From 7f69e811765c15302bec4ae701548821ccd5ee18 Mon Sep 17 00:00:00 2001 From: Zyy Date: Tue, 8 Sep 2026 17:36:49 +0800 Subject: [PATCH] docs(readme): streamline project overview and client setup Condense the feature overview and client setup guidance, and link to detailed operational documentation for troubleshooting and maintenance. Validation: checked local Markdown links, anchors, shell syntax and diff whitespace. Co-authored-by: Codex --- README.md | 89 +++++++++++++++---------------------------------------- 1 file changed, 24 insertions(+), 65 deletions(-) diff --git a/README.md b/README.md index 44cf49a57..8f92e8830 100644 --- a/README.md +++ b/README.md @@ -5,27 +5,31 @@ # Codex Proxy RS -集中管理 OpenAI、xAI 账号，为 Codex 和兼容客户端提供统一的访问地址与密钥。 +面向 Codex 的自托管多账号 AI 网关。 [![CI](https://github.com/zyycn/codex-proxy-rs/actions/workflows/ci.yml/badge.svg)](https://github.com/zyycn/codex-proxy-rs/actions/workflows/ci.yml) [![Release](https://img.shields.io/github/v/release/zyycn/codex-proxy-rs?display_name=tag&sort=semver&style=flat-square)](https://github.com/zyycn/codex-proxy-rs/releases) [![GHCR](https://img.shields.io/badge/GHCR-codex--proxy--rs-2496ED?logo=docker&logoColor=white&style=flat-square)](https://github.com/zyycn/codex-proxy-rs/pkgs/container/codex-proxy-rs) -[![MIT](https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square)](https://opensource.org/license/mit) -[快速开始](#快速开始) · [客户端接入](#客户端接入) · [常见问题](#常见问题) · [部署说明](deploy/README.md) +[功能](#功能) · [快速开始](#快速开始) · [客户端接入](#客户端接入) · [文档](#文档) +将 OpenAI、xAI 账号接入同一个服务，通过网页管理账号、分配客户端密钥和查看使用情况。 +客户端使用统一的访问地址与代理密钥，上游账号凭据由服务端管理。 + ## 功能 -- 在网页中添加账号，查看额度、请求记录和费用，刷新或重新授权过期账号。 -- 用账号分组控制不同密钥可使用的账号，设置并发和请求频率。 -- 接入 Codex CLI、桌面端和支持 Responses API 的客户端。 -- 支持流式对话、WebSocket、图片生成与编辑、Codex 独立搜索。 -- 支持 S3/R2 数据库备份、同大版本在线更新和回滚。 +- **账号管理**：OAuth 授权、账号导入、凭据刷新与额度查看。 +- **访问控制**：通过账号分组分配密钥权限，设置并发和请求频率。 +- **客户端接入**：支持 Codex CLI、桌面端与 Responses API 客户端，提供 HTTP 流式响应和 WebSocket。 +- **请求诊断**：查看请求记录、用量、费用、延迟和错误详情。 +- **部署运维**：Docker Compose 部署、S3/R2 数据库备份、同大版本在线更新与回滚。 -支持 OpenAI、xAI 账号，但图片与独立搜索目前仅通过 OpenAI 提供。模型和功能是否可用取决于上游账号权限。 -**不支持 `/v1/chat/completions`**；仅支持该接口的客户端不能直接接入。 +图片生成、编辑和 Codex 独立搜索由 OpenAI 账号提供；模型与功能的可用性取决于上游账号权限。 + +> [!NOTE] +> 本项目提供 Responses API，不支持 `/v1/chat/completions`。接入前请确认客户端支持 Responses 协议。 ## 快速开始 @@ -85,76 +89,31 @@ curl -i http://127.0.0.1:8080/healthz 默认地址只能在服务器本机访问。从其他设备使用时，需要配置 [HTTPS 反向代理](deploy/README.md#公网访问)。 -### 3. 添加账号和密钥 +### 3. 添加账号与客户端密钥 -1. 在「账号」中添加 OpenAI 或 xAI 账号。OpenAI 支持 OAuth 授权、AT/RT 和账号 JSON；xAI 支持 OAuth 授权和账号 JSON。 -2. 按需创建账号分组，并把账号加入分组。 -3. 创建客户端密钥，选择可用分组。**不选分组表示可使用全部账号**。 -4. 点击该密钥的「使用密钥」，复制客户端配置。 - -只导入 AT 的账号不能自动续期。xAI 暂不支持用 API Key 导入上游账号。 +1. 在「账号」中添加 OpenAI 或 xAI 账号，完成授权或导入。 +2. 按需建立账号分组，再创建客户端密钥并选择可用分组。**不选分组表示可使用全部账号**。 +3. 打开密钥的「使用密钥」，复制客户端配置。 ## 客户端接入 -### Codex CLI 和桌面端 +**Codex CLI / 桌面端**：在「使用密钥」中按操作系统复制配置，或通过 CCSwitch 导入。 +合并到客户端配置后重启 Codex。完整步骤、生图配置与排障见[客户端配置](deploy/README.md#客户端配置)。 -在「使用密钥」中按系统复制 `config.toml` 和 `auth.json`，也可以通过 CCSwitch 导入。 -已有文件先备份，再合并配置并重启 Codex。客户端使用代理密钥，OpenAI 账号登录状态由服务端管理。 - -新配置已启用原生生图。可以直接提出需求，例如： - -> 帮我做一个咖啡店首页，生成一张咖啡主题配图并用到页面中。 - -是否调用生图由 Codex 根据任务决定，也可以明确要求生成图片。需要支持生图的客户端、模型和 OpenAI 账号； -普通对话可用不代表账号一定有生图额度。 - -完整配置和旧版配置迁移见 [客户端配置](deploy/README.md#客户端配置)。 - -### 其他客户端 - -选择支持 **Responses API** 的客户端，填写： +**其他 Responses API 客户端**：填写以下信息。 | 配置 | 值 | | --- | --- | -| Base URL | `http://127.0.0.1:8080/v1`，远程使用时换成服务器的 HTTPS 地址 | -| API Key | 管理端创建的 `sk_...` 密钥 | +| Base URL | `http://127.0.0.1:8080/v1`；远程接入使用服务器的 HTTPS 地址 | +| API Key | 管理端创建的 `sk_...` 客户端密钥 | -可先检查密钥是否能读取模型列表： +可用模型以该密钥查询到的模型列表为准： ```bash curl http://127.0.0.1:8080/v1/models \ -H 'Authorization: Bearer ' ``` -接口列表与请求示例见 [接口文档](docs/api.md)。 - -## 常见问题 - -### 仍然要求登录，或无法生成图片 - -重新从管理端复制配置，确认修改的是客户端实际读取的用户配置目录，然后完全退出并重启客户端。 -保留仅含代理密钥的 `auth.json` 不会使新配置失效。详细检查步骤见 -[登录与生图排查](deploy/README.md#登录与生图排查)。 - -### 没有可用账号或模型 - -检查账号是否启用、凭据是否过期、额度是否耗尽，以及密钥绑定的分组是否包含可用账号。 -「恢复账号」只清除本地错误状态，不能恢复上游权限或增加额度。 - -### 如何更新或查看日志 - -同一大版本内拉取发布镜像并重建应用容器： - -```bash -docker compose -f deploy/compose.yaml pull codex-proxy-rs -docker compose -f deploy/compose.yaml up -d --no-build codex-proxy-rs -docker compose -f deploy/compose.yaml logs --tail=100 -f codex-proxy-rs -``` - -> [!WARNING] -> 升级前先备份。跨大版本需使用新的数据目录重新部署，不支持直接沿用旧库在线升级。 -> `.runtime/` 包含数据库和运行数据，请勿删除；账号文件、密钥和日志也不要公开分享。 - ## 文档 - [客户端接入与生图](deploy/README.md#客户端配置)