Размещение конфигурации Codex для вашей команды на собственном сервере

Передавайте в Codex настройки по умолчанию и обязательные параметры через HTTPS-эндпоинт под вашим управлением.

Если ваши пользователи не входят в Codex через ChatGPT, вы можете распространять конфигурацию для Codex CLI и настольного приложения через HTTPS-сервер под вашим управлением. Codex загружает ваши настройки при запуске независимо от того, подключаются ли пользователи к своему поставщику моделей напрямую или через шлюз.

Ограничения клиентов

Настольное приложение не может предложить вам войти на сервер конфигурации. Если сервер требует повторного входа, выполните codex login в терминале на том же компьютере, затем снова откройте приложение. Если приложение не может загрузить обязательные настройки, запуск приостанавливается.

Настройка подключения Codex к серверу

На тестовом компьютере создайте или обновите системный файл requirements.toml. Добавьте таблицу [config_server] с базовым URL вашего сервера конфигурации. Используйте /etc/codex/requirements.toml в Linux и macOS или %ProgramData%\OpenAI\Codex\requirements.toml в Windows. В macOS таблицу также можно распространять через управляемые настройки.

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

Выбрать сервер можно только через локальные требования, контролируемые администратором. Сохраните эту таблицу на компьютере, когда перенесёте остальную политику на эндпоинт.

Аутентификация на сервере конфигурации (необязательно)

По умолчанию Codex пытается получить конфигурацию без учётных данных. Если сервер требует входа, добавьте [config_server.oauth] в тот же файл requirements.toml. Codex использует поток OAuth с кодом авторизации и Proof Key for Code Exchange (PKCE).

[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, если ваш поставщик принимает обратный вызов на loopback-адрес на любом доступном порту. Codex отправляет токен доступа в заголовке Authorization. Ваш сервер должен проверить его перед возвратом пакета.

Предоставление конфигурации Codex

Разместите управляемую конфигурацию на HTTPS-эндпоинте. При получении пакета Codex CLI отправляет GET-запрос, используя базовый URL из локального requirements.toml:

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 в два массива:

  • config_toml.enterprise_managed содержит применяемые настройки по умолчанию. Поле contents каждой записи содержит текст config.toml.
  • requirements_toml.enterprise_managed содержит обязательные требования. Поле contents каждой записи содержит текст requirements.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. Если вы предоставляете настройки по умолчанию, найдите их имена и идентификаторы в разделе Стек слоёв конфигурации. Для приведённого выше примера найдите enterprise-managed (Default web search, search-default) (enabled).
  4. Если вы предоставляете требования, найдите обязательную настройку в разделе Требования и проверьте указанный рядом с ней источник политики.

Codex может запускаться с кэшированными настройками и обновлять их в фоновом режиме. После изменения политики на сервере дождитесь её обновления в Codex, затем начните новый сеанс и повторите проверку, прежде чем распространять её на другие компьютеры.