Alojar a configuração do Codex para a sua equipa

Forneça predefinições de configuração e definições obrigatórias ao Codex a partir de um endpoint HTTPS que gere.

Se os seus utilizadores não iniciarem sessão no Codex com o ChatGPT, pode distribuir a configuração para o Codex CLI e a aplicação de ambiente de trabalho a partir de um servidor HTTPS que gere. O Codex carrega as suas definições no arranque, quer os utilizadores se liguem diretamente ao fornecedor do modelo ou através de um gateway.

Limitações do cliente

A aplicação de ambiente de trabalho não pode pedir-lhe que inicie sessão no servidor de configuração. Se o servidor exigir um novo início de sessão, execute codex login num terminal no mesmo computador e, em seguida, volte a abrir a aplicação. Se a aplicação não conseguir carregar as definições obrigatórias, o arranque é interrompido.

Configurar o Codex para utilizar o servidor

Num computador de teste, crie ou atualize o requirements.toml do sistema. Adicione uma tabela [config_server] com o URL base do servidor de configuração. Utilize /etc/codex/requirements.toml no Linux e no macOS, ou %ProgramData%\OpenAI\Codex\requirements.toml no Windows. No macOS, também pode distribuir a tabela através de preferências geridas.

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

Apenas os requisitos locais controlados pelo administrador podem selecionar o servidor. Mantenha esta tabela no computador quando mover o resto da política para o endpoint.

Autenticar no servidor de configuração (opcional)

Por predefinição, o Codex tenta obter a configuração sem credenciais. Se o servidor exigir o início de sessão, adicione [config_server.oauth] ao mesmo ficheiro requirements.toml. O Codex utiliza o fluxo de código de autorização OAuth com 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

O URI de redirecionamento deste exemplo é http://127.0.0.1:43127/callback. Pode omitir redirect_port se o seu fornecedor aceitar um callback de loopback em qualquer porta disponível. O Codex envia o token de acesso no cabeçalho Authorization. O servidor tem de o verificar antes de devolver o pacote.

Fornecer a configuração do Codex

Aloje a sua configuração gerida num endpoint HTTPS. Quando o Codex CLI obtém o pacote, envia um pedido GET utilizando o URL base do requirements.toml local:

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

Com o base_url do exemplo de configuração inicial acima, o Codex envia este pedido:

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

Responda com 200 OK e um pacote de configuração JSON no corpo da resposta.

Formato do pacote de configuração

O pacote agrupa as entradas TOML em dois arrays:

  • config_toml.enterprise_managed contém as predefinições a aplicar. O contents de cada entrada é texto config.toml.
  • requirements_toml.enterprise_managed contém os requisitos a impor. O contents de cada entrada é texto requirements.toml.

Cada entrada do array tem três campos de cadeia de caracteres: id, name (um nome a apresentar) e contents. Utilize um array vazio para uma categoria de que não necessite.

Este exemplo define a predefinição de pesquisa na Web como disabled e impõe esse valor com 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']"
      }
    ]
  }
}

Verificar a configuração no Codex

  1. Num computador de teste, abra um terminal no diretório do projeto e execute codex. Conclua o início de sessão da empresa, se solicitado.
  2. Na linha de comandos interativa do Codex CLI, escreva /debug-config e prima Enter.
  3. Se fornecer predefinições, procure os respetivos nomes e IDs em Pilha de camadas de configuração. Com o exemplo acima, procure enterprise-managed (Default web search, search-default) (enabled).
  4. Se fornecer requisitos, procure uma definição que imponha em Requisitos e verifique a origem da política indicada junto à mesma.

O Codex pode arrancar com definições em cache e atualizá-las em segundo plano. Depois de alterar uma política no servidor, aguarde que o Codex a atualize, inicie uma nova sessão e repita a verificação antes de a implementar noutros computadores.