Saltar al contenido principal
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.

​
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

Tu servidor de GitHub Enterprise debe poder acceder a:

​
Configuración del firewall

Se deben permitir las siguientes conexiones salientes:
  • 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

Consulta Registrar una aplicación de GitHub en la documentación de GitHub para obtener instrucciones detalladas.
1

Ve a la configuración de tu organización

  1. En la esquina superior derecha de cualquier página de GitHub, haz clic en tu foto de perfil.
  2. Haz clic en Your organizations.
  3. Haz clic en Settings junto a la organización para la que quieres crear la aplicación.
2

Crea una nueva aplicación de GitHub

  1. En la barra lateral izquierda, haz clic en Developer settings.
  2. Haz clic en GitHub Apps.
  3. Haz clic en New GitHub App.
3

Configura la información básica de la aplicación

Configura lo siguiente:
  • GitHub App name: Mintlify
  • Description: Integration with Mintlify services
  • Homepage URL: https://mintlify.com
  • User authorization callback URL: https://your-github-server.com/ (reemplaza con tu dominio real de GHES)

​
Paso 2: Configurar los permisos de la aplicación

1

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
2

Suscribirse a eventos

Selecciona los siguientes eventos de webhook:
  • Installation
  • Installation Target
  • Create
  • Delete
  • Public
  • Pull Request
  • Push
  • Repository

​
Paso 3: Generar y proteger credenciales

1

Crear la app

Haz clic en Create GitHub App.Se te redirigirá a la página de configuración de la app.
2

Generar clave privada

  1. Desplázate hacia abajo hasta la sección Private keys.
  2. Haz clic en Generate a private key.
  3. Descarga el archivo .pem y guárdalo de forma segura.
3

Anotar credenciales de la app

Toma nota de lo siguiente:
  • App ID (visible en la parte superior de la página de configuración)
  • Client ID (en la sección “About”)
  • Client Secret (genéralo y guárdalo de forma segura)

​
Paso 4: Instalar la app

1

Ir a la instalación de la app

  1. Desde la página de configuración de la app, haz clic en Install App en la barra lateral izquierda.
  2. Selecciona tu organización de la lista.
2

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)
Recomendamos seleccionar Only select repositories y limitar la app solo a los repositorios donde se encuentra tu documentación.
3

Completar la instalación

  1. Haz clic en Install.
  2. Anota el ID de instalación de la URL. Por ejemplo, en https://your-github-server.com/settings/installations/12345, la cadena 12345 es el ID de instalación.

​
Paso 5: Configurar la URL del webhook

1

Volver a la configuración de la aplicación

  1. Regresa a la página de configuración de tu aplicación.
  2. Desplázate hasta la sección Webhook.
2

Configurar la URL del webhook

Configura lo siguiente:
  • Webhook URL: https://leaves.mintlify.com/github-enterprise/:subdomain (reemplaza :subdomain con 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.

​
Comparte las credenciales con nosotros

Comparte la siguiente información con nuestro equipo utilizando tu método preferido de transferencia segura de información.

​
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

Recibimos las credenciales que nos proporcionas y las almacenamos cifradas en una ubicación segura. Luego trabajamos contigo para:
  • Integrar tu entorno GHES con un despliegue existente de Mintlify.
  • Integrar tu entorno GHES con un nuevo despliegue de Mintlify que aprovisionamos para ti.
Una vez que tu entorno GHES esté integrado con un despliegue de Mintlify, podrás habilitar los webhooks de tu GitHub App.
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

1

Verificar la entrega del webhook

  1. Ve a la configuración de tu GitHub App.
  2. Haz clic en la pestaña Advanced.
  3. Revisa “Recent Deliveries” para comprobar que haya entregas de webhook correctas.
  4. Busca respuestas HTTP 200.
2

Probar el acceso al repositorio

  1. Crea un issue o pull request de prueba en un repositorio instalado.
  2. Asegúrate de que Mintlify responda correctamente.

​
Preguntas frecuentes y solución de problemas

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.
  • 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.
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.
  • 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.
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.
  • Ve a la configuración de la app como administrador del sitio.
  • Modifica los permisos según sea necesario.
  • La app deberá volver a ser aprobada por los propietarios de la organización.
  • Avísanos de cualquier cambio de permisos, ya que puede afectar a la funcionalidad.
Debes:
  • Incluir nuestros dominios de servicio en la lista blanca de tu firewall.
  • Asegurar la conectividad saliente mediante HTTPS (puerto 443).
  • Si no se permite el acceso directo a Internet, configura un proxy.
No, tu GHES debe poder comunicarse con nuestro servidor en la nube.
Ponte en contacto con tu representante de customer success con quien ya hayas hablado en Mintlify, o con nuestro equipo de soporte en [email protected] 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).