Installing GitHub Insights

Pré-requisitos

• You must have a GitHub Enterprise license file that includes GitHub Insights. After you purchase GitHub Insights, you can download the updated license file in the GitHub Enterprise web portal.

• GitHub Insights precisa de uma máquina, chamada de servidor do aplicativo, hospedado na nuvem ou localmente. For more information, see "System overview for GitHub Insights."

• You must install dependencies on the application server.

  • Docker 1.13.0+
  • Docker Compose v1.17.0+

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

Criar um aplicativo GitHub

To connect GitHub Insights to GitHub Enterprise, you must create a aplicativo GitHub in an organization on GitHub Enterprise. A slugged version of your app's name will be shown on GitHub Enterprise when your integration takes an action.

1. Faça login no sua instância do GitHub Enterprise Server em http(s)://HOSTNAME/login.

2. Navigate to the organization you'd like to connect to GitHub Insights.

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

   

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

   

5. Click New aplicativo GitHub.

   

6. Under "aplicativo GitHub name", type a name for the app. Your app cannot have the same name as an existing user or organization, unless the name is your own user or organization name.

   

7. Under "Homepage URL", type the URL of the application server for GitHub Insights. For more information, see "System overview for GitHub Insights."

   

8. Under "User authorization callback URL", type the following, replacing <application-server-url> with the URL of the application server.

   <application-server-url>/public/applogin
   

   

9. Under "Setup URL", type <application-server-url>/public/setup.

   

10. Under "Webhook URL", type <application-server-url>/webhooks.

    

11. Under "Webhook secret", type a secret, then record the secret for later reference.

    

12. Under "Permissions", use the drop-down menus and configure the following permissions for the app.

    • Repositório:
      • Contents: Read-only
      • Metadata: Read-only
      • Pull requests: Read-only
      • Commit statuses: Read-only
    • organização:
      • Members: Read-only
      • Projects: Read-only
    

13. Under "Subscribe to events", select:

    • Member
    • Pull request
    • Push
    • Repositório
    • Team
      

14. To enable the aplicativo GitHub to access data from any user or organization in sua instância do GitHub Enterprise Server, under "Where can this aplicativo GitHub be installed?", select Any account.

    

15. Click Create aplicativo GitHub.

    

16. Review your app's configuration.

17. Under "Private keys", click Generate a private key.

    

18. Save the resulting PEM file for later reference.

19. Make note of the following information about your app for later reference.

    • App ID
    • Client ID
    • Client secret
    • Private key
    • Webhook secret

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.
   
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;

To configure GitHub Insights to connect to GitHub Enterprise Server, you must provide the information you recorded in previous steps.

1. In your browser, navigate to <application-server-url>/setup.
2. Em "GitHub API URL", digite a URL que você usa para acessar GitHub Enterprise.
   
3. Em "GitHub Insights License", clique em "Choose Files", e faça o upload do arquivo de licença do GitHub Enterprise.
   
4. Em "App ID", digite o App ID do seu aplicativo GitHub, que você gravou ao criar o aplicativo.
   
5. Em "Client ID" (ID do cliente), digite o ID do cliente do seu aplicativo GitHub, que você gravou ao criar o aplicativo.
   
6. Em "Client Secret" (Segredo do Cliente), digite o segredo do cliente do seu aplicativo GitHub, que você gravou ao criar o aplicativo.
   
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.
   
8. Em "Webhook Secret", digite o segredo de webhook do seu aplicativo GitHub, que você gravou ao criar o aplicativo.
   
9. Se você não forneceu um certificado SSL durante a instalação, selecione Skip SSL Certificate Check.
   
10. Clique em Submit (Enviar).
11. Click Log in with GitHub.
12. To authorize the aplicativo GitHub and access GitHub Insights, click Authorize aplicativo GitHub.

Leia mais

• "Managing repositories"
• "GitHub Insights and data protection for your organization"