連線到閘道器
使用組織提供的閘道器 URL、模型別名以及憑證 或權杖解析器,將 Codex 連線到 LLM 閘道器。
檢查現有設定
新增任何設定前,先檢查管理員是否已經設定了 Codex。
- 對於 CLI,檢查所選設定檔並執行
codex doctor。啟動後, 使用/status確認當前模型和供應商。 - 對於 macOS 應用程式,檢查
~/.codex/config.toml或組織下發的託管 設定。 - 對於 Windows 應用程式,檢查
%USERPROFILE%\.codex\config.toml或組織下發的系統 設定。
如果預期的閘道器供應商和模型已啟用,請繼續 驗證連線。
取得閘道器連線資訊
安裝 Codex CLI 或組織核准的桌面 應用程式。要自行設定 Codex,請向閘道器團隊取得以下值:
- HTTPS 閘道器基礎 URL,包括其 API 路徑,例如
https://gateway.example.com/v1。 - 要使用的模型名稱和供應商 ID。
- 具有限定權限範圍的閘道器憑證及其環境變數,或已安裝的 權杖解析器及其設定。
- 所需的模型目錄檔案及其本機絕對路徑。
設定供應商
在 macOS 或 Linux 上,開啟位於 ~/.codex/config.toml 的 config.toml;在 Windows 上,開啟
%USERPROFILE%\.codex\config.toml。
將此範例合併到現有設定中,用管理員提供的值替換 URL 和模型。
不要重複定義已有的
鍵或表。此範例使用 gpt-6-sol;只有管理員確認你的 Codex 版本能夠識別
該模型,且其內建後設資料與閘道器匹配時,才可以不使用自訂
目錄。
model = "gpt-6-sol"
model_provider = "enterprise-gateway"
web_search = "disabled"
[model_providers.enterprise-gateway]
name = "Organization Gateway"
base_url = "https://gateway.example.com/v1"
wire_api = "responses"
env_key = "CODEX_GATEWAY_API_KEY"如果管理員提供了模型目錄,請將其儲存到本機,並在
第一個 TOML 表之前新增 model_catalog_json,使用該檔案的絕對路徑。
自訂別名需要匹配的目錄後設資料。例如:
model_catalog_json = "/etc/codex/gateway-models.json"使用管理員配套提供的模型名稱和目錄。只有檔案確實存在於 指定位置時,才新增目錄路徑。
enterprise-gateway 是範例供應商 ID。在
model_provider、[model_providers.<id>] 和 [model_providers.<id>.auth] 中使用相同的 ID。
此範例停用了網頁搜尋,
以便進行初始連線測試;管理員應在啟用該功能前驗證
閘道器是否支援。
透過組織的敏感資訊下發機制,在啟動 Codex 的程序環境中,
將閘道器憑證提供為 CODEX_GATEWAY_API_KEY。
不要將憑證放入 TOML 或儲存庫。在終端中設定的變數
可能無法被從桌面啟動的應用程式存取。
使用自訂身分驗證請求標頭
如果閘道器要求使用 X-API-Key 等請求標頭,而不是 bearer 權杖,
請將供應商表中的 env_key 替換為:
env_http_headers = { "X-API-Key" = "CODEX_GATEWAY_API_KEY" }使用管理員提供的準確請求標頭名稱。Codex 會從
指定的環境變數中讀取值;不要將憑證寫入設定檔。
有關 model_providers.<id>.env_http_headers,請參閱設定參考
。
使用組織的憑證輔助程式
如果管理員提供基於命令的身分驗證,請使用其已安裝的
輔助程式和設定,代替 env_key。不要同時設定這兩種機制。
輔助程式必須已存在於你的電腦上;Codex 不會安裝它。例如,
使用管理員提供的解析器路徑和參數,將範例中的 env_key 設定
替換為以下表:
[model_providers.enterprise-gateway.auth]
command = "/usr/local/bin/fetch-codex-gateway-token"
args = ["print-token"]
timeout_ms = 30000
refresh_interval_ms = 300000自訂供應商身分驗證參考 定義了命令、參數、逾時、重新整理間隔和權杖輸出 約定。如果輔助程式無法再取得權杖,請向管理員詢問如何 重新登入。
為輔助程式執行檔和目錄檔案使用解析後的絕對路徑。
設定 CLI
在 macOS 或 Linux 上,CLI 預設讀取 ~/.codex/config.toml。儲存
供應商設定後,執行 codex。在 WSL 中,使用 Linux 設定和
路徑,除非 CODEX_HOME 指向其他位置。
設定 macOS 應用程式
macOS 應用程式讀取同一個 ~/.codex/config.toml。儲存供應商
設定後,重啟應用程式。如果使用環境變數提供憑證,
請確保應用程式程序可以存取該變數。
設定 Windows 應用程式
將供應商設定放入 %USERPROFILE%\.codex\config.toml,然後重啟
應用程式。對於基於命令的身分驗證,使用管理員安裝的
解析器。例如,將 Unix 身分驗證表替換為:
[model_providers.enterprise-gateway.auth]
command = 'C:\Program Files\OpenAI\Codex\fetch-codex-gateway-token.exe'
args = ["print-token"]
timeout_ms = 30000
refresh_interval_ms = 300000在 Windows TOML 中,單引號字面量字串會保留反斜線。還要替換
Unix 目錄路徑,例如替換為
'C:\ProgramData\OpenAI\Codex\models.json',並使用管理員提供的
實際路徑。
單獨設定 MCP server和外掛。模型閘道器憑證並不 授予存取工具或已連線系統的權限。
驗證連線
更改設定後,重啟用戶端。在 CLI 中,啟動 codex
並使用 /status 檢查當前模型和供應商。在桌面應用程式中,
檢查所選模型和設定。
在新任務中傳送以下提示詞:
Reply with exactly: gateway-ok預期得到 gateway-ok。僅憑回應無法證明由哪條路由處理了請求:請讓
管理員確認閘道器記錄了你的使用者、模型別名
和預期的上游路由。不要透過詢問模型的名稱來識別模型。
這可以驗證初始連線。管理員還應完成 推廣部署檢查, 驗證串流傳輸、工具和後續對話輪次。
排查連線問題
| 症狀 | 檢查內容 |
|---|---|
| 預期的供應商未啟用。 | 檢查所選設定檔和設定優先順序。確認頂層鍵沒有放在供應商表內。 |
| 身分驗證失敗。 | 檢查用戶端程序是否可以存取憑證變數,或已安裝的輔助程式是否可以取得當前有效的權杖。請管理員區分閘道器身分驗證和上游身分驗證。 |
| 找不到模型。 | 確認提供的模型名稱,並請管理員檢查其路由。 |
| 模型使用了非預期的能力。 | 請管理員檢查目錄後設資料是否與別名所指向的模型匹配。 |
| 串流傳輸停滯或後續對話失敗。 | 請閘道器所有者檢查代理緩衝、表示完成的 response.completed 事件和閘道器相容性。 |
| 目錄或輔助程式路徑無效。 | 確認檔案存在於執行 Codex 的環境中所設定的絕對路徑。 |
請求幫助時,請附上已移除權杖和敏感提示詞的錯誤訊息。
使用現有閘道器部署
如果組織已透過閘道器使用其他程式設計工具,你或許可以 重用其網路路徑、日誌記錄和供應商存取權限。與 閘道器團隊協作,設定並測試 Codex 連線:
- 確認現有閘道器 URL、憑證機制、必需的請求標頭、 模型路由和設定下發方式。
- 請閘道器團隊確認閘道器支援 Codex 所需的 API 行為,並 設定 Codex 模型路由。
- 向閘道器團隊取得具有限定權限範圍的閘道器憑證或憑證輔助程式、模型名稱, 以及所需的模型目錄。
- 使用這些值設定 Codex。
- 在你計劃使用的 CLI 或桌面應用程式中驗證連線。 請閘道器團隊完成 串流傳輸、工具和後續對話檢查。
- 試點通過後,按照 透過閘道器部署 Codex 的說明,將 設定分發給其他開發者。
有關管理員遷移檢查清單和設定對映,請參閱 重用現有閘道器部署。