Publicamos atualizações frequentes em nossa documentação, e a tradução desta página ainda pode estar em andamento. Para obter as informações mais recentes, acesse a documentação em inglês. Se houver problemas com a tradução desta página, entre em contato conosco.

Instalar o GitHub Insights

Você pode instalar o GitHub Insights e conectar o aplicativo autônomo ao GitHub Enterprise Server.

Proprietários da organização em GitHub Enterprise com permissões de leitura para o repositório github/insights-releases e acesso de administrador ao servidor de aplicativos pode instalar o GitHub Insights.

GitHub Insights está disponível com GitHub One. Para obter mais informações, consulte os "Produtos da GitHub".

Neste artigo

Pré-requisitos

  • Você deve ter um arquivo de licença do GitHub Enterprise que inclui GitHub Insights. Após comprar GitHub Insights, você pode fazer o download do arquivo de licença atualizado no portal GitHub Enterprise.

  • GitHub Insights precisa de uma máquina, chamada de servidor do aplicativo, hospedado na nuvem ou localmente. Para obter mais informações, consulte "Visão geral do sistema para GitHub Insights".

  • Você precisa instalar dependências no servidor do aplicativo.

    Observação: O servidor do aplicativo pode exigir que o Docker daemon seja executado como sudo. Kubernetes não é suportado.

Criar aplicativo GitHub

Para conectar GitHub Insights a GitHub Enterprise, você deve criar um aplicativo GitHub em uma organização no GitHub Enterprise. Uma versão com slug do nome do seu aplicativo será exibida no GitHub Enterprise quando sua integração executar uma ação.

  1. Faça login no your GitHub Enterprise Server instance em http(s)://HOSTNAME/login.

  2. Acesse a organização à qual você deseja conectar-se GitHub Insights.

  3. No nome da sua organização, clique em Settings.

    Botão de configurações da organização

  4. Na barra lateral esquerda, clique em aplicativo GitHubs.

    aplicativo GitHubs configurações

  5. Clique em Novo aplicativo GitHub.

    Botão novo aplicativo do GitHub

  6. Em " nome de aplicativo GitHub" , digite um nome para o aplicativo. O seu aplicativo não pode ter o mesmo nome de um usuário ou organização existente, a menos que o nome seja o seu próprio usuário ou nome da organização.

    Campo do nome do aplicativo GitHub

  7. Em "URL da página inicial", digite a URL do servidor do aplicativo para o GitHub Insights. Para obter mais informações, consulte "Visão geral do sistema para o GitHub Insights".

    Campo de URL da página inicial

  8. Em "User authorization callback URL" (URL de retorno de chamada do usuário), digite o seguinte, substituindo <application-server-url> pela URL do servidor do aplicativo.

    <application-server-url>/public/applogin
    

    Campo de chamada de retorno de autorização do usuário

  9. Em "Setup URL", digite <application-server-url>/public/setup.

    Campo da URL de configuração

  10. Em "Webhook URL" (URL do webhook), digite <application-server-url>/webhooks.

    Campo da URL do webhook

  11. Em "Segredo do webhook", digite um segredo e, em seguida, grave o segredo para referência posterior.

    Campo secreto Webhook

  12. Em "Permissões", use os menus suspensos e configure as permissões a seguir para o aplicativo.

    • Repositório:
      • Conteúdo: Somente leitura
      • Metadados: Somente leitura
      • Pull requests: Somente leitura
      • Status do commit: Somente leitura
    • organização:
      • Integrantes: Somente leitura
      • Projetos: Somente leitura

    Menus suspenso de permissões

  13. Em "Assinar eventos", selecione:

    • Integrante
    • Pull request
    • Push
    • Repositório
    • Equipe
      Caixa de seleção para assinar eventos
  14. Para habilitar o aplicativo GitHub para acessar dados de qualquer usuário ou organização em your GitHub Enterprise Server instance, em "Onde este aplicativo GitHub pode ser instalado? , selecione Qualquer conta.

    Botões de opção para permitir acesso a qualquer conta

  15. Clique em Criar aplicativo GitHub.

    Botão Criar um aplicativo GitHub

  16. Revise a configuração do seu aplicativo.

  17. Em "Chaves privadas", clique em Gerar uma chave privada.

    Gerar um botão de chave privada

  18. Salve o arquivo PEM resultante para referência posterior.

  19. Anote as informações a seguir sobre seu aplicativo para referência posterior.

    • ID do aplicativo
    • ID do cliente
    • Segredo do cliente
    • Chave privada
    • Segredo do webhook

Instalar o GitHub Insights

  1. Do servidor do aplicativo, navegue até a versão mais recente do GitHub Insights na Releases page para github/insights-releases.
  2. Para baixar a última versão, em "Assets", clique em insights-VERSION.tar.gz.
    Configuração da instalação
  3. Descompacte o diretório.
  4. Execute o script shell install.sh.
  5. Para habilitar o SSL, digite o SSL Cert (.crt/.cer/.pem). Se não quiser habilitar o SSL, deixe em branco.
  6. Se você escolheu ativar o SSL, digite a SSL Key (.key). Caso contrário, deixe em branco.
  7. Digite o nome do host, que é a mesma URL que você usou para o servidor do aplicativo ao criar o aplicativo GitHub.
  8. A instalação levará alguns minutos para ser executada. Quando terminar, você verá uma mensagem impressa no terminal.
    Installation complete
    Run /opt/insights/scripts/start.sh to start GitHub Insights
    
  9. Para iniciar o GitHub Insights, execute o script shell /opt/insights/scripts/start.sh.
  10. Se esta for a primeira vez que GitHub Insights iniciar, o script levará alguns minutos para ser executado. Quando terminar, você verá uma mensagem impressa no terminal.
    GitHub Insights is running!
    

Configurar o GitHub Insights;

Para configurar o GitHub Insights para conectar-se a GitHub Enterprise Server, você deve fornecer as informações gravadas nas etapas anteriores.

  1. No seu navegador, acesse <application-server-url>/setup.
  2. Em "URL da API de GitHub", digite a URL que você usa para acessar GitHub Enterprise.
    GitHub Enterprise Campo de URL API
  3. Em "GitHub Insights License", clique em "Choose Files", e faça o upload do arquivo de licença do GitHub Enterprise.
    Escolha o botão Arquivos
  4. Em "App ID", digite o App ID do seu aplicativo GitHub, que você gravou ao criar o aplicativo.
    Campo App ID
  5. Em "Client ID" (ID do cliente), digite o ID do cliente do seu aplicativo GitHub, que você gravou ao criar o aplicativo.
    Campo Client ID
  6. Em "Client Secret" (Segredo do Cliente), digite o segredo do cliente do seu aplicativo GitHub, que você gravou ao criar o aplicativo.
    Campo secreto do cliente
  7. Em "Private Key" (Chave Privada), digite a chave privada do seu aplicativo GitHub, que está contido no arquivo PEM que você baixou ao criar o aplicativo.
    Campo chave privada
  8. Em "Webhook Secret", digite o segredo de webhook do seu aplicativo GitHub, que você gravou ao criar o aplicativo.
    Campo secreto Webhook
  9. Se você não forneceu um certificado SSL durante a instalação, selecione Skip SSL Certificate Check.
    Caixa de seleção para pular a verificação de certificado SSL
  10. Clique em Enviar.
  11. Clique Iniciar sessão com GitHub.
  12. Para autorizar o aplicativo GitHub e acessar GitHub Insights, clique em Autorizar aplicativo GitHub.

Leia mais

Esse documento ajudou você?

Privacy policy

Ajude-nos a tornar esses documentos ótimos!

Todos os documentos do GitHub são de código aberto. Você percebeu que algo que está errado ou não está claro? Envie um pull request.

Faça uma contribuição

Ou, aprenda como contribuir.