Visão geral
Use este guia se você administra um espaço de trabalho do ChatGPT e está configurando o template do app GitHub Enterprise para sua organização. Um template não é o app final que os membros usam. É um fluxo de configuração que cria um rascunho de app específico para o espaço de trabalho depois que você fornece a configuração necessária do GitHub Enterprise.
No caso do 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 template no ChatGPT. Depois que o ChatGPT cria o rascunho do app, você pode publicá-lo e gerenciá-lo como os outros apps do espaço de trabalho.
Para saber mais sobre a navegação no espaço de trabalho e o acesso a apps, consulte: Controles de administração, segurança e conformidade para plugins e apps.
O que você está configurando
Você está criando um app GitHub Enterprise no ChatGPT específico para o espaço de trabalho. 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 do usuário via OAuth.
A chave privada do GitHub App para que o ChatGPT possa gerar tokens de instalação para operações em repositórios.
Um segredo e uma URL de webhook para que o GitHub Enterprise possa enviar eventos de instalação e de repositório de volta ao ChatGPT.
O nome do seu host do GitHub Enterprise, como
github.example.com.
Crie um GitHub App, não um GitHub OAuth App independente. A configuração do template no 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 ao espaço de trabalho do ChatGPT.
Acesso de administrador do GitHub Enterprise ou de proprietário da organização com permissão para criar e instalar GitHub Apps.
Apenas o nome do host do GitHub Enterprise, sem
https://nem caminho.Uma definição das ações em repositórios que o ChatGPT deve oferecer, como pesquisa de repositórios somente leitura, fluxos de trabalho de pull requests e issues, edições de arquivos, GitHub Actions ou fluxos de trabalho 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 exata de callback exibida no ChatGPT.
Valores a preparar
Nome do host do GitHub Enterprise: por exemplo,
github.example.com.URL de callback: copie-a do fluxo de configuração do template no ChatGPT.
ID do cliente do GitHub App.
Segredo do cliente do GitHub App.
Chave privada do GitHub App em formato PEM.
Segredo de webhook gerado pelo ChatGPT.
URL de webhook gerada após a criação do rascunho do app no ChatGPT.
Inicie a configuração do template no ChatGPT
No ChatGPT, mude para o espaço de trabalho em que o app deve ficar disponível.
Abra Configurações do espaço de trabalho > Apps. Você também pode acessar o Console de administração, selecionar o espaço de trabalho desejado do ChatGPT e abrir Plugins. Selecione Gerenciar apps legados para abrir a página Apps que foi mantida.
Selecione Diretório.
Pesquise por GitHub Enterprise.
Selecione o template do 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 nome do host 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, caso ele seja 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 ao final nem substitua a URL por uma URL genérica do ChatGPT.
Crie o GitHub App no GitHub Enterprise
Acesse o servidor do GitHub Enterprise, como
https://github.example.com.Acesse a organização ou conta que será proprietária do app.
Abra Configurações > Configurações do desenvolvedor > GitHub Apps.
Selecione Novo GitHub App.
Insira um nome claro para o app, como ChatGPT GitHub Enterprise.
Insira a URL de uma página inicial. Se não houver uma página interna dedicada, use a URL da organização no GitHub Enterprise.
Em URL de callback, cole a URL de callback exata copiada do ChatGPT.
Mantenha a opção Expirar tokens de autorização do usuário habilitada, a menos que sua equipe de segurança tenha um motivo específico para alterá-la.
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 atenda à 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 ativar.
Para descoberta de repositórios e perguntas e respostas com acesso somente leitura, comece com permissões de leitura, como:
Metadados: somente leitura. O GitHub exige acesso a metadados para GitHub Apps.
Conteúdo: somente leitura, para acesso a arquivos e ao conteúdo dos 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 obter contexto para revisão.
Ações: somente leitura, se forem necessários status de execução de fluxos de trabalho, jobs, logs ou artefatos.
Para fluxos de trabalho de escrita, adicione permissões de escrita apenas onde for necessário, como Conteúdo, Pull requests, Issues, Ações ou Fluxos de trabalho. Use as permissões mais restritas que permitam executar as ações desejadas do ChatGPT.
Os eventos de webhook devem corresponder aos fluxos de trabalho que você oferece. Os eventos comuns incluem Instalação, Repositórios da instalação, Push, Pull request, Issues, Comentário em issue, Execução de fluxo de trabalho e Job de fluxo de trabalho.
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 todo o texto PEM, incluindo as linhas de início e fim.
A chave privada é uma informação 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 à aba de configuração do template no 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.
Mantenha Escopos sem alterações, a menos que sua organização tenha uma necessidade específica de substituir os padrões do template.
Confirme que o campo de nome do host do GitHub Enterprise contém apenas o nome do host, como
github.example.com.Cole ou envie a chave privada do GitHub App em formato PEM no campo Chave privada do GitHub App.
Confirme que o segredo de webhook gerado está presente.
Crie o rascunho do app.
Abra os detalhes do rascunho do app criado no ChatGPT e copie a URL de webhook gerada.
A URL de webhook deve ter este formato: https://connectors.api.openai.org/connectors/<connector_id>/webhook
Conclua a configuração do webhook no GitHub Enterprise
Volte às configurações do GitHub App no GitHub Enterprise.
Abra as configurações gerais do GitHub App.
Ative a opção Webhooks ativos, caso ainda não esteja ativada.
Cole a URL de webhook do ChatGPT em URL de webhook.
Cole o segredo de webhook do ChatGPT em Segredo de webhook.
Mantenha a verificação SSL ativada.
Confirme que os eventos de webhook selecionados para recebimento correspondem às permissões e ações que você ativou.
Salve as alterações.
Publique e gerencie o app no ChatGPT
Criar o rascunho do app não o disponibiliza automaticamente para os membros. Após revisar o rascunho:
Publique o rascunho do app.
Nas configurações do espaço de trabalho, abra a página Apps, acesse Habilitados e confirme se o app aparece. Você também pode abrir a página Apps pela opção Gerenciar apps legados em Console de administração > Plugins.
Nos planos Enterprise e Edu, use Acesso de usuários para escolher quais funções podem usar o app. No plano Business, gerencie a disponibilidade do app em todo o espaço de trabalho.
Revise o Controle de ações para ações de leitura e gravação.
Revise as Permissões do app para escolher quando o ChatGPT deve pedir autorização aos membros antes de usar o app.
Peça a um usuário de teste com acesso permitido que abra Apps no ChatGPT e confirme se o app aparece.
Essas permissões do app se aplicam às conversas no ChatGPT. Os agentes do espaço de trabalho usam controles individuais definidos por quem criou cada agente para determinar quais ações do app estão disponíveis e quando os usuários finais precisam aprová-las. Para saber mais sobre o comportamento dos agentes, consulte: Agentes do espaço de trabalho do ChatGPT para Enterprise e Business.
Instale e teste o GitHub App
No GitHub Enterprise, instale o GitHub App na organização ou conta.
Escolha todos os repositórios ou repositórios selecionados de acordo com a política do espaço de trabalho.
Inicie o fluxo de conexão pelo ChatGPT com um usuário que tenha acesso permitido.
Autorize o GitHub App quando solicitado.
Execute primeiro uma ação simples de leitura, como listar repositórios acessíveis ou buscar uma pull request conhecida.
Se as ações de escrita estiverem ativadas, teste em um repositório de baixo risco antes de ampliar a disponibilização.
Nome do host e comportamento do OAuth
O ChatGPT usa o nome do host para determinar os 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 ou github.com, a menos que esse seja o host exato do GitHub Enterprise para este app.
Solução de problemas
URI de redirecionamento não corresponde: 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 rascunho do app: confirme que todos os campos obrigatórios estão preenchidos, incluindo nome do host, ID do cliente OAuth, Segredo do cliente OAuth, chave privada e segredo de webhook.
A autenticação funciona, mas as chamadas ao 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 está autorizando no ChatGPT tem acesso a eles.
As entregas de webhook falham: confirme que a URL e o segredo de webhook correspondem aos valores do ChatGPT, mantenha a verificação SSL ativada e verifique se o host do GitHub Enterprise consegue acessar
connectors.api.openai.org.Erros de chave privada: confirme que todo o conteúdo PEM foi copiado, incluindo as linhas de início e fim.