GitHub Enterprise Server
Installez et configurez l’application GitHub Mintlify sur votre instance GitHub Enterprise Server pour déployer et synchroniser votre documentation.
Ce guide vous explique comment configurer l’App GitHub Mintlify sur votre installation GitHub Enterprise Server (GHES). Pour connecter une instance GHES à Mintlify, vous devez créer une version locale de notre application au sein de votre environnement auto‑hébergé, qui communique avec notre serveur distant.
Si vous utilisez une instance GitHub hébergée sur le cloud, consultez la page GitHub pour les instructions de configuration.
- Droits d’administrateur sur votre organisation GitHub Enterprise Server où vous souhaitez installer l’application
- Accès aux dépôts de votre organisation où vous souhaitez installer l’application
- Connectivité réseau pour communiquer avec nos services externes (voir la section Exigences réseau ci-dessous)
Votre GitHub Enterprise Server doit pouvoir accéder à :
- les points de terminaison de l’API Mintlify (https://leaves.mintlify.com)
- les récepteurs de webhook (port 443)
Autorisez les connexions sortantes suivantes :
- Connexions provenant de l’adresse IP statique de Mintlify :
54.242.90.151 - HTTPS (port 443) vers les domaines de service de Mintlify
- Résolution DNS pour les domaines de service de Mintlify
Consultez la page Registering a GitHub App dans la documentation GitHub pour des instructions détaillées.
Accéder aux paramètres de votre organisation
- Dans le coin supérieur droit de n’importe quelle page sur GitHub, cliquez sur votre photo de profil.
- Cliquez sur Your organizations.
- Cliquez sur Settings à côté de l’organisation pour laquelle vous souhaitez créer l’application.
Créer une nouvelle application GitHub
- Dans la barre latérale gauche, cliquez sur Developer settings.
- Cliquez sur GitHub Apps.
- Cliquez sur New GitHub App.
Configurer les informations de base de l'application
Définissez les éléments suivants :
- GitHub App name :
Mintlify - Description :
Intégration avec les services Mintlify - Homepage URL :
https://mintlify.com - User authorization callback URL :
https://your-github-server.com/(remplacez par votre domaine GHES réel)
Définir les autorisations du dépôt
Définissez les autorisations suivantes pour l’application. L’application n’a besoin d’aucune autorisation au niveau de l’organisation, du compte ou de l’entreprise :
- Checks : lecture et écriture
- Contents : lecture et écriture
- Deployments : lecture et écriture
- Metadata : lecture seule
- Pull Requests : lecture et écriture
S'abonner aux événements
Sélectionnez les événements de webhook suivants :
- Installation
- Installation Target
- Create
- Delete
- Public
- Pull Request
- Push
- Repository
Créer l'application
Cliquez sur Create GitHub App.
GitHub vous redirige vers la page de paramètres de l’application.
Générer la clé privée
- Faites défiler la page jusqu’à la section Private keys.
- Cliquez sur Generate a private key.
- Téléchargez le fichier
.pemet conservez-le en lieu sûr.
Noter les identifiants de l'application
Notez les informations suivantes :
- App ID (visible en haut de la page de paramètres)
- Client ID (dans la section “About”)
- Client Secret (générez-le et conservez-le en lieu sûr)
Accéder à l'installation de l'application
- Sur la page des paramètres de l’application, cliquez sur Install App dans la barre latérale gauche.
- Sélectionnez votre organisation dans la liste.
Choisir la portée de l'installation
Sélectionnez l’une des options suivantes :
- All repositories (pour un accès à l’ensemble de l’organisation)
- Only select repositories (choisir des dépôts spécifiques)
Nous vous recommandons de sélectionner Only select repositories et de limiter l’application uniquement aux dépôts où votre documentation est hébergée.
Terminer l'installation
- Cliquez sur Install.
- Notez l’ID d’installation à partir de l’URL. Par exemple, dans
https://your-github-server.com/settings/installations/12345, la chaîne12345correspond à l’ID d’installation.
Revenir aux paramètres de l’app
- Revenez à la page de paramètres de votre app.
- Faites défiler jusqu’à la section Webhook.
Définir l’URL du webhook
Configurez ce qui suit :
- Webhook URL :
https://leaves.mintlify.com/github-enterprise/:subdomain(remplacez:subdomainpar l’URL que nous vous fournirons) - Webhook secret : Générez une chaîne de caractères aléatoire d’au moins 32 caractères et conservez-la en lieu sûr. Mintlify peut également la générer et vous la fournir.
Veuillez partager les informations suivantes avec notre équipe en utilisant la méthode sécurisée de transmission d’informations de votre choix.
- URL de base de votre GitHub Enterprise Server : https://your-github-server.com
- ID de l’application : (à partir de l’étape 3)
- ID client de l’application : (à partir de l’étape 3)
- Secret client de l’application : (à partir de l’étape 3)
- ID d’installation : (à partir de l’étape 4)
- Installation owner : le nom de l’organisation GitHub propriétaire de l’installation de l’app
- Clé privée : l’intégralité du contenu du fichier
.pem(partagez-la via un transfert de fichier sécurisé) - Secret du webhook : (à partir de l’étape 5)
- Repository names: Dépôts spécifiques où vous avez installé l’application
- GitHub Enterprise Server version: Indiquée dans le tableau de bord d’administration de votre site
Nous chiffrons et stockons les identifiants que vous nous fournissez dans un emplacement sécurisé. Ensuite, nous collaborons avec vous pour :
- Intégrer votre environnement GHES à un déploiement Mintlify existant.
- Intégrer votre environnement GHES à un nouveau déploiement Mintlify que nous mettons en place pour vous.
Une fois que vous avez intégré votre environnement GHES à un déploiement Mintlify, vous êtes prêt à activer les webhooks pour votre GitHub App.
L’URL du webhook peut changer en fonction de notre configuration. Nous testons l’intégration et vous communiquons la nouvelle URL.
Vérifier la bonne réception des webhooks
- Allez dans les paramètres de votre GitHub App.
- Cliquez sur l’onglet Advanced.
- Consultez la section “Recent deliveries” pour confirmer la réussite des envois de webhooks.
- Recherchez les réponses HTTP 200.
Tester l’accès au dépôt
- Créez une issue ou une pull request de test dans un dépôt où l’application est installée.
- Vérifiez que Mintlify réagit comme attendu.