Visão geral
Utilize este guia se for administrador de um espaço de trabalho do ChatGPT e estiver a configurar o modelo de aplicação GitHub Enterprise para a sua organização. Um modelo não é a aplicação final que os membros utilizam. É um processo de configuração que cria um rascunho de aplicação específico do espaço de trabalho depois de fornecer a configuração necessária do GitHub Enterprise.
No caso do GitHub Enterprise, a configuração liga o ChatGPT ao anfitrião do GitHub Enterprise da sua organização. Crie uma GitHub App, registe o URL de callback do ChatGPT, gere as credenciais e, em seguida, cole esses valores no processo de configuração do modelo no ChatGPT. Depois de o ChatGPT criar o rascunho da aplicação, pode publicá-lo e gerir a aplicação como as restantes aplicações do espaço de trabalho.
Para saber mais sobre a navegação no espaço de trabalho e o acesso às aplicações, consulte: Controlos de administração, segurança e conformidade para plugins e aplicações.
O que vai configurar
Vai criar uma aplicação GitHub Enterprise no ChatGPT específica do seu espaço de trabalho. A aplicação utiliza:
Uma GitHub App registada no seu anfitrião do GitHub Enterprise.
O ID de cliente e o segredo de cliente da GitHub App para a autorização OAuth dos utilizadores.
A chave privada da GitHub App para que o ChatGPT possa gerar tokens de instalação para operações nos repositórios.
Um segredo e um URL de webhook para que o GitHub Enterprise possa enviar eventos de instalação e de repositório para o ChatGPT.
O nome do seu 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 no 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 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 anfitrião do GitHub Enterprise, sem
https://nem um caminho.Uma decisão sobre as ações em repositórios que o ChatGPT deve suportar, como pesquisa de repositórios só de leitura, fluxos de trabalho com pull requests ou incidências, edição de ficheiros, GitHub Actions ou fluxos de trabalho mais abrangentes do Codex.
Um local seguro para gerir a chave privada e o segredo de cliente da GitHub App.
Mantenha o ChatGPT e o GitHub Enterprise abertos em separadores diferentes. Não invente o URL de callback. Copie o URL de callback exato apresentado no ChatGPT.
Valores a preparar
Nome do anfitrião do GitHub Enterprise: por exemplo,
github.example.com.URL de callback: copie-o do processo de configuração do modelo no ChatGPT.
ID de cliente da GitHub App.
Segredo de cliente da GitHub App.
Chave privada PEM da GitHub App.
Segredo do webhook gerado pelo ChatGPT.
URL do webhook gerado após a criação do rascunho da aplicação no ChatGPT.
Iniciar a configuração do modelo no ChatGPT
No ChatGPT, mude para o espaço de trabalho onde a aplicação deve ficar disponível.
Abra Definições do espaço de trabalho > Aplicações. Também pode aceder à Consola de administração, selecionar o espaço de trabalho do ChatGPT pretendido e abrir Plugins. Selecione Gerir aplicações legadas para abrir a página Aplicações que foi mantida.
Selecione Diretório.
Pesquise GitHub Enterprise.
Selecione o modelo de aplicação GitHub Enterprise e inicie a configuração.
Introduza um nome e uma descrição claros para a aplicação, como GitHub Enterprise ou GitHub Enterprise - Engenharia.
Introduza o nome do anfitrião do GitHub Enterprise, como
github.example.com.Copie o URL de callback apresentado no ChatGPT. Mantenha este separador aberto.
Copie o segredo do 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 acrescente uma barra no final nem o substitua por um URL genérico do ChatGPT.
Criar a aplicação GitHub no GitHub Enterprise
Aceda ao servidor do GitHub Enterprise, por exemplo,
https://github.example.com.Aceda à organização ou conta que deve ser proprietária da aplicação.
Abra Definições > Definições de programador > Aplicações GitHub.
Selecione Nova aplicação GitHub.
Introduza um nome claro para a aplicação, como ChatGPT GitHub Enterprise.
Introduza um URL da página inicial. Se não existir uma página interna dedicada, utilize o URL da organização no GitHub Enterprise.
Em URL de retorno, cole o URL de retorno exato que copiou do ChatGPT.
Mantenha a opção Expirar tokens de autorização de utilizador ativada, a menos que a sua equipa de segurança tenha um motivo específico para a alterar.
Ative Pedir autorização ao utilizador durante a instalação para que os utilizadores possam autorizar a aplicação durante o processo de instalação ou ligação.
Em «Onde pode ser instalada esta aplicação GitHub?», escolha a opção mais restrita que se adeque à sua implementação.
Crie a aplicação GitHub.
Configurar permissões e eventos
Escolha as permissões mínimas necessárias para as ações do ChatGPT que pretende ativar.
Para descobrir repositórios e fazer perguntas e obter respostas em modo só de leitura, comece por permissões de leitura como:
Metadados: só de leitura. O GitHub exige acesso aos metadados para as GitHub Apps.
Conteúdos: só de leitura, para aceder ao conteúdo dos ficheiros e dos repositórios.
Incidências: só de leitura, se for necessário pesquisar ou ler incidências.
Pull requests: só de leitura, se for necessário pesquisar pull requests ou obter contexto para a sua revisão.
Ações: só de leitura, se for necessário aceder ao estado de execução dos fluxos de trabalho, tarefas, registos ou artefactos.
Para fluxos de trabalho com operações de escrita, adicione permissões de escrita apenas onde for necessário, como em Conteúdos, Pull requests, Incidências, Ações ou Fluxos de trabalho. Utilize as permissões mais restritas que permitam executar as ações pretendidas no ChatGPT.
Os eventos do webhook devem corresponder aos fluxos de trabalho que disponibiliza. Os eventos comuns incluem Instalação, Repositórios da instalação, Push, Pull request, Incidências, Comentário de incidência, Execução de fluxo de trabalho e Tarefa de fluxo de trabalho.
Gerar e copiar as credenciais da GitHub App
Nas definições da GitHub App, copie o ID de cliente.
Gere um Segredo de 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 todo o texto PEM, incluindo as linhas de início e de fim.
A chave privada é informação sensível. Trate-a como uma credencial. Se for exposta, gere uma nova chave privada, atualize a configuração da aplicação no ChatGPT e elimine a chave comprometida no GitHub Enterprise.
Concluir a configuração no ChatGPT
Volte ao separador de configuração do modelo no ChatGPT.
Cole o ID de cliente da GitHub App em ID de cliente OAuth.
Cole o segredo de cliente da GitHub App em Segredo de cliente OAuth.
Mantenha os Âmbitos inalterados, a menos que a sua organização precise de substituir deliberadamente os valores predefinidos do modelo.
Confirme que o nome do anfitrião do GitHub Enterprise contém apenas o nome, como
github.example.com.Cole ou carregue a chave privada PEM da GitHub App no campo Chave privada da GitHub App.
Confirme que o segredo do webhook gerado está presente.
Crie o rascunho da aplicação.
Abra os detalhes do rascunho da aplicação criado no ChatGPT e copie o URL do webhook gerado.
O URL do webhook deve ter este formato: https://connectors.api.openai.org/connectors/<connector_id>/webhook
Concluir a configuração do webhook no GitHub Enterprise
Volte às definições da GitHub App no GitHub Enterprise.
Abra as definições Gerais da GitHub App.
Ative a opção Webhooks ativos, se ainda não estiver ativada.
Cole o URL do webhook do ChatGPT em URL do webhook.
Cole o segredo do webhook do ChatGPT em Segredo do webhook.
Mantenha a verificação SSL ativada.
Confirme que os eventos do webhook subscritos correspondem às permissões e ações que ativou.
Guarde as alterações.
Publicar e gerir a aplicação no ChatGPT
Criar o rascunho da aplicação não a disponibiliza automaticamente aos membros. Depois de rever o rascunho:
Publique o rascunho da aplicação.
Nas definições do espaço de trabalho, abra a página Aplicações, abra Ativadas e confirme que a aplicação aparece. Também pode abrir a página Aplicações através de Gerir aplicações legadas, em Consola de administração > Plugins.
Nos planos Enterprise e Edu, utilize Acesso de utilizadores para escolher que funções podem utilizar a aplicação. No plano Business, gira a disponibilidade da aplicação em todo o espaço de trabalho.
Reveja o Controlo de ações para as ações de leitura e escrita.
Reveja as Permissões da aplicação para escolher quando o ChatGPT pede autorização aos membros antes de utilizar a aplicação.
Peça a um utilizador de teste com acesso autorizado que abra Aplicações no ChatGPT e confirme que a aplicação aparece.
Estas permissões da aplicação aplicam-se às conversas no ChatGPT. Os agentes do espaço de trabalho utilizam controlos individuais definidos pelo criador de cada agente para determinar que ações da aplicação estão disponíveis e quando é pedida a aprovação dos utilizadores finais. Para saber mais sobre o comportamento dos agentes, consulte: Agentes do espaço de trabalho do ChatGPT para Enterprise e Business.
Instalar e testar a GitHub App
No GitHub Enterprise, instale a aplicação GitHub na organização ou conta.
Escolha todos os repositórios ou apenas alguns, de acordo com a política do espaço de trabalho.
Inicie o processo de ligação a partir do ChatGPT com um utilizador autorizado.
Autorize a aplicação GitHub quando tal for solicitado.
Execute primeiro uma ação de leitura simples, como listar os repositórios acessíveis ou obter uma pull request conhecida.
Se as ações de escrita estiverem ativadas, teste num repositório de baixo risco antes de alargar a implementação.
Nome do anfitrião e comportamento do OAuth
O ChatGPT utiliza o nome do anfitrião para determinar os endpoints do GitHub Enterprise. Introduza apenas o nome do 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 esse seja exatamente o anfitrião do GitHub Enterprise desta aplicação.
Resolução de problemas
O URI de redirecionamento não corresponde: 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 o rascunho da aplicação: confirme que todos os campos obrigatórios estão preenchidos, incluindo o nome do anfitrião, o ID de cliente OAuth, o Segredo de cliente OAuth, a chave privada e o segredo do 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 o erro 403 ou indica permissões insuficientes: adicione a permissão em falta à GitHub App e peça ao proprietário da instalação que aprove as permissões atualizadas, se tal for solicitado.
Não aparecem repositórios: confirme que a instalação da aplicação inclui os repositórios esperados e que o utilizador que está a conceder autorização no ChatGPT tem acesso aos mesmos.
As entregas do webhook falham: confirme que o URL e o segredo do webhook correspondem aos valores do ChatGPT, mantenha a verificação SSL ativada e certifique-se de que o anfitrião do GitHub Enterprise consegue aceder a
connectors.api.openai.org.Erros de chave privada: confirme que copiou todo o conteúdo PEM, incluindo as linhas de início e de fim.