Descrição geral
Use este guia se for administrador de um espaço de trabalho do ChatGPT e estiver a configurar o modelo de app Enterprise do GitHub para a sua organização. Um modelo não é a app final que os membros utilizam. É um fluxo de configuração que cria uma app de rascunho específica do espaço de trabalho depois de fornecer a configuração necessária do GitHub Enterprise.
Para o GitHub Enterprise, a configuração liga o ChatGPT ao anfitrião GitHub Enterprise da sua organização. Cria uma GitHub App, regista o URL de callback do ChatGPT, gera credenciais e depois cola esses valores no fluxo de configuração do modelo do ChatGPT. Depois de o ChatGPT criar a app de rascunho, pode publicá-la e geri-la como outras apps do espaço de trabalho.
O que está a configurar
Está a criar uma app GitHub Enterprise específica do espaço de trabalho no ChatGPT. A app utiliza:
Uma GitHub App registada no seu anfitrião GitHub Enterprise.
O ID de cliente e o segredo do cliente da GitHub App para autorização OAuth do utilizador.
A chave privada da GitHub App para que o ChatGPT possa emitir tokens de instalação para operações de repositório.
Um segredo de webhook e um URL de webhook para que o GitHub Enterprise possa enviar eventos de instalação e repositório de volta para o ChatGPT.
O nome de anfitrião do GitHub Enterprise, como
github.example.com.
Crie uma GitHub App, não uma GitHub OAuth App autónoma. A configuração do modelo do ChatGPT requer credenciais da GitHub App, uma chave privada e definições de webhook.
Antes de começar
Precisa de:
Acesso de administrador ou proprietário do espaço de trabalho do ChatGPT.
Acesso de administrador do GitHub Enterprise ou de proprietário da organização que possa criar e instalar GitHub Apps.
Apenas o nome de anfitrião do GitHub Enterprise, sem
https://nem um caminho.Uma decisão sobre que ações de repositório o ChatGPT deve suportar, como pesquisa de repositórios só de leitura, fluxos de trabalho de pull request, fluxos de trabalho de problemas, edições de ficheiros, GitHub Actions ou fluxos de trabalho Codex mais amplos.
Um local seguro para gerir a chave privada e o segredo do cliente da GitHub App.
Mantenha o ChatGPT e o GitHub Enterprise abertos em separadores separados. Não invente o URL de callback. Copie o URL de callback exato apresentado no ChatGPT.
Valores a preparar
Nome de anfitrião do GitHub Enterprise: por exemplo,
github.example.com.URL de callback: copie-o a partir do fluxo de configuração do modelo do ChatGPT.
ID de cliente da GitHub App.
Segredo do cliente da GitHub App.
Chave privada PEM da GitHub App.
Segredo de webhook gerado pelo ChatGPT.
URL de webhook gerado depois de a app de rascunho ser criada no ChatGPT.
Inicie a configuração do modelo no ChatGPT
No ChatGPT, mude para o espaço de trabalho onde a app deve ficar disponível.
Abra Definições do espaço de trabalho > Apps.
Selecione Diretório.
Pesquise GitHub Enterprise.
Selecione o modelo de app GitHub Enterprise e inicie a configuração.
Introduza um nome e uma descrição claros para a app, como GitHub Enterprise ou GitHub Enterprise - Engineering.
Introduza o nome de anfitrião do GitHub Enterprise, como
github.example.com.Copie o URL de callback apresentado no ChatGPT. Mantenha este separador aberto.
Copie o segredo de webhook gerado se for apresentado 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 final nem o substitua por um URL genérico do ChatGPT.
Crie a GitHub App no GitHub Enterprise
Abra o seu anfitrião GitHub Enterprise, como
https://github.example.com.Aceda à organização ou conta que deve ser proprietária da app.
Abra Definições > Definições de programador > GitHub Apps.
Selecione Nova GitHub App.
Introduza um nome claro para a app, como ChatGPT GitHub Enterprise Connector.
Introduza um URL da página inicial. Se não existir uma página interna dedicada, utilize o URL da organização GitHub Enterprise.
Em URL de callback, cole o URL de callback exato copiado do ChatGPT.
Mantenha a opção Expirar tokens de autorização do utilizador ativada, salvo se a sua equipa de segurança tiver um motivo específico para a alterar.
Ative Pedir autorização do utilizador durante a instalação para que os utilizadores possam autorizar a app durante o fluxo de instalação ou ligação.
Em Onde pode esta GitHub App ser instalada?, escolha a opção mais restrita que se ajusta à sua implementação.
Crie a GitHub App.
Configure permissões e eventos
Escolha as permissões mínimas necessárias para as ações do ChatGPT que pretende ativar.
Para descoberta de repositórios e perguntas e respostas só de leitura, comece com permissões de leitura, tais como:
Metadados: só de leitura. O GitHub requer metadados para GitHub Apps.
Conteúdos: só de leitura, para acesso a ficheiros e conteúdo de repositórios.
Problemas: só de leitura, se for necessário pesquisar ou ler problemas.
Pull requests: só de leitura, se for necessário pesquisar pull request ou contexto de revisão.
Ações: só de leitura, se forem necessários estados de execuções de fluxos de trabalho, trabalhos, registos ou artefactos.
Para fluxos de trabalho de escrita, adicione permissões de escrita apenas onde necessário, como Conteúdos, Pull requests, Problemas, Ações ou Fluxos de trabalho. Utilize as permissões mais restritas que suportem as ações pretendidas do ChatGPT.
Os eventos de webhook devem corresponder aos fluxos de trabalho que suporta. Eventos comuns incluem Instalação, Repositórios de instalação, Push, Pull request, Problemas, Comentário de problema, Execução de fluxo de trabalho e Trabalho de fluxo de trabalho.
Gere e copie as credenciais da GitHub App
Nas definições da GitHub App, copie o ID de cliente.
Gere um segredo do cliente e copie-o imediatamente.
Em Chaves privadas, gere uma chave privada.
Transfira o ficheiro .pem e guarde-o em segurança.
Abra o ficheiro .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 for exposta, gere uma nova chave privada, atualize a configuração da app do ChatGPT e elimine a chave comprometida no GitHub Enterprise.
Conclua a configuração no ChatGPT
Regresse ao separador de configuração do modelo do ChatGPT.
Cole o ID de cliente da GitHub App em ID de cliente OAuth.
Cole o segredo do cliente da GitHub App em Segredo do cliente OAuth.
Deixe Âmbitos inalterado, a menos que a sua organização precise intencionalmente de substituir as predefinições do modelo.
Confirme que o nome de anfitrião do GitHub Enterprise contém apenas o nome de anfitrião, como
github.example.com.Cole ou carregue a chave privada PEM da GitHub App em Chave privada da GitHub App.
Confirme que o segredo de webhook gerado está presente.
Crie a app de rascunho.
Abra os detalhes da app de rascunho criada no ChatGPT e copie o URL de webhook gerado.
O URL de webhook deve ter este aspeto: https://connectors.api.openai.org/connectors/<connector_id>/webhook
Conclua a configuração do webhook no GitHub Enterprise
Regresse às definições da GitHub App no GitHub Enterprise.
Abra as definições gerais da GitHub App.
Ative Webhooks ativos, se ainda não estiverem ativados.
Cole o 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 subscritos correspondem às permissões e ações que ativou.
Guarde as alterações.
Publique e faça a gestão da app no ChatGPT
Criar a app de rascunho não a disponibiliza automaticamente aos membros. Depois de rever o rascunho:
Publique a app de rascunho.
Confirme que a app aparece em Definições do espaço de trabalho > Apps > Ativadas.
Configure Acesso de utilizador para as funções que a devem utilizar.
Reveja Controlo de ações para ações de leitura e escrita.
Reveja Permissões da app para escolher quando o ChatGPT pede aos membros autorização antes de usar a app.
Peça a um utilizador de teste autorizado para abrir Apps no ChatGPT e confirmar que a app aparece.
Estas permissões da app aplicam-se às conversas do ChatGPT. Os Agentes do espaço de trabalho usam controlos por agente definidos pelo criador do agente para determinar que ações da app estão disponíveis e quando os utilizadores finais são convidados a aprová-las. Para o comportamento dos agentes, consulte: Agentes do espaço de trabalho do ChatGPT para Enterprise e Business.
Instale e teste a GitHub App
No GitHub Enterprise, instale a app GitHub 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 ligação a partir do ChatGPT como utilizador autorizado.
Autorize a app GitHub quando solicitado.
Execute primeiro uma pequena ação de leitura, como listar repositórios acessíveis ou obter uma pull request conhecida.
Se as ações de escrita estiverem ativadas, teste com um repositório de baixo risco antes de uma implementação mais ampla.
Nome de anfitrião e comportamento OAuth
O ChatGPT utiliza o nome de anfitrião para derivar endpoints do GitHub Enterprise. Introduza apenas o anfitrião, como github.example.com ou octocorp.ghe.com.
Não introduza um caminho de API, um caminho de repositório nem github.com, a menos que seja o anfitrião GitHub Enterprise exato para esta app.
Resolução de problemas
Incompatibilidade do URI de redirecionamento: confirme que o URL de callback da GitHub App corresponde exatamente ao URL de callback apresentado no ChatGPT.
O ChatGPT não consegue criar ou guardar a app de rascunho: confirme que todos os campos obrigatórios estão presentes, incluindo nome de anfitrião, ID de cliente OAuth, segredo do cliente OAuth, chave privada e segredo de webhook.
A autenticação é bem-sucedida, mas as chamadas ao repositório falham: confirme que a GitHub App está instalada e tem acesso ao repositório.
A API devolve 403 ou permissões insuficientes: adicione a permissão da GitHub App em falta e peça ao proprietário da instalação para aprovar as permissões atualizadas, se solicitado.
Não aparecem repositórios: confirme que a instalação da app inclui os repositórios esperados e que o utilizador que autoriza no ChatGPT tem acesso aos mesmos.
As entregas de webhook falham: confirme que o URL de webhook e o segredo de webhook correspondem aos valores do ChatGPT, mantenha a verificação SSL ativada e certifique-se de que o anfitrião GitHub Enterprise consegue aceder a
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.