From b2d4a7e833f9f57bcca613d010f05fba1df38741 Mon Sep 17 00:00:00 2001 From: Zyy Date: Sun, 20 Sep 2026 11:13:39 +0800 Subject: [PATCH] docs(readme): simplify punctuation and community guidance Co-authored-by: Codex --- README.md | 41 ++++++++++++++++++++--------------------- 1 file changed, 20 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 012e21b72..7300fe895 100644 --- a/README.md +++ b/README.md @@ -17,13 +17,13 @@ > [!NOTE] -> 本项目提供 Responses API，不支持 `/v1/chat/completions`。接入前请确认客户端支持 Responses 协议。 +> 本项目提供 Responses API，不支持 `/v1/chat/completions`，接入前请确认客户端支持 Responses 协议 ## 快速预览 -无需部署，打开 [快速预览服务](https://codex-proxy-rs.ainz.cc) 即可体验管理端的系统概览、账号分组、代理管理与用量统计。 +无需部署，打开 [快速预览服务](https://codex-proxy-rs.ainz.cc) 即可体验管理端的系统概览、账号分组、代理管理与用量统计 -| 登录信息 | 值 | +| 登录信息 | 默认值 | | --- | --- | | 地址 | | | 登录身份 | 管理员 | @@ -31,17 +31,17 @@ | 密码 | `039c18de2aeac46d23ead7766bb07bbbe3747233c66a128e` | 预览服务运行已发布版本，展示的账号、代理与使用记录均为模拟数据，每天北京时间 `00:00` 自动生成当天数据。 -这是公开共享的功能预览环境，不提供真实模型调用；请勿导入真实账号、密钥或其他敏感信息。 +这是公开共享的功能预览环境，不提供真实模型调用；请勿导入真实账号、密钥或其他敏感信息 ## 快速开始 使用 Docker Compose 部署版本固定的发布镜像，同时启动 PostgreSQL 和 Redis。 以下命令适用于 Linux amd64/arm64，需要 Docker Engine、Docker Compose Plugin、curl 和 OpenSSL。已有部署请先看 -[升级说明](deploy/README.md#镜像升级与源码构建)，不要覆盖原配置。 +[升级说明](deploy/README.md#镜像升级与源码构建)，不要覆盖原配置 ### 一键安装 -请确保当前用户能访问 Docker，并可通过 `sudo` 或 root 设置目录权限。 +请确保当前用户能访问 Docker，并可通过 `sudo` 或 root 设置目录权限 ```bash curl -fsSL https://raw.githubusercontent.com/zyycn/codex-proxy-rs/main/deploy/install.sh -o install.sh && bash install.sh @@ -49,7 +49,7 @@ curl -fsSL https://raw.githubusercontent.com/zyycn/codex-proxy-rs/main/deploy/in [安装脚本](deploy/install.sh) 默认安装到当前目录下的 `codex-proxy-rs/`，下载同一正式 Release 的部署文件， 自动生成密码、设置目录权限并启动服务。完成后会显示访问地址和管理员密码，请保存密码，再按下方步骤 -[添加账号与客户端密钥](#添加账号与客户端密钥)。 +[添加账号与客户端密钥](#添加账号与客户端密钥) 可在执行 `bash install.sh` 时传入环境变量： @@ -66,33 +66,33 @@ INSTALL_DIR="$HOME/services/codex-proxy-rs" bash install.sh ``` 重复运行时请使用同一安装目录。检测到 `deploy/config.yaml` 后，脚本保留现有配置和部署文件， -忽略传入的管理员密码，也不执行版本升级。 +忽略传入的管理员密码，也不执行版本升级 ### 手动安装 -自行下载部署文件、配置密码和启动服务的完整步骤见 [部署文档](deploy/README.md#手动安装)。 +自行下载部署文件、配置密码和启动服务的完整步骤见 [部署文档](deploy/README.md#手动安装) ### 登录管理端 部署完成后，打开 `http://127.0.0.1:8080`，使用 `admin@cpr.local` 和管理员密码登录。 API Key 持有者可在同一登录页切换登录身份，进入 `/key-usage` 查看自己的用量、趋势、请求日志、额度与健康时间线；不能访问管理员页面。 -页面右上角的「密钥配置」支持复制 Codex 配置文件和导入 CCSwitch。 +页面右上角的「密钥配置」支持复制 Codex 配置文件和导入 CCSwitch -默认地址只能在服务器本机访问。从其他设备使用时，需要配置 -[HTTPS 反向代理](deploy/README.md#公网访问)。 +默认地址只能在服务器本机访问，从其他设备使用时，需要配置 +[HTTPS 反向代理](deploy/README.md#公网访问) ### 添加账号与客户端密钥 -1. 在「账号」中添加账号，完成授权或导入。 -2. 按需建立账号分组，再创建客户端密钥并选择可用分组。**不选分组表示可使用全部账号**。 -3. 打开密钥的「使用密钥」，复制客户端配置。 +1. 在「账号」中添加账号，完成授权或导入 +2. 按需建立账号分组，再创建客户端密钥并选择可用分组，**不选分组表示可使用全部账号** +3. 打开密钥的「使用密钥」，复制客户端配置 ## 客户端接入 **Codex CLI / 桌面端**：在「使用密钥」中按操作系统复制配置，或通过 CCSwitch 导入。 -合并到客户端配置后重启 Codex。完整步骤、生图配置与排障见[客户端配置](deploy/README.md#客户端配置)。 +合并到客户端配置后重启 Codex。完整步骤、生图配置与排障见[客户端配置](deploy/README.md#客户端配置) -**其他 Responses API 客户端**：填写以下信息。 +**其他 Responses API 客户端**：填写以下信息： | 配置 | 值 | | --- | --- | @@ -123,11 +123,10 @@ curl http://127.0.0.1:8080/v1/models \ [使用问答](https://github.com/zyycn/codex-proxy-rs/discussions/categories/使用问答)、 [想法讨论](https://github.com/zyycn/codex-proxy-rs/discussions/categories/想法讨论)、 [实验反馈](https://github.com/zyycn/codex-proxy-rs/discussions/categories/实验反馈)与 -[经验分享](https://github.com/zyycn/codex-proxy-rs/discussions/categories/经验分享)。 -明确的 Bug 或功能需求请使用 [Issue 模板](https://github.com/zyycn/codex-proxy-rs/issues/new/choose)，无需先发讨论。 +[经验分享](https://github.com/zyycn/codex-proxy-rs/discussions/categories/经验分享) -感谢 [LINUX DO](https://linux.do) 社区提供开放、友善的技术交流平台。 +感谢 [LINUX DO](https://linux.do) 社区提供开放、友善的技术交流平台 ## 许可证 -本项目基于 [Apache License 2.0](LICENSE) 开源。 +本项目基于 [Apache License 2.0](LICENSE) 开源