GitHub Enterprise Server

Install and configure the Mintlify GitHub App on your GitHub Enterprise Server instance for automated documentation deployments and syncing.

This guide walks you through setting up the Mintlify GitHub App on your GitHub Enterprise Server (GHES) installation. To connect a GHES instance to Mintlify, you must create a local version of our app within your self-hosted environment that communicates with our remote server.

If you use a cloud-hosted GitHub instance, see the GitHub page for setup instructions.

Prerequisites

Admin privileges on your GitHub Enterprise Server organization where you want to install the app
Access to your organization’s repositories where you want to install the app
Network connectivity to communicate with our external services (see Network requirements section below)

Network requirements

Outbound connectivity

Your GitHub Enterprise Server must be able to reach:

Mintlify’s API endpoints (https://leaves.mintlify.com)
Webhook receivers (port 443)

Firewall configuration

Allow the following outbound connections:

Connections from Mintlify’s static IP: 54.242.90.151
HTTPS (port 443) to Mintlify’s service domains
DNS resolution for Mintlify’s service domains

Step 1: Register the GitHub App

See Registering a GitHub App in the GitHub documentation for detailed instructions.

Navigate to your organization settings

In the upper-right corner of any page on GitHub, click your profile picture.
Click Your organizations.
Click Settings next to the organization that you want to create the app for.

Create a new GitHub App

In the left sidebar, click Developer settings.
Click GitHub Apps.
Click New GitHub App.

Configure basic app information

Set the following:

GitHub App name: Mintlify
Description: Integration with Mintlify services
Homepage URL: https://mintlify.com
User authorization callback URL: https://your-github-server.com/ (replace with your actual GHES domain)

Step 2: Configure app permissions

Set repository permissions

Set the following permissions for the app. The app needs no Organization, Account, or Enterprise permissions:

Checks: Read and write
Contents: Read and write
Deployments: Read and write
Metadata: Read-only
Pull Requests: Read and write

Subscribe to events

Select the following webhook events:

Installation
Installation Target
Create
Delete
Public
Pull Request
Push
Repository

Step 3: Generate and secure credentials

Create the app

Click Create GitHub App.

GitHub redirects you to the app’s settings page.

Generate private key

Scroll down to the Private keys section.
Click Generate a private key.
Download the .pem file and securely store it.

Note app credentials

Record the following:

App ID (visible at the top of the settings page)
Client ID (in the “About” section)
Client Secret (generate and record it securely)

Step 4: Install the app

Navigate to app installation

From the app settings page, click Install App in the left sidebar.
Select your organization from the list.

Choose installation scope

Select either:

All repositories (for organization-wide access)
Only select repositories (choose specific repositories)

Complete the installation

Click Install.
Record the installation ID from the URL. For example, in https://your-github-server.com/settings/installations/12345, the string 12345 is the installation ID.

Step 5: Configure webhook URL

Return to app settings

Go back to your app’s settings page.
Scroll to the Webhook section.

Set webhook URL

Configure the following:

Webhook URL: https://leaves.mintlify.com/github-enterprise/:subdomain (replace :subdomain with the URL that we provide you with)
Webhook secret: Generate a random string (32+ characters) and record it securely. Mintlify can also generate this and provide it to you.

Share the following information with our team using your secure information transfer method of choice.

Required credentials

GitHub Enterprise Server base URL: https://your-github-server.com
App ID: (from step 3)
App client ID: (from step 3)
App client secret: (from step 3)
Installation ID: (from step 4)
Installation owner: The name of the GitHub organization that owns the app installation
Private key: The entire contents of the .pem file (share it via secure file transfer)
Webhook secret: (from step 5)

Optional credentials for troubleshooting

Repository names: Specific repositories where you installed the app
GitHub Enterprise Server version: Found in your site admin dashboard

Mintlify connection

We take the credentials you provide us and store them, encrypted, in a secure location. Then we work with you to either:

Integrate your GHES environment with an existing Mintlify deployment.
Integrate your GHES environment with a new Mintlify deployment that we provision for you.

After you integrate your GHES environment with a Mintlify deployment, you are ready to enable webhooks for your GitHub App.

The webhook URL may change based on our configuration. We test the integration and provide you with the new URL.

Test the integration

Verify webhook delivery

Go to your GitHub App settings.
Click the Advanced tab.
Check “Recent Deliveries” for successful webhook deliveries.
Look for HTTP 200 responses.

Test repository access

Create a test issue or pull request in an installed repository.
Verify that Mintlify responds appropriately.