From 8fd4ce7e11a6bc6b6f170ec6987764a3d1aca97a Mon Sep 17 00:00:00 2001 From: aDragon0707 Date: Sun, 31 May 2026 00:03:00 +0800 Subject: [PATCH] docs: clarify hybrid login relay mode --- README.md | 15 +++++++++++++++ README_EN.md | 15 +++++++++++++++ 2 files changed, 30 insertions(+) diff --git a/README.md b/README.md index a4bf16ec..0f1c29c3 100644 --- a/README.md +++ b/README.md @@ -193,6 +193,21 @@ Codex++ 启动后会解锁插件入口，并在会话列表悬停时显示删除 中转注入适合已经在 Codex/ChatGPT 中完成官方账号登录，同时希望把模型请求转到自定义兼容 API 的场景。 +这种混合模式的边界是： + +- 官方 ChatGPT/Codex 登录态继续负责 Codex App 的账号能力和插件入口。 +- 中转配置只接管模型请求使用的 Base URL、Key 和模型名称。 +- 兼容 API 供应商不需要固定为某一家；只要上游协议和 Codex 配置匹配即可。 +- 清除 API 模式后应能回到官方登录态，继续使用官方账号和插件。 + +应用中转注入前建议先做一次最小检查： + +1. 先确认 Codex 已检测到 ChatGPT 登录状态，插件入口可用。 +2. 确认自定义 Base URL 可访问，并且支持所选上游协议（例如 Responses 兼容接口）。 +3. 用目标 Key 做一次最小认证测试，例如模型列表或很短的消息请求。 +4. 只记录 Key 是否存在和认证结果，不要把真实 Key 写入日志、截图或 issue。 +5. 确认 `~/.codex/config.toml` 已有备份，便于清除 API 模式后回滚。 + 在管理工具的“中转注入”页面： 1. 确认已经检测到 ChatGPT 登录状态。 diff --git a/README_EN.md b/README_EN.md index ee141954..ae9bccaf 100644 --- a/README_EN.md +++ b/README_EN.md @@ -129,6 +129,21 @@ The Windows installer creates desktop and Start Menu shortcuts. The macOS DMG in Relay injection is for users who are already logged in with an official ChatGPT account in Codex/ChatGPT and want model requests to go through a custom compatible API. +The boundary of this hybrid mode is: + +- The official ChatGPT/Codex login state still owns Codex App account features and the plugin entry. +- The relay profile only controls the Base URL, key, and model names used for model requests. +- The compatible API provider is not tied to any specific vendor; it only needs to match the selected upstream protocol and Codex configuration. +- Clearing API mode should return Codex to the official login mode so the official account and plugins keep working. + +Before applying relay injection, run a minimal preflight: + +1. Make sure Codex has detected the ChatGPT login state and the plugin entry is available. +2. Confirm the custom Base URL is reachable and supports the selected upstream protocol, such as a Responses-compatible endpoint. +3. Test the target key with the smallest useful auth probe, such as a model-list request or a short message request. +4. Only record whether the key exists and whether auth passed. Do not paste real keys into logs, screenshots, or issues. +5. Make sure `~/.codex/config.toml` has a backup so clearing API mode can safely roll back. + In the manager's Relay Injection page: 1. Make sure ChatGPT login status is detected.