如需完整的文件索引,請參閱 llms.txt。在文件頁面的網址末尾加上 .md ,即可取得該頁面的 Markdown 版本。
主要導覽
主題

為團隊自架 Codex 設定伺服器

透過自行維運的 HTTPS 端點,向 Codex 提供預設值和強制設定。

建議團隊使用 ChatGPT 登入 Codex。如果你的方案支援受管理的設定,就能在管理主控台的智慧體安全性中設定預設值並強制套用必要的設定,無須自架伺服器。

如果使用者未透過 ChatGPT 登入 Codex,你可以透過自行維運的 HTTPS 伺服器,將設定分發給 Codex CLI 和桌面應用程式。無論使用者直接連線至模型供應商,還是透過閘道連線,Codex 都會在啟動時載入你的設定。

用戶端限制

桌面應用程式無法提示你登入設定伺服器。如果伺服器要求重新登入,請在同一台電腦的終端執行 codex login,然後重新開啟應用程式。如果應用程式無法載入強制設定,啟動程序就會暫停。

設定 Codex 以使用伺服器

在測試電腦上建立或更新系統層級的 requirements.toml。新增 [config_server] 資料表,並在其中填入設定伺服器的基底 URL。Linux 和 macOS 的檔案路徑為 /etc/codex/requirements.toml,Windows 則為 %ProgramData%\OpenAI\Codex\requirements.toml。在 macOS 上,你也可以透過受管理的偏好設定分發這個資料表。

[config_server]
base_url = "https://codex-config.example.com/team"

只有本機管理員控管的強制設定才能指定伺服器。將其餘政策移至端點時,請將這個資料表保留在電腦上。

向設定伺服器驗證身分(選用)

根據預設,Codex 會嘗試在未提供憑證的情況下取得設定。如果伺服器要求登入,請將 [config_server.oauth] 加入同一個 requirements.toml 檔案。Codex 使用搭配 PKCE(Proof Key for Code Exchange)的 OAuth 授權碼流程。

[config_server.oauth]
authorization_url = "https://login.example.com/oauth/authorize"
token_url = "https://login.example.com/oauth/token"
client_id = "codex-policy"
redirect_port = 43127

此範例的重新導向 URI 為 http://127.0.0.1:43127/callback。如果你的供應商接受透過任一可用連接埠回呼至本機迴路位址,就可以省略 redirect_port。Codex 會在 Authorization 標頭中傳送存取權杖。伺服器必須先驗證權杖,再傳回設定組合包。

提供 Codex 設定

透過 HTTPS 端點提供受管理的設定。Codex CLI 取得設定組合包時,會使用本機 requirements.toml 中的基底 URL 傳送 GET 請求:

GET {config_server.base_url}/codex/config/bundle

如果使用上述初始設定範例中的 base_url,Codex 會傳送以下請求:

GET https://codex-config.example.com/team/codex/config/bundle

伺服器應傳回 200 OK,並在回應主體中包含 JSON 設定組合包。

設定組合包格式

設定組合包將 TOML 項目分成兩個陣列:

每個陣列項目都有三個字串欄位:id、name(顯示名稱)和 contents。如果不需要某個類別,請使用空陣列。

這個範例將網頁搜尋的預設值設為 disabled,並透過 allowed_web_search_modes 強制使用該值。

{
  "config_toml": {
    "enterprise_managed": [
      {
        "id": "search-default",
        "name": "Default web search",
        "contents": "web_search = 'disabled'"
      }
    ]
  },
  "requirements_toml": {
    "enterprise_managed": [
      {
        "id": "search-policy",
        "name": "Allowed web search modes",
        "contents": "allowed_web_search_modes = ['disabled']"
      }
    ]
  }
}

在 Codex 中驗證設定

  1. 在測試電腦上,於專案目錄中開啟終端並執行 codex。如果出現登入提示,請使用公司帳號完成登入。
  2. 在 Codex CLI 的互動式指令提示字元下,輸入 /debug-config 並按下 Enter 鍵。
  3. 如果伺服器有提供預設值,請在 Config layer stack 下找出這些預設值的名稱和 ID。如果使用上述範例,請尋找 enterprise-managed (Default web search, search-default) (enabled)。
  4. 如果伺服器有提供強制設定,請在 Requirements 下找出其中一項設定,並確認旁邊列出的政策來源。

Codex 可以使用快取的設定啟動,並在背景更新設定。在伺服器上變更政策後,請等候 Codex 更新設定,再啟動新的工作階段並再次檢查,之後再將政策部署到其他電腦。