En esta guía se explica cómo configurar la aplicación de GitHub de Mintlify en tu instalación de GitHub Enterprise Server (GHES). Para conectar una instancia de GHES a Mintlify, debes crear una versión local de nuestra aplicación dentro de tu entorno autoalojado que se comunique con nuestro servidor remoto. Si usas una instancia de GitHub alojada en la nube, consulta la página de GitHub para ver las instrucciones de configuración.Documentation Index
Fetch the complete documentation index at: https://www.mintlify.com/docs/llms.txt
Use this file to discover all available pages before exploring further.
Requisitos previos
- Privilegios de administrador en tu organización de GitHub Enterprise Server donde deseas instalar la aplicación
- Acceso a los repositorios de tu organización donde deseas instalar la aplicación
- Conectividad de red para comunicarte con nuestros servicios externos (consulta la sección Requisitos de red a continuación)
Requisitos de red
Conectividad saliente
- Los endpoints de la API de Mintlify (https://leaves.mintlify.com)
- Los receptores de webhooks (puerto 443)
Configuración del firewall
- Conexiones desde la IP estática de Mintlify:
54.242.90.151 - HTTPS (puerto 443) a los dominios de servicio de Mintlify
- Resolución de DNS para los dominios de servicio de Mintlify
Paso 1: Registrar la aplicación de GitHub
Ve a la configuración de tu organización
- En la esquina superior derecha de cualquier página de GitHub, haz clic en tu foto de perfil.
- Haz clic en Your organizations.
- Haz clic en Settings junto a la organización para la que quieres crear la aplicación.
Crea una nueva aplicación de GitHub
- En la barra lateral izquierda, haz clic en Developer settings.
- Haz clic en GitHub Apps.
- Haz clic en New GitHub App.
Paso 2: Configurar los permisos de la aplicación
Configurar permisos del repositorio
Establece los siguientes permisos para la aplicación. No se requieren permisos de organización, cuenta ni Enterprise:
- Checks: Lectura y escritura
- Contents: Lectura y escritura
- Deployments: Lectura y escritura
- Metadata: Solo lectura
- Pull Requests: Lectura y escritura
Paso 3: Generar y proteger credenciales
Generar clave privada
- Desplázate hacia abajo hasta la sección Private keys.
- Haz clic en Generate a private key.
- Descarga el archivo
.pemy guárdalo de forma segura.
Paso 4: Instalar la app
Ir a la instalación de la app
- Desde la página de configuración de la app, haz clic en Install App en la barra lateral izquierda.
- Selecciona tu organización de la lista.
Elegir el alcance de la instalación
Selecciona una de las siguientes opciones:
- All repositories (para acceso en toda la organización)
- Only select repositories (elige repositorios específicos)
Paso 5: Configurar la URL del webhook
Volver a la configuración de la aplicación
- Regresa a la página de configuración de tu aplicación.
- Desplázate hasta la sección Webhook.
Configurar la URL del webhook
Configura lo siguiente:
- Webhook URL:
https://leaves.mintlify.com/github-enterprise/:subdomain(reemplaza:subdomaincon la URL que te proporcionemos) - Webhook secret: Genera una cadena aleatoria (de 32 caracteres o más) y guárdala de forma segura. Mintlify también puede generarla y proporcionártela.
Credenciales requeridas
- URL base de GitHub Enterprise Server: https://your-github-server.com
- ID de la aplicación (App ID): (del paso 3)
- ID de cliente de la aplicación (App client ID): (del paso 3)
- Secreto de cliente de la aplicación (App client secret): (del paso 3)
- ID de la instalación (Installation ID): (del paso 4)
- Clave privada: Todo el contenido del archivo
.pem(debe compartirse mediante transferencia segura de archivos) - Secreto del webhook (Webhook secret): (del paso 5)
Credenciales opcionales para la resolución de problemas
- Organization name: El nombre de tu organización en GitHub
- Repository names: Nombres de los repositorios específicos donde la aplicación está instalada
- GitHub Enterprise Server version: La encontrarás en el panel de administración de tu sitio
Conexión con Mintlify
- Integrar tu entorno GHES con un despliegue existente de Mintlify.
- Integrar tu entorno GHES con un nuevo despliegue de Mintlify que aprovisionamos para ti.
La URL del webhook puede cambiar según nuestra configuración. Probamos la integración y te proporcionamos la nueva URL.
Probar la integración
Verificar la entrega del webhook
- Ve a la configuración de tu GitHub App.
- Haz clic en la pestaña Advanced.
- Revisa “Recent Deliveries” para comprobar que haya entregas de webhook correctas.
- Busca respuestas HTTP 200.
Preguntas frecuentes y solución de problemas
La instalación de la app falla con errores de permisos.
La instalación de la app falla con errores de permisos.
Asegúrate de tener:
- Privilegios de administrador del sitio para la creación de la app.
- Derechos de propietario o administrador de la organización para la instalación de la app.
- Permisos adecuados sobre el repositorio si la instalas en repositorios específicos.
Los webhooks no se están entregando
Los webhooks no se están entregando
- Verifica que la URL del webhook sea correcta y accesible.
- Asegúrate de que tu firewall permita conexiones salientes mediante HTTPS.
- Comprueba que el secreto del webhook coincida con lo configurado.
- Revisa los registros de entrega de webhooks en la pestaña “Advanced” de la configuración de tu GitHub App.
Tengo errores de certificado SSL/TLS
Tengo errores de certificado SSL/TLS
Tu GHES podría usar certificados autofirmados. Nuestros servicios no pueden verificar el certificado de tu servidor.Solución: Asegúrate de que tu GHES tenga un certificado SSL válido.
La app se instala, pero no responde a los eventos.
La app se instala, pero no responde a los eventos.
- Asegúrate de que los webhooks se estén entregando y sean reconocidos por nuestro servidor con un código de respuesta 200.
- Verifica que se hayan otorgado los permisos necesarios durante la instalación.
¿Puedo limitar a qué repositorios accede la app?
¿Puedo limitar a qué repositorios accede la app?
Sí, durante la instalación puedes seleccionar “Only select repositories” y elegir repositorios específicos. Puedes modificar esto más adelante en la configuración de apps instaladas de tu organización. Esta es la forma de instalación recomendada.
¿Cómo actualizo los permisos de la app más adelante?
¿Cómo actualizo los permisos de la app más adelante?
- Ve a la configuración de la app como administrador del sitio.
- Modifica los permisos según sea necesario.
- La app necesita ser aprobada de nuevo por los propietarios de la organización.
- Avísanos de cualquier cambio de permisos para que podamos aconsejarte sobre cualquier paso adicional que pueda ser necesario.
Nuestro GHES está detrás de un firewall corporativo, un proxy nginx u otra configuración similar.
Nuestro GHES está detrás de un firewall corporativo, un proxy nginx u otra configuración similar.
Debes:
- Agregar nuestros dominios de servicio a la lista de permitidos (allowlist) de tu firewall.
- Asegurar la conectividad saliente mediante HTTPS (puerto 443).
- Si no se permite el acceso directo a Internet, configura un proxy.
¿Puede funcionar esto con GHES en entornos aislados (air-gapped)?
¿Puede funcionar esto con GHES en entornos aislados (air-gapped)?
No, tu GHES debe poder comunicarse con nuestro servidor en la nube.
¿Con quién debo contactar si necesito ayuda?
¿Con quién debo contactar si necesito ayuda?
Ponte en contacto con tu representante de customer success con quien ya hayas hablado en Mintlify, o con nuestro equipo de soporte en support@mintlify.com con:
- Tu versión de GitHub Enterprise Server.
- Mensajes de error específicos.
- Capturas de pantalla de cualquier problema.
- Detalles de configuración de red/firewall (si corresponde).