|
| 1 | +--- |
| 2 | +title: "GitHub Enterprise Server" |
| 3 | +description: "Configura la aplicación de GitHub en tu instalación de GitHub Enterprise Server." |
| 4 | +keywords: ["GitHub Enterprise Server", "GHES", "GitHub Enterprise"] |
| 5 | +--- |
| 6 | + |
| 7 | +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. |
| 8 | + |
| 9 | +Si usas una instancia de GitHub alojada en la nube, consulta la página de [GitHub](/es/deploy/github) para ver las instrucciones de configuración. |
| 10 | + |
| 11 | +<div id="prerequisites"> |
| 12 | + ## Requisitos previos |
| 13 | +</div> |
| 14 | + |
| 15 | +* Privilegios de administrador en tu organización de GitHub Enterprise Server donde deseas instalar la aplicación |
| 16 | +* Acceso a los repositorios de tu organización donde deseas instalar la aplicación |
| 17 | +* Conectividad de red para comunicarte con nuestros servicios externos (consulta la sección [Requisitos de red](#network-requirements) a continuación) |
| 18 | + |
| 19 | +<div id="network-requirements"> |
| 20 | + ### Requisitos de red |
| 21 | +</div> |
| 22 | + |
| 23 | +<div id="outbound-connectivity"> |
| 24 | + #### Conectividad saliente |
| 25 | +</div> |
| 26 | + |
| 27 | +Tu servidor de GitHub Enterprise debe poder acceder a: |
| 28 | + |
| 29 | +* Los endpoints de la API de Mintlify (https://leaves.mintlify.com) |
| 30 | +* Los receptores de webhooks (puerto 443) |
| 31 | + |
| 32 | +<div id="firewall-configuration"> |
| 33 | + #### Configuración del firewall |
| 34 | +</div> |
| 35 | + |
| 36 | +Se deben permitir las siguientes conexiones salientes: |
| 37 | + |
| 38 | +* Conexiones desde la IP estática de Mintlify: `54.242.90.151` |
| 39 | +* HTTPS (puerto 443) a los dominios de servicio de Mintlify |
| 40 | +* Resolución de DNS para los dominios de servicio de Mintlify |
| 41 | + |
| 42 | +<div id="step-1-register-the-github-app"> |
| 43 | + ## Paso 1: Registrar la aplicación de GitHub |
| 44 | +</div> |
| 45 | + |
| 46 | +Consulta [Registrar una aplicación de GitHub ](https://docs.github.com/en/[email protected]/apps/creating-github-apps/registering-a-github-app/registering-a-github-app) en la documentación de GitHub para obtener instrucciones detalladas. |
| 47 | + |
| 48 | +<Steps> |
| 49 | + <Step title="Ve a la configuración de tu organización"> |
| 50 | + 1. En la esquina superior derecha de cualquier página de GitHub, haz clic en tu foto de perfil. |
| 51 | + 2. Haz clic en **Your organizations**. |
| 52 | + 3. Haz clic en **Settings** junto a la organización para la que quieres crear la aplicación. |
| 53 | + </Step> |
| 54 | + |
| 55 | + <Step title="Crea una nueva aplicación de GitHub"> |
| 56 | + 1. En la barra lateral izquierda, haz clic en **Developer settings**. |
| 57 | + 2. Haz clic en **GitHub Apps**. |
| 58 | + 3. Haz clic en **New GitHub App**. |
| 59 | + </Step> |
| 60 | + |
| 61 | + <Step title="Configura la información básica de la aplicación"> |
| 62 | + Configura lo siguiente: |
| 63 | + |
| 64 | + * **GitHub App name:** `Mintlify` |
| 65 | + * **Description:** `Integration with Mintlify services` |
| 66 | + * **Homepage URL:** `https://mintlify.com` |
| 67 | + * **User authorization callback URL:** `https://your-github-server.com/` (reemplaza con tu dominio real de GHES) |
| 68 | + </Step> |
| 69 | +</Steps> |
| 70 | + |
| 71 | +<div id="step-2-configure-app-permissions"> |
| 72 | + ## Paso 2: Configurar los permisos de la aplicación |
| 73 | +</div> |
| 74 | + |
| 75 | +<Steps> |
| 76 | + <Step title="Configurar permisos del repositorio"> |
| 77 | + Establece los siguientes permisos para la aplicación. No se requieren permisos de organización, cuenta ni Enterprise: |
| 78 | + |
| 79 | + * **Checks:** Lectura y escritura |
| 80 | + * **Contents:** Lectura y escritura |
| 81 | + * **Deployments:** Lectura y escritura |
| 82 | + * **Metadata:** Solo lectura |
| 83 | + * **Pull Requests:** Lectura y escritura |
| 84 | + </Step> |
| 85 | + |
| 86 | + <Step title="Suscribirse a eventos"> |
| 87 | + Selecciona los siguientes eventos de webhook: |
| 88 | + |
| 89 | + * Installation |
| 90 | + * Installation Target |
| 91 | + * Create |
| 92 | + * Delete |
| 93 | + * Public |
| 94 | + * Pull Request |
| 95 | + * Push |
| 96 | + * Repository |
| 97 | + </Step> |
| 98 | +</Steps> |
| 99 | + |
| 100 | +<div id="step-3-generate-and-secure-credentials"> |
| 101 | + ## Paso 3: Generar y proteger credenciales |
| 102 | +</div> |
| 103 | + |
| 104 | +<Steps> |
| 105 | + <Step title="Crear la app"> |
| 106 | + Haz clic en **Create GitHub App**. |
| 107 | + |
| 108 | + Se te redirigirá a la página de configuración de la app. |
| 109 | + </Step> |
| 110 | + |
| 111 | + <Step title="Generar clave privada"> |
| 112 | + 1. Desplázate hacia abajo hasta la sección **Private keys**. |
| 113 | + 2. Haz clic en **Generate a private key**. |
| 114 | + 3. Descarga el archivo `.pem` y guárdalo de forma segura. |
| 115 | + </Step> |
| 116 | + |
| 117 | + <Step title="Anotar credenciales de la app"> |
| 118 | + Toma nota de lo siguiente: |
| 119 | + |
| 120 | + * **App ID** (visible en la parte superior de la página de configuración) |
| 121 | + * **Client ID** (en la sección "About") |
| 122 | + * **Client Secret** (genéralo y guárdalo de forma segura) |
| 123 | + </Step> |
| 124 | +</Steps> |
| 125 | + |
| 126 | +<div id="step-4-install-the-app"> |
| 127 | + ## Paso 4: Instalar la app |
| 128 | +</div> |
| 129 | + |
| 130 | +<Steps> |
| 131 | + <Step title="Ir a la instalación de la app"> |
| 132 | + 1. Desde la página de configuración de la app, haz clic en **Install App** en la barra lateral izquierda. |
| 133 | + 2. Selecciona tu organización de la lista. |
| 134 | + </Step> |
| 135 | + |
| 136 | + <Step title="Elegir el alcance de la instalación"> |
| 137 | + Selecciona una de las siguientes opciones: |
| 138 | + |
| 139 | + * **All repositories** (para acceso en toda la organización) |
| 140 | + * **Only select repositories** (elige repositorios específicos) |
| 141 | + |
| 142 | + <Tip> |
| 143 | + Recomendamos seleccionar **Only select repositories** y limitar la app solo a los repositorios donde se encuentra tu documentación. |
| 144 | + </Tip> |
| 145 | + </Step> |
| 146 | + |
| 147 | + <Step title="Completar la instalación"> |
| 148 | + 1. Haz clic en **Install**. |
| 149 | + 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. |
| 150 | + </Step> |
| 151 | +</Steps> |
| 152 | + |
| 153 | +<div id="step-5-configure-webhook-url"> |
| 154 | + ## Paso 5: Configurar la URL del webhook |
| 155 | +</div> |
| 156 | + |
| 157 | +<Steps> |
| 158 | + <Step title="Volver a la configuración de la aplicación"> |
| 159 | + 1. Regresa a la página de configuración de tu aplicación. |
| 160 | + 2. Desplázate hasta la sección **Webhook**. |
| 161 | + </Step> |
| 162 | + |
| 163 | + <Step title="Configurar la URL del webhook"> |
| 164 | + Configura lo siguiente: |
| 165 | + |
| 166 | + * **Webhook URL:** `https://leaves.mintlify.com/github-enterprise/:subdomain` (reemplaza `:subdomain` con la URL que te proporcionemos) |
| 167 | + * **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. |
| 168 | + </Step> |
| 169 | +</Steps> |
| 170 | + |
| 171 | +<div id="share-credentials-with-us"> |
| 172 | + ## Comparte las credenciales con nosotros |
| 173 | +</div> |
| 174 | + |
| 175 | +Comparte la siguiente información con nuestro equipo utilizando tu método preferido de transferencia segura de información. |
| 176 | + |
| 177 | +<div id="required-credentials"> |
| 178 | + ### Credenciales requeridas |
| 179 | +</div> |
| 180 | + |
| 181 | +* URL base de GitHub Enterprise Server: https://your-github-server.com |
| 182 | +* ID de la aplicación (App ID): (del paso 3) |
| 183 | +* ID de cliente de la aplicación (App client ID): (del paso 3) |
| 184 | +* Secreto de cliente de la aplicación (App client secret): (del paso 3) |
| 185 | +* ID de la instalación (Installation ID): (del paso 4) |
| 186 | +* Clave privada: Todo el contenido del archivo `.pem` (debe compartirse mediante transferencia segura de archivos) |
| 187 | +* Secreto del webhook (Webhook secret): (del paso 5) |
| 188 | + |
| 189 | +<div id="optional-credentials-for-troubleshooting"> |
| 190 | + ### Credenciales opcionales para la resolución de problemas |
| 191 | +</div> |
| 192 | + |
| 193 | +* Organization name: El nombre de tu organización en GitHub |
| 194 | +* Repository names: Nombres de los repositorios específicos donde la aplicación está instalada |
| 195 | +* GitHub Enterprise Server version: La encontrarás en el panel de administración de tu sitio |
| 196 | + |
| 197 | +<div id="mintlify-connection"> |
| 198 | + ## Conexión con Mintlify |
| 199 | +</div> |
| 200 | + |
| 201 | +Recibimos las credenciales que nos proporcionas y las almacenamos cifradas en una ubicación segura. Luego trabajamos contigo para: |
| 202 | + |
| 203 | +* Integrar tu entorno GHES con un despliegue existente de Mintlify. |
| 204 | +* Integrar tu entorno GHES con un nuevo despliegue de Mintlify que aprovisionamos para ti. |
| 205 | + |
| 206 | +Una vez que tu entorno GHES esté integrado con un despliegue de Mintlify, podrás habilitar los webhooks de tu GitHub App. |
| 207 | + |
| 208 | +<Note> |
| 209 | + La URL del webhook puede cambiar según nuestra configuración. Probamos la integración y te proporcionamos la nueva URL. |
| 210 | +</Note> |
| 211 | + |
| 212 | +<div id="test-the-integration"> |
| 213 | + ## Probar la integración |
| 214 | +</div> |
| 215 | + |
| 216 | +<Steps> |
| 217 | + <Step title="Verificar la entrega del webhook"> |
| 218 | + 1. Ve a la configuración de tu GitHub App. |
| 219 | + 2. Haz clic en la pestaña **Advanced**. |
| 220 | + 3. Revisa "Recent Deliveries" para comprobar que haya entregas de webhook correctas. |
| 221 | + 4. Busca respuestas HTTP 200. |
| 222 | + </Step> |
| 223 | + |
| 224 | + <Step title="Probar el acceso al repositorio"> |
| 225 | + 1. Crea un issue o pull request de prueba en un repositorio instalado. |
| 226 | + 2. Asegúrate de que Mintlify responda correctamente. |
| 227 | + </Step> |
| 228 | +</Steps> |
| 229 | + |
| 230 | +<div id="faq-and-troubleshooting"> |
| 231 | + ## Preguntas frecuentes y solución de problemas |
| 232 | +</div> |
| 233 | + |
| 234 | +<AccordionGroup> |
| 235 | + <Accordion title="La instalación de la app falla con errores de permisos."> |
| 236 | + Asegúrate de tener: |
| 237 | + |
| 238 | + * Privilegios de administrador del sitio para la creación de la app. |
| 239 | + * Derechos de propietario o administrador de la organización para la instalación de la app. |
| 240 | + * Permisos adecuados sobre el repositorio si la instalas en repositorios específicos. |
| 241 | + </Accordion> |
| 242 | + |
| 243 | + <Accordion title="Los webhooks no se están entregando"> |
| 244 | + * Verifica que la URL del webhook sea correcta y accesible. |
| 245 | + * Asegúrate de que tu firewall permita conexiones salientes mediante HTTPS. |
| 246 | + * Comprueba que el secreto del webhook coincida con lo configurado. |
| 247 | + * Revisa los registros de entrega de webhooks en la pestaña "Advanced" de la configuración de tu GitHub App. |
| 248 | + </Accordion> |
| 249 | + |
| 250 | + <Accordion title="Tengo errores de certificado SSL/TLS"> |
| 251 | + Tu GHES podría usar certificados autofirmados. Nuestros servicios no pueden verificar el certificado de tu servidor. |
| 252 | + |
| 253 | + **Solución:** Asegúrate de que tu GHES tenga un certificado SSL válido. |
| 254 | + </Accordion> |
| 255 | + |
| 256 | + <Accordion title="La app se instala, pero no responde a los eventos."> |
| 257 | + * Asegúrate de que los webhooks se estén entregando y sean reconocidos por nuestro servidor con un código de respuesta 200. |
| 258 | + * Verifica que se hayan otorgado los permisos necesarios durante la instalación. |
| 259 | + </Accordion> |
| 260 | + |
| 261 | + <Accordion title="¿Puedo limitar a qué repositorios accede la app?"> |
| 262 | + 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. |
| 263 | + </Accordion> |
| 264 | + |
| 265 | + <Accordion title="¿Cómo actualizo los permisos de la app más adelante?"> |
| 266 | + * Ve a la configuración de la app como administrador del sitio. |
| 267 | + * Modifica los permisos según sea necesario. |
| 268 | + * La app deberá volver a ser aprobada por los propietarios de la organización. |
| 269 | + * Avísanos de cualquier cambio de permisos, ya que puede afectar a la funcionalidad. |
| 270 | + </Accordion> |
| 271 | + |
| 272 | + <Accordion title="Nuestro GHES está detrás de un firewall corporativo, un proxy nginx u otra configuración similar."> |
| 273 | + Debes: |
| 274 | + |
| 275 | + * Incluir nuestros dominios de servicio en la lista blanca de tu firewall. |
| 276 | + * Asegurar la conectividad saliente mediante HTTPS (puerto 443). |
| 277 | + * Si no se permite el acceso directo a Internet, configura un proxy. |
| 278 | + </Accordion> |
| 279 | + |
| 280 | + <Accordion title="¿Puede funcionar esto con GHES en entornos aislados (air-gapped)?"> |
| 281 | + No, tu GHES debe poder comunicarse con nuestro servidor en la nube. |
| 282 | + </Accordion> |
| 283 | + |
| 284 | + <Accordion title="¿Con quién debo contactar si necesito ayuda?"> |
| 285 | + Ponte en contacto con tu representante de customer success con quien ya hayas hablado en Mintlify, o con nuestro equipo de soporte en < a href="mailto:[email protected]"> [email protected]</ a> con: |
| 286 | + |
| 287 | + * Tu versión de GitHub Enterprise Server. |
| 288 | + * Mensajes de error específicos. |
| 289 | + * Capturas de pantalla de cualquier problema. |
| 290 | + * Detalles de configuración de red/firewall (si corresponde). |
| 291 | + </Accordion> |
| 292 | +</AccordionGroup> |
0 commit comments