Visão geral
Use este guia se você for administrador de um workspace do ChatGPT configurando o modelo de app Enterprise do GitHub para sua organização. Um modelo não é o app final que os membros usam. Ele é um fluxo de configuração que cria um app de rascunho específico do workspace depois que você fornece a configuração necessária do GitHub Enterprise.
Para o GitHub Enterprise, a configuração conecta o ChatGPT ao host do GitHub Enterprise da sua organização. Você cria um GitHub App, registra a URL de callback do ChatGPT, gera credenciais e cola esses valores no fluxo de configuração do modelo do ChatGPT. Depois que o ChatGPT criar o app de rascunho, você poderá publicá-lo e gerenciá-lo como outros apps do workspace.
O que você está configurando
Você está criando um app GitHub Enterprise específico do workspace no ChatGPT. O app usa:
Um GitHub App registrado no seu host do GitHub Enterprise.
O ID do cliente e o segredo do cliente do GitHub App para autorização OAuth do usuário.
A chave privada do GitHub App para que o ChatGPT possa emitir tokens de instalação para operações de repositório.
Um segredo de webhook e uma URL de webhook para que o GitHub Enterprise possa enviar eventos de instalação e repositório de volta ao ChatGPT.
Seu hostname do GitHub Enterprise, como
github.example.com.
Crie um GitHub App, não um GitHub OAuth App independente. A configuração do modelo do ChatGPT exige credenciais do GitHub App, uma chave privada e configurações de webhook.
Antes de começar
Você precisa de:
Acesso de administrador ou proprietário do workspace do ChatGPT.
Acesso de administrador ou proprietário da organização no GitHub Enterprise que possa criar e instalar GitHub Apps.
Apenas o hostname do GitHub Enterprise, sem
https://ou caminho.Uma decisão sobre quais ações de repositório o ChatGPT deve oferecer suporte, como pesquisa de repositórios somente leitura, workflows de pull request, workflows de issues, edições de arquivos, GitHub Actions ou workflows mais amplos do Codex.
Um local seguro para lidar com a chave privada e o segredo do cliente do GitHub App.
Mantenha o ChatGPT e o GitHub Enterprise abertos em abas separadas. Não invente a URL de callback. Copie a URL de callback exata exibida no ChatGPT.
Valores a preparar
Hostname do GitHub Enterprise: por exemplo,
github.example.com.URL de callback: copie-a do fluxo de configuração do modelo do ChatGPT.
ID do cliente do GitHub App.
Segredo do cliente do GitHub App.
PEM da chave privada do GitHub App.
Segredo de webhook gerado pelo ChatGPT.
URL de webhook gerada depois que o app de rascunho é criado no ChatGPT.
Inicie a configuração do modelo no ChatGPT
No ChatGPT, mude para o workspace em que o app deve ficar disponível.
Abra Configurações do workspace > Apps.
Selecione Diretório.
Pesquise GitHub Enterprise.
Selecione o modelo de app GitHub Enterprise e inicie a configuração.
Insira um nome e uma descrição claros para o app, como GitHub Enterprise ou GitHub Enterprise - Engenharia.
Insira o hostname do GitHub Enterprise, como
github.example.com.Copie a URL de callback exibida no ChatGPT. Mantenha esta aba aberta.
Copie o segredo de webhook gerado, se ele for exibido durante a configuração.
Exemplo de URL de callback: https://chatgpt.com/connector/oauth/<callback_id>
Não remova o ID de callback, não adicione uma barra no final nem o substitua por uma URL genérica do ChatGPT.
Crie o GitHub App no GitHub Enterprise
Abra seu host do GitHub Enterprise, como
https://github.example.com.Acesse a organização ou conta que deve ser proprietária do app.
Abra Configurações > Configurações de desenvolvedor > GitHub Apps.
Selecione Novo GitHub App.
Insira um nome claro para o app, como Conector do GitHub Enterprise para ChatGPT.
Insira uma URL de página inicial. Se não houver uma página interna dedicada, use a URL da organização do GitHub Enterprise.
Em URL de callback, cole a URL de callback exata copiada do ChatGPT.
Mantenha Expirar tokens de autorização do usuário habilitado, a menos que sua equipe de segurança tenha um motivo específico para alterar isso.
Habilite Solicitar autorização do usuário durante a instalação para que os usuários possam autorizar o app durante o fluxo de instalação ou conexão.
Em Onde este GitHub App pode ser instalado?, escolha a opção mais restrita que se ajuste à sua implantação.
Crie o GitHub App.
Configure permissões e eventos
Escolha as permissões mínimas necessárias para as ações do ChatGPT que você pretende habilitar.
Para descoberta de repositórios e perguntas e respostas somente leitura, comece com permissões de leitura como:
Metadados: somente leitura. O GitHub exige metadados para GitHub Apps.
Conteúdo: somente leitura, para acesso a arquivos e conteúdo de repositórios.
Issues: somente leitura, se for necessário pesquisar ou ler issues.
Pull requests: somente leitura, se for necessário pesquisar pull requests ou acessar contexto de revisão.
Actions: somente leitura, se forem necessários status de execuções de workflow, jobs, logs ou artefatos.
Para workflows de gravação, adicione permissões de gravação apenas onde necessário, como Conteúdo, Pull requests, Issues, Actions ou Workflows. Use as permissões mais restritas que ofereçam suporte às ações pretendidas do ChatGPT.
Os eventos de webhook devem corresponder aos workflows aos quais você oferece suporte. Eventos comuns incluem Instalação, Repositórios de instalação, Push, Pull request, Issues, Comentário de issue, Execução de workflow e Job de workflow.
Gere e copie as credenciais do GitHub App
Nas configurações do GitHub App, copie o ID do cliente.
Gere um segredo do cliente e copie-o imediatamente.
Em Chaves privadas, gere uma chave privada.
Baixe o arquivo .pem e armazene-o com segurança.
Abra o arquivo .pem localmente e copie o texto PEM completo, incluindo as linhas de início e fim.
A chave privada é sensível. Trate-a como uma credencial. Se ela for exposta, gere uma nova chave privada, atualize a configuração do app no ChatGPT e exclua a chave comprometida no GitHub Enterprise.
Conclua a configuração no ChatGPT
Volte para a aba de configuração do modelo do ChatGPT.
Cole o ID do cliente do GitHub App em ID do cliente OAuth.
Cole o segredo do cliente do GitHub App em Segredo do cliente OAuth.
Deixe Escopos inalterado, a menos que sua organização precise intencionalmente substituir os padrões do modelo.
Confirme que o hostname do GitHub Enterprise contém apenas o hostname, como
github.example.com.Cole ou carregue o PEM da chave privada do GitHub App em Chave privada do GitHub App.
Confirme que o segredo de webhook gerado está presente.
Crie o app de rascunho.
Abra os detalhes do app de rascunho criado no ChatGPT e copie a URL de webhook gerada.
A URL de webhook deve ter esta aparência: https://connectors.api.openai.org/connectors/<connector_id>/webhook
Conclua a configuração do webhook no GitHub Enterprise
Volte para as configurações do GitHub App no GitHub Enterprise.
Abra as configurações gerais do GitHub App.
Habilite Webhooks ativos se ainda não estiverem habilitados.
Cole a URL de webhook do ChatGPT em URL de webhook.
Cole o segredo de webhook do ChatGPT em Segredo do webhook.
Mantenha a verificação SSL habilitada.
Confirme que os eventos de webhook inscritos correspondem às permissões e ações que você habilitou.
Salve as alterações.
Publique e gerencie o app no ChatGPT
Criar o app de rascunho não o torna automaticamente disponível para os membros. Depois de revisar o rascunho:
Publique o app de rascunho.
Confirme que o app aparece em Configurações do workspace > Apps > Habilitados.
Configure Acesso do usuário para as funções que devem usá-lo.
Revise Controle de ações para ações de leitura e gravação.
Revise Permissões do app para escolher quando o ChatGPT pede confirmação aos membros antes de usar o app.
Peça a um usuário de teste permitido para abrir Apps no ChatGPT e confirmar que o app aparece.
Essas permissões do app se aplicam às conversas do ChatGPT. Agentes do workspace usam controles por agente definidos pelo criador do agente para determinar quais ações do app estão disponíveis e quando os usuários finais precisam aprová-las. Para comportamento de agentes, consulte: Agentes do workspace do ChatGPT para Enterprise e Business.
Instale e teste o GitHub App
No GitHub Enterprise, instale o app GitHub na organização ou conta.
Escolha todos os repositórios ou repositórios selecionados de acordo com a política do workspace.
Inicie o fluxo de conexão pelo ChatGPT como um usuário permitido.
Autorize o app GitHub quando solicitado.
Execute primeiro uma pequena ação de leitura, como listar repositórios acessíveis ou buscar uma pull request conhecida.
Se ações de gravação estiverem habilitadas, teste com um repositório de baixo risco antes de uma implantação mais ampla.
Hostname e comportamento de OAuth
O ChatGPT usa o hostname para derivar endpoints do GitHub Enterprise. Insira apenas o host, como github.example.com ou octocorp.ghe.com.
Não insira um caminho de API, um caminho de repositório nem github.com, a menos que esse seja o host exato do GitHub Enterprise para este app.
Solução de problemas
Incompatibilidade de URI de redirecionamento: confirme que a URL de callback do GitHub App corresponde exatamente à URL de callback exibida no ChatGPT.
O ChatGPT não consegue criar ou salvar o app de rascunho: confirme que todos os campos obrigatórios estão presentes, incluindo hostname, ID do cliente OAuth, segredo do cliente OAuth, chave privada e segredo de webhook.
A autenticação é bem-sucedida, mas as chamadas de repositório falham: confirme que o GitHub App está instalado e tem acesso ao repositório.
A API retorna 403 ou permissões insuficientes: adicione a permissão ausente do GitHub App e peça ao proprietário da instalação que aprove as permissões atualizadas, se solicitado.
Nenhum repositório aparece: confirme que a instalação do app inclui os repositórios esperados e que o usuário que autoriza no ChatGPT tem acesso a eles.
As entregas de webhook falham: confirme que a URL de webhook e o segredo de webhook correspondem aos valores do ChatGPT, mantenha a verificação SSL habilitada e verifique se o host do GitHub Enterprise consegue acessar
connectors.api.openai.org.Erros de chave privada: confirme que o conteúdo PEM completo foi copiado, incluindo as linhas de início e fim.