Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
84 changes: 84 additions & 0 deletions deploy/gitlab-self-hosted.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
---
title: "Self-hosted GitLab"
description: "Connect a GitLab instance you run yourself to Mintlify by registering an OAuth application and configuring the connection in your dashboard."
keywords: ["self-hosted GitLab", "GitLab OAuth", "GitLab Enterprise", "OAuth application"]
---

This guide walks you through connecting a self-hosted GitLab instance to Mintlify. You register an OAuth application on your GitLab instance, then provide its client ID and secret in your Mintlify dashboard so workflows can authorize against your instance.

If you use GitLab.com, see the [GitLab](/deploy/gitlab) page for setup instructions.

## Prerequisites

- Admin or maintainer access to your GitLab instance to register an OAuth application
- A publicly accessible URL for your GitLab instance so Mintlify can reach it
- Access to your Mintlify dashboard with the `Self-hosted GitLab OAuth` feature enabled for your organization

## Step 1: Register the OAuth application on your GitLab instance

Register a new OAuth application on your GitLab instance. You can do this at the instance, group, or user level depending on how you want to scope access.

<Steps>
<Step title="Navigate to OAuth applications">
On your GitLab instance, go to **Admin Area** > **Applications** to register an instance-wide application, or **User Settings** > **Applications** to register one under your user account.
</Step>
<Step title="Configure the application">
Set the following fields:

- **Name**: `Mintlify`
- **Redirect URI**: `https://leaves.mintlify.com/gitlab-oauth-webhook`
- **Confidential**: Enabled
- **Scopes**: `api`, `read_repository`, `write_repository`

<Note>
The `api` scope is required so Mintlify can read project metadata and create webhooks. The `read_repository` and `write_repository` scopes allow Mintlify to clone your documentation and push preview deployments.
</Note>
</Step>
<Step title="Save and record credentials">
Save the application. GitLab displays the **Application ID** (client ID) and **Secret** (client secret). Record both before leaving the page; the secret is only shown once.

Check warning on line 38 in deploy/gitlab-self-hosted.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/gitlab-self-hosted.mdx#L38

Use semicolons judiciously.
</Step>
</Steps>

## Step 2: Connect your instance in the Mintlify dashboard

<Steps>
<Step title="Open the GitLab OAuth settings">
In your [Mintlify dashboard](https://dashboard.mintlify.com), go to **Settings** > **Git settings** > **GitLab OAuth**, then locate the **Self-hosted GitLab** section.
</Step>
<Step title="Enter your instance details">
Click **Connect Self-Hosted GitLab** and fill in the following fields:

- **GitLab instance URL**: The base URL of your instance, for example `https://gitlab.your-company.com`.
- **OAuth application client ID**: The Application ID from Step 1.
- **OAuth application client secret**: The Secret from Step 1.

Click **Save instance**. Your client secret is encrypted at rest and is never returned by the API after saving.
</Step>
<Step title="Authorize the connection">
Click **Authorize self-hosted GitLab**. You are redirected to your instance to approve the OAuth application, then sent back to the dashboard.

Check warning on line 58 in deploy/gitlab-self-hosted.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/gitlab-self-hosted.mdx#L58

In general, use active voice instead of passive voice ('are redirected').
</Step>
<Step title="Connect projects">
Expand a group in the installations list and select the projects you want to connect. Mintlify enables webhooks on each selected project so deployments trigger automatically when you push changes.
</Step>
</Steps>

## Rotate or remove credentials

To rotate your OAuth credentials, remove the existing instance from the **Self-hosted GitLab** section and add it again with the new client ID and secret. Removing an instance also revokes any active installations connected through it.

## Troubleshooting

<AccordionGroup>
<Accordion title="The Self-hosted GitLab section is not visible in my dashboard">
Self-hosted GitLab OAuth is gated behind an organization feature flag. Contact your customer success representative or [support@mintlify.com](mailto:support@mintlify.com) to enable it for your organization.

Check warning on line 73 in deploy/gitlab-self-hosted.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/gitlab-self-hosted.mdx#L73

In general, use active voice instead of passive voice ('is gated').
</Accordion>
<Accordion title="Authorization fails with a redirect URI mismatch">
The redirect URI registered on your OAuth application must exactly match `https://leaves.mintlify.com/gitlab-oauth-webhook`. Update your application on GitLab and try again.
</Accordion>
<Accordion title="Mintlify cannot reach my GitLab instance">
Your instance must be reachable from the public internet. Verify your firewall allows inbound HTTPS connections from Mintlify and that your instance has a valid SSL certificate.
</Accordion>
<Accordion title="Project access tokens fail to mint">
The user who authorized the OAuth application must have at least the **Maintainer** role on each connected project. Reauthorize with a user that has the required role, or upgrade the role on the affected projects.

Check warning on line 82 in deploy/gitlab-self-hosted.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/gitlab-self-hosted.mdx#L82

Use 'reauthorize' instead of 'Reauthorize'.
</Accordion>
</AccordionGroup>
3 changes: 2 additions & 1 deletion docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,8 @@
"deploy/ci",
"deploy/github",
"deploy/ghes",
"deploy/gitlab"
"deploy/gitlab",
"deploy/gitlab-self-hosted"
]
},
{
Expand Down
3 changes: 2 additions & 1 deletion es.json
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,8 @@
"es/deploy/ci",
"es/deploy/github",
"es/deploy/ghes",
"es/deploy/gitlab"
"es/deploy/gitlab",
"es/deploy/gitlab-self-hosted"
]
},
{
Expand Down
84 changes: 84 additions & 0 deletions es/deploy/gitlab-self-hosted.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
---
title: "GitLab autoalojado"
description: "Conecta una instancia de GitLab que administras tú mismo a Mintlify registrando una aplicación OAuth y configurando la conexión en tu panel."
keywords: ["GitLab autoalojado", "GitLab OAuth", "GitLab Enterprise", "aplicación OAuth"]
---

Esta guía te muestra cómo conectar una instancia de GitLab autoalojada a Mintlify. Registras una aplicación OAuth en tu instancia de GitLab y luego proporcionas su client ID y secret en tu panel de Mintlify para que los flujos puedan autorizarse contra tu instancia.

Si usas GitLab.com, consulta la página de [GitLab](/es/deploy/gitlab) para ver las instrucciones de configuración.

## Requisitos previos

- Acceso de administrador o mantenedor a tu instancia de GitLab para registrar una aplicación OAuth
- Una URL accesible públicamente para tu instancia de GitLab para que Mintlify pueda alcanzarla
- Acceso a tu panel de Mintlify con la función `Self-hosted GitLab OAuth` habilitada para tu organización

## Paso 1: Registra la aplicación OAuth en tu instancia de GitLab

Registra una nueva aplicación OAuth en tu instancia de GitLab. Puedes hacerlo a nivel de instancia, grupo o usuario según cómo quieras delimitar el acceso.

<Steps>
<Step title="Navega a las aplicaciones OAuth">
En tu instancia de GitLab, ve a **Área de administración** > **Aplicaciones** para registrar una aplicación a nivel de instancia, o a **Configuración de usuario** > **Aplicaciones** para registrar una bajo tu cuenta de usuario.
</Step>
<Step title="Configura la aplicación">
Establece los siguientes campos:

- **Nombre**: `Mintlify`
- **URI de redirección**: `https://leaves.mintlify.com/gitlab-oauth-webhook`
- **Confidencial**: Habilitado
- **Ámbitos**: `api`, `read_repository`, `write_repository`

<Note>
El ámbito `api` es necesario para que Mintlify pueda leer los metadatos del proyecto y crear webhooks. Los ámbitos `read_repository` y `write_repository` permiten que Mintlify clone tu documentación e implemente despliegues de vista previa.
</Note>
</Step>
<Step title="Guarda y registra las credenciales">
Guarda la aplicación. GitLab muestra el **Application ID** (client ID) y el **Secret** (client secret). Registra ambos antes de salir de la página; el secret solo se muestra una vez.
</Step>
</Steps>

## Paso 2: Conecta tu instancia en el panel de Mintlify

<Steps>
<Step title="Abre la configuración de OAuth de GitLab">
En tu [panel de Mintlify](https://dashboard.mintlify.com), ve a **Configuración** > **Configuración de Git** > **GitLab OAuth** y luego ubica la sección **Self-hosted GitLab**.
</Step>
<Step title="Introduce los datos de tu instancia">
Haz clic en **Connect Self-Hosted GitLab** y completa los siguientes campos:

- **GitLab instance URL**: La URL base de tu instancia, por ejemplo `https://gitlab.tu-empresa.com`.
- **OAuth application client ID**: El Application ID del Paso 1.
- **OAuth application client secret**: El Secret del Paso 1.

Haz clic en **Save instance**. Tu client secret se cifra en reposo y nunca se devuelve por la API después de guardarlo.
</Step>
<Step title="Autoriza la conexión">
Haz clic en **Authorize self-hosted GitLab**. Te redirigimos a tu instancia para aprobar la aplicación OAuth y luego te enviamos de vuelta al panel.
</Step>
<Step title="Conecta los proyectos">
Expande un grupo en la lista de instalaciones y selecciona los proyectos que quieras conectar. Mintlify habilita los webhooks en cada proyecto seleccionado para que los despliegues se activen automáticamente cuando envíes cambios.
</Step>
</Steps>

## Rotar o eliminar credenciales

Para rotar tus credenciales OAuth, elimina la instancia existente de la sección **Self-hosted GitLab** y agrégala de nuevo con el nuevo client ID y secret. Eliminar una instancia también revoca cualquier instalación activa conectada a través de ella.

## Solución de problemas

<AccordionGroup>
<Accordion title="La sección Self-hosted GitLab no se ve en mi panel">
GitLab OAuth autoalojado está protegido por una bandera de función a nivel de organización. Contacta a tu representante de éxito del cliente o a [support@mintlify.com](mailto:support@mintlify.com) para habilitarlo en tu organización.
</Accordion>
<Accordion title="La autorización falla con un error de URI de redirección que no coincide">
La URI de redirección registrada en tu aplicación OAuth debe coincidir exactamente con `https://leaves.mintlify.com/gitlab-oauth-webhook`. Actualiza tu aplicación en GitLab e inténtalo de nuevo.
</Accordion>
<Accordion title="Mintlify no puede alcanzar mi instancia de GitLab">
Tu instancia debe ser accesible desde la red pública. Comprueba que tu cortafuegos permita conexiones HTTPS entrantes desde Mintlify y que tu instancia tenga un certificado SSL válido.
</Accordion>
<Accordion title="Los tokens de acceso al proyecto no se generan">
El usuario que autorizó la aplicación OAuth debe tener al menos el rol **Maintainer** en cada proyecto conectado. Vuelve a autorizar con un usuario que tenga el rol requerido o aumenta el rol en los proyectos afectados.
</Accordion>
</AccordionGroup>
3 changes: 2 additions & 1 deletion fr.json
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,8 @@
"fr/deploy/ci",
"fr/deploy/github",
"fr/deploy/ghes",
"fr/deploy/gitlab"
"fr/deploy/gitlab",
"fr/deploy/gitlab-self-hosted"
]
},
{
Expand Down
84 changes: 84 additions & 0 deletions fr/deploy/gitlab-self-hosted.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
---
title: "GitLab auto-hébergé"
description: "Connectez à Mintlify une instance GitLab que vous gérez vous-même en enregistrant une application OAuth et en configurant la connexion dans votre tableau de bord."
keywords: ["GitLab auto-hébergé", "GitLab OAuth", "GitLab Enterprise", "application OAuth"]
---

Ce guide vous explique comment connecter une instance GitLab auto-hébergée à Mintlify. Vous enregistrez une application OAuth sur votre instance GitLab, puis vous fournissez son client ID et son secret dans votre tableau de bord Mintlify pour que les workflows puissent s’authentifier auprès de votre instance.

Si vous utilisez GitLab.com, consultez la page [GitLab](/fr/deploy/gitlab) pour les instructions de configuration.

## Prérequis

- Un accès administrateur ou mainteneur à votre instance GitLab pour enregistrer une application OAuth
- Une URL accessible publiquement pour votre instance GitLab afin que Mintlify puisse l’atteindre
- Un accès à votre tableau de bord Mintlify avec la fonctionnalité `Self-hosted GitLab OAuth` activée pour votre organisation

## Étape 1 : enregistrez l’application OAuth sur votre instance GitLab

Enregistrez une nouvelle application OAuth sur votre instance GitLab. Vous pouvez le faire au niveau de l’instance, du groupe ou de l’utilisateur selon la portée d’accès souhaitée.

<Steps>
<Step title="Accédez aux applications OAuth">
Sur votre instance GitLab, allez dans **Zone d’administration** > **Applications** pour enregistrer une application à l’échelle de l’instance, ou dans **Paramètres utilisateur** > **Applications** pour en enregistrer une sous votre compte utilisateur.
</Step>
<Step title="Configurez l’application">
Renseignez les champs suivants :

- **Nom** : `Mintlify`
- **URI de redirection** : `https://leaves.mintlify.com/gitlab-oauth-webhook`
- **Confidentielle** : activée
- **Portées** : `api`, `read_repository`, `write_repository`

<Note>
La portée `api` est requise pour que Mintlify puisse lire les métadonnées du projet et créer des webhooks. Les portées `read_repository` et `write_repository` permettent à Mintlify de cloner votre documentation et de pousser des déploiements d’aperçu.
</Note>
</Step>
<Step title="Enregistrez et notez les identifiants">
Enregistrez l’application. GitLab affiche l’**Application ID** (client ID) et le **Secret** (client secret). Notez les deux avant de quitter la page ; le secret n’est affiché qu’une seule fois.
</Step>
</Steps>

## Étape 2 : connectez votre instance dans le tableau de bord Mintlify

<Steps>
<Step title="Ouvrez les paramètres OAuth GitLab">
Dans votre [tableau de bord Mintlify](https://dashboard.mintlify.com), allez dans **Paramètres** > **Paramètres Git** > **GitLab OAuth**, puis localisez la section **Self-hosted GitLab**.
</Step>
<Step title="Saisissez les informations de votre instance">
Cliquez sur **Connect Self-Hosted GitLab** et remplissez les champs suivants :

- **GitLab instance URL** : l’URL de base de votre instance, par exemple `https://gitlab.votre-entreprise.com`.
- **OAuth application client ID** : l’Application ID de l’étape 1.
- **OAuth application client secret** : le Secret de l’étape 1.

Cliquez sur **Save instance**. Votre client secret est chiffré au repos et n’est jamais renvoyé par l’API après l’enregistrement.
</Step>
<Step title="Autorisez la connexion">
Cliquez sur **Authorize self-hosted GitLab**. Vous êtes redirigé vers votre instance pour approuver l’application OAuth, puis renvoyé vers le tableau de bord.
</Step>
<Step title="Connectez les projets">
Développez un groupe dans la liste des installations et sélectionnez les projets que vous souhaitez connecter. Mintlify active des webhooks sur chaque projet sélectionné afin que les déploiements se déclenchent automatiquement lorsque vous poussez des modifications.
</Step>
</Steps>

## Faire tourner ou supprimer les identifiants

Pour faire tourner vos identifiants OAuth, supprimez l’instance existante de la section **Self-hosted GitLab** et ajoutez-la à nouveau avec les nouveaux client ID et secret. La suppression d’une instance révoque également toutes les installations actives connectées via celle-ci.

## Dépannage

<AccordionGroup>
<Accordion title="La section Self-hosted GitLab n’est pas visible dans mon tableau de bord">
L’OAuth GitLab auto-hébergé est protégé par un drapeau de fonctionnalité au niveau de l’organisation. Contactez votre représentant Customer Success ou [support@mintlify.com](mailto:support@mintlify.com) pour l’activer pour votre organisation.
</Accordion>
<Accordion title="L’autorisation échoue avec une erreur de non-correspondance d’URI de redirection">
L’URI de redirection enregistrée sur votre application OAuth doit correspondre exactement à `https://leaves.mintlify.com/gitlab-oauth-webhook`. Mettez à jour votre application sur GitLab et réessayez.
</Accordion>
<Accordion title="Mintlify ne parvient pas à atteindre mon instance GitLab">
Votre instance doit être joignable depuis l’internet public. Vérifiez que votre pare-feu autorise les connexions HTTPS entrantes depuis Mintlify et que votre instance dispose d’un certificat SSL valide.
</Accordion>
<Accordion title="Les jetons d’accès aux projets ne sont pas générés">
L’utilisateur qui a autorisé l’application OAuth doit avoir au moins le rôle **Maintainer** sur chaque projet connecté. Réautorisez avec un utilisateur disposant du rôle requis, ou augmentez le rôle sur les projets concernés.
</Accordion>
</AccordionGroup>
3 changes: 2 additions & 1 deletion zh.json
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,8 @@
"zh/deploy/ci",
"zh/deploy/github",
"zh/deploy/ghes",
"zh/deploy/gitlab"
"zh/deploy/gitlab",
"zh/deploy/gitlab-self-hosted"
]
},
{
Expand Down
Loading
Loading