チーム向けの Codex 設定をセルフホストする

自社で運用する HTTPS エンドポイントから、設定のデフォルト値と必須設定を Codex に配信します。

ユーザーが ChatGPT で Codex にサインインしない場合は、自社で運用する HTTPS サーバーから Codex CLI とデスクトップアプリに設定を配信できます。ユーザーがモデルプロバイダーに直接接続する場合も、ゲートウェイ経由で接続する場合も、Codex は起動時に設定を読み込みます。

クライアントの制限事項

デスクトップアプリでは、設定サーバーへのサインインを求める画面を表示できません。サーバーで新たなサインインが必要になった場合は、同じコンピューターのターミナルで codex login を実行してから、アプリを開き直してください。必須設定を読み込めない場合、アプリの起動は一時停止します。

サーバーを使用するように Codex を設定する

テスト用コンピューターで、システムの requirements.toml を作成または更新します。設定サーバーのベース URL を指定した [config_server] テーブルを追加します。Linux と macOS では /etc/codex/requirements.toml、Windows では %ProgramData%\OpenAI\Codex\requirements.toml を使用してください。macOS では、管理対象環境設定を通じてテーブルを配布することもできます。

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

サーバーを指定できるのは、ローカルの管理者が管理する要件のみです。ポリシーの残りの部分をエンドポイントに移す場合も、このテーブルはコンピューター上に残してください。

設定サーバーで認証する(任意)

デフォルトでは、Codex は認証情報なしで設定の取得を試みます。サーバーでサインインが必要な場合は、同じ requirements.toml ファイルに [config_server.oauth] を追加します。Codex は、Proof Key for Code Exchange(PKCE)を使用する 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 エントリを 2 つの配列にまとめます。

  • config_toml.enterprise_managed には、適用するデフォルト値を格納します。各エントリの contents は config.toml のテキストです。
  • requirements_toml.enterprise_managed には、強制する要件を格納します。各エントリの contents は requirements.toml のテキストです。

各配列エントリには、id、name(表示名)、contents の 3 つの文字列フィールドがあります。不要なカテゴリには空の配列を使用してください。

この例では、ウェブ検索のデフォルト値を 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. デフォルト値を配信している場合は、設定レイヤースタック でその名前と ID を確認します。上記の例では、enterprise-managed (Default web search, search-default) (enabled) を探してください。
  4. 要件を配信している場合は、要件 で強制している設定を探し、その横に表示されているポリシーのソースを確認します。

Codex はキャッシュ済みの設定で起動し、バックグラウンドで設定を更新できます。サーバー上のポリシーを変更した後は、Codex による更新を待ってから新しいセッションを開始し、ほかのマシンに展開する前にもう一度確認してください。