Prerrequisitos
-
Debes tener un archivo de licencia GitHub Enterprise que incluya GitHub Insights. Después de comprar GitHub Insights, puedes descargar el archivo de licencia actualizado en el portal web GitHub Enterprise.
-
GitHub Insights requiere una máquina, llamada servidor de la aplicación, hospedada ya sea en la nube o localmente. Para obtener más información, consulta "Descripción general del sistema para GitHub Insights".
-
Debes instalar dependencias en el servidor de aplicaciones.
- Docker 1.13.0 +
- Docker Compose v1.17.0+
Nota: El servidor de aplicaciones puede requerir que el demonio de Docker se ejecute como sudo. Kubernetes no es compatible.
Crear un App GitHub
Para conectar GitHub Insights a GitHub Enterprise, debes crear un App GitHub en una organización en GitHub Enterprise. Se mostrará una versión con slugged del nombre de tu app en GitHub Enterprise cuando tu integración realiza una acción.
-
Ingresa en tu instancia de servidor de GitHub Enterprise a través de
http(s)://HOSTNAME/login. -
Navega hasta la organización a la que deseas conectarte GitHub Insights.
-
Debajo de tu nombre de organización, da clic en Configuración.
-
En la barra lateral izquierda, haz clic en App GitHubs.
-
Haz clic en New (nuevo) App GitHub.
-
En "Name (nombre) App GitHub", escribe un nombre para la app. Tu app no puede tener el mismo nombre que un usuario o una organización existente, a menos que el nombre sea tu propio nombre de usuario o de organización.
-
En "Homepage URL" (URL de página principal), escribe la URL del servidor de aplicaciones para GitHub Insights. Para obtener más información, consulta "Descripción general del sistema para GitHub Insights".
-
En "User authorization callback URL" (URL de llamada de vuelta de autorización del usuario), escribe lo siguiente, reemplazando
<application-server-url>con la URL del servidor de aplicaciones.<application-server-url>/Public/applogin
-
En "Setup URL" (configurar URL), escribe
<application-server-url>/public/setup.
-
En "Webhook URL" (URL de webhook), escribe
<application-server-url>/webhooks.
-
En "Secreto de webhook", escribe un secreto y luego graba el secreto para una referencia posterior.
-
En "Permissions" (permisos), usa los menús desplegables y configura los siguientes permisos para la app.
- Repositorio:
- Contenido: De solo lectura
- Metadatos: De solo lectura
- Solicitudes de extracción: De solo lectura
- Estados de confirmación: De solo lectura
- Organización:
- Miembros: De solo lectura
- Proyectos: De solo lectura
- Repositorio:
-
En "Subscribe to Events" (suscribirse a eventos), selecciona:
- Miembro
- Solicitud de extracción
- Subir
- Repositorio
- Equipo
-
Para habilitar el App GitHub para acceder a los datos de cualquier usuario u organización en tu instancia de servidor de GitHub Enterprise, en "¿Dónde puede App GitHub ser instalado? ", selecciona Cualquier cuenta.
-
Haz clic en Create (crear) App GitHub.
-
Revisa la configuración de tu app.
-
En "Private Keys" (claves privadas), haz clic en Generar una clave privada.
-
Guarda el archivo PEM resultante para una referencia posterior.
-
Anota la siguiente información acerca de tu app para una referencia posterior.
- ID de app
- ID de cliente
- Secreto del cliente
- Llave privada
- Secreto de webhook
Instalar GitHub Insights
- Desde el servidor de la aplicación, navega hasta el último lanzamiento de GitHub Insights en la Página de lanzamientos para
github/insights-releases. - Para descargar el último lanzamiento, debajo de "Activos", da clic en
insights-VERSION.tar.gz.
- Descomprime el directorio.
- Ejecuta el script del shell
Install.sh. - Para habilitar SSL, ingresa el certificado SSL (
.crt/.cer/.pem). Si no quieres habilitar SSL, déjalo en blanco. - Si eliges habilitar SSL, ingresa la llave SSL (
.key). De lo contrario, déjalo en blanco. - Ingresa el nombre del host, el cual es la misma URL que utilizas para el servidor de la aplicación cuando creas la App GitHub.
- La instalación tardará unos minutos en ejecutarse. Una vez que esté completo, verás un mensaje impreso en el terminal.
Installation complete Run /opt/insights/scripts/start.sh to start GitHub Insights - Para iniciar con GitHub Insights, ejecuta el script del shell
/opt/insights/scripts/start.sh. - Si es la primera vez que inicias GitHub Insights, el script tomará algunos minutos en ejecutarse. Una vez que esté completo, verás un mensaje impreso en el terminal.
GitHub Insights is running!
Configurar GitHub Insights
Para configurar GitHub Insights para conectarse a Servidor de GitHub Enterprise, debes proporcionar la información que grabaste en los pasos anteriores.
- En tu navegador, desplázate hasta
<application-server-url>/setup. - Debajo de "URL de la API de GitHub", teclea la URL que utilizas para acceder a GitHub Enterprise.
- Debajo de "Licencia de GitHub Insights", da clic en "Escoger Archivos", y luego carga tu archivo de licencia de GitHub Enterprise.
- Debajo de "App ID", teclea la ID de la App de tu App GitHub, la cual grabaste cuando creaste dicha app.
- Debajo de "ID de Cliente", teclea la ID de cliente de tu App GitHub, la cual grabaste cuando creaste la app.
- Debajo de "Secreto de Cliente", teclea el secreto del cliente de tu App GitHub, el cual grabaste cuando creaste la app.
- Debajo de "Llave Privada", teclea la llave privada de tu App GitHub, la cual se contiene en el archivo PEM que descargaste mientras creabas la app.
- Debajo de "Secretod e Webhook", teclea el secreto de webhook de tu App GitHub, el cual grabaste cuando la creaste.
- Si no proporcionaste un certificado SSL durante la instalación, selecciona Saltar Verificación de Certificado SSL.
- Haz clic en Submit (enviar).
- Haz clic en Log in with (inicia sesión con) GitHub.
- Para autorizar el App GitHub y acceder a GitHub Insights, haz clic en Authorize (autorizar) App GitHub.