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.
- Docker 1.13.0+
- Docker Compose v1.17.0+
- netcat, disponível via apt para Debian e Ubuntu
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.
-
Faça login no sua instância do GitHub Enterprise Server em
http(s)://HOSTNAME/login. -
Navegue até a organização que você gostaria de conectar ao GitHub Insights.
-
No nome da sua organização, clique em Settings.
-
Na barra lateral esquerda, clique em aplicativo GitHubs.
-
Clique em Novo aplicativo GitHub.
-
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.
-
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".
-
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
-
Em "Setup URL", digite
<application-server-url>/public/setup.
-
Em "Webhook URL" (URL do webhook), digite
<application-server-url>/webhooks.
-
Em "Segredo do webhook", digite um segredo e, em seguida, grave o segredo para referência posterior.
-
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
- Repositório:
-
Em "Assinar eventos", selecione:
- Integrante
- Pull request
- Push
- Repositório
- Equipe
-
Para habilitar o aplicativo GitHub para acessar dados de qualquer usuário ou organização em sua instância do GitHub Enterprise Server, em "Onde este aplicativo GitHub pode ser instalado? , selecione Qualquer conta.
-
Clique em Criar aplicativo GitHub.
-
Revise a configuração do seu aplicativo.
-
Em "Chaves privadas", clique em Gerar uma chave privada.
-
Salve o arquivo PEM resultante para referência posterior.
-
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
- Do servidor de aplicativos, acesse a versão mais recente de GitHub Insights na página de Versões para
github/insights-releases. - Para baixar a última versão, em "Assets", clique em
insights-VERSION.tar.gz.
- Descompacte o diretório.
- Execute o script shell
install.sh. - Para habilitar o SSL, digite o SSL Cert (
.crt/.cer/.pem). Se não quiser habilitar o SSL, deixe em branco. - Se você escolheu ativar o SSL, digite a SSL Key (
.key). Caso contrário, deixe em branco. - Digite o nome do host, que é a mesma URL que você usou para o servidor do aplicativo ao criar o aplicativo GitHub.
- 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 - Para iniciar o GitHub Insights, execute o script shell
/opt/insights/scripts/start.sh. - 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.
- No seu navegador, acesse
<application-server-url>/setup. - Em "URL da API de GitHub", digite a URL que você usa para acessar GitHub Enterprise.
- Em "GitHub Insights License", clique em "Choose Files", e faça o upload do arquivo de licença do GitHub Enterprise.
- Em "App ID", digite o App ID do seu aplicativo GitHub, que você gravou ao criar o aplicativo.
- Em "Client ID" (ID do cliente), digite o ID do cliente do seu aplicativo GitHub, que você gravou ao criar o aplicativo.
- Em "Client Secret" (Segredo do Cliente), digite o segredo do cliente do seu aplicativo GitHub, que você gravou ao criar o aplicativo.
- 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.
- Em "Webhook Secret", digite o segredo de webhook do seu aplicativo GitHub, que você gravou ao criar o aplicativo.
- Se você não forneceu um certificado SSL durante a instalação, selecione Skip SSL Certificate Check.
- Clique em Enviar.
- Clique Iniciar sessão com GitHub.
- Para autorizar o aplicativo GitHub e acessar GitHub Insights, clique em Autorizar aplicativo GitHub.