mintlify__docs/deploy/github.mdx

---
title: "GitHub"
description: "Connect your GitHub repository to Mintlify for automated deployments, pull request preview builds, and continuous documentation synchronization."
keywords: ["GitHub App","repository connection","automated deployments"]
---

Mintlify uses a GitHub App to automatically sync your documentation with your GitHub repository.

<Tip>
  **Do you need the GitHub App?**

  - **Mintlify-hosted repository** in the `mintlify-community` organization: No. The GitHub App is already configured.
  - **Your own repository**: Yes. Install the GitHub App to enable automatic deployments when you push changes.

  See your repository in the [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) page of your dashboard.
</Tip>

If your repository is in a private repository owned by the Mintlify organization, the GitHub App is automatically configured and managed by Mintlify. You can use the web editor to make changes to your documentation. If you want to work on your documentation locally, clone the repository to your own organization and update your Git settings to use your own repository.

## Clone to your own repository

If you skipped connecting your own Git repository during onboarding, your documentation lives in a private repository owned by the Mintlify organization. To move it to your own account or organization, go to [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) in your dashboard and follow the setup wizard.

The wizard offers two paths:

### One-click clone

<Steps>
  <Step title="Select GitHub as your provider">
    GitHub is preselected as the recommended provider.
  </Step>
  <Step title="Click Clone">
    Click **Clone** to automatically clone your documentation into a new repository in your GitHub account. You will be prompted to authorize with GitHub if you haven't already.
  </Step>
  <Step title="Select your organization">
    Choose the GitHub organization where you want the repository created, then confirm the clone.
  </Step>
  <Step title="Install the GitHub App">
    Install the Mintlify GitHub App to enable automatic deployments. You can also skip this step and install it later.
  </Step>
</Steps>

### Manual setup

<Steps>
  <Step title="Select GitHub as your provider">
    GitHub is preselected as the recommended provider.
  </Step>
  <Step title="Download your documentation">
    Click **Download** to save your documentation as a zip file. Create a new repository on GitHub and push the extracted contents to it.
  </Step>
  <Step title="Authorize with GitHub">
    Click **Continue setup** and authorize Mintlify to access your GitHub account.
  </Step>
  <Step title="Connect your repository">
    Select your organization, repository, and branch from the dropdowns. If your documentation is in a subdirectory, toggle the subdirectory option and enter the path. Click **Save** to connect.
  </Step>
</Steps>

## Install the GitHub App

<Note>
  You must have organization ownership or administrator permissions in a repository to install the app. If you lack the necessary permissions, the repository owner must approve the installation request.
</Note>

Install the Mintlify GitHub App through your [dashboard](https://dashboard.mintlify.com/settings/organization/github-app).

<Tip>
  We recommend only granting access to your documentation repository.
</Tip>

<Frame>
  <img
    className="h-80"
    alt="Mintlify GitHub App installation page with the 'Only select repositories' option selected."
    src="/images/github/select-repos.png"
  />
</Frame>

## Permissions

When you install the GitHub App, grant the following permissions.

Read permissions:

- `metadata`: Basic repository information

Read and write permissions:

- `checks`: Create status checks on pull requests
- `code`: Read file changes when you commit to your docs branch
- `deployments`: Generate preview deployments for pull requests
- `pull requests`: Create branches and pull requests from the web editor

<Info>
  The app only accesses repositories that you explicitly grant it access to. If you have branch protection rules enabled, the app can't push directly to protected branches.
</Info>

## Manage repository access

When installing the GitHub App, you can grant access to all of your repositories or specific ones. We recommend only granting access to your documentation repository and any repositories that you want to provide as context for the agent. You can modify this selection anytime in your [GitHub App settings](https://github.com/apps/mintlify/installations/new).

## Configure docs source

Change the organization, repository, or branch that your documentation builds from in the [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) section of your dashboard.

## GitHub Enterprise with IP allowlists

If your GitHub Enterprise Cloud organization has an IP allowlist enabled, you need to add Mintlify's egress IP address (`54.242.90.151`) to your allowlist for the GitHub App to function properly.

Follow [GitHub's documentation](https://docs.github.com/en/enterprise-cloud@latest/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization) to configure your IP allowlist.

## Troubleshooting

### Deployment not triggering automatically

If pushes to your repository don't trigger deployments, check the following possible problems.

<AccordionGroup>
  <Accordion title="Verify GitHub App installation">
    Check that the correct repository has the app installed.

    1. Go to [GitHub App settings](https://dashboard.mintlify.com/settings/organization/github-app) in your dashboard.
    1. Check that your repository is on the active app installations list.
  </Accordion>
  <Accordion title="Check deployment branch">
    Ensure that you're pushing to the correct branch.

    1. Go to [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings)
    1. Verify the branch in your dashboard matches the branch that you're pushing to.
  </Accordion>
</AccordionGroup>

### GitHub App connection issues

If you encounter problems with the GitHub app, resetting the connection can solve most problems.

<Steps>
  <Step title="Uninstall the Mintlify app through GitHub.">
    1. In GitHub, go to [installations](https://github.com/settings/installations) and select **Configure** next to the Mintlify app. Scroll down and select **Uninstall**.
    2. Go to [Authorized GitHub Apps](https://github.com/settings/apps/authorizations) and select **Revoke** next to the Mintlify app.
  </Step>
  <Step title="Reinstall the Mintlify app.">
    1. In your Mintlify dashboard, go to [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) and install the GitHub app.
    2. Authorize your account in the [My Profile](https://dashboard.mintlify.com/settings/account) section of your dashboard.
  </Step>
</Steps>

### Feedback add-ons are unavailable

The edit suggestions and raise issues feedback features are only available for public GitHub repositories. If these options are disabled in your dashboard, check your repository visibility.

If your repository is public and you cannot enable the edit suggestions or raise issues options in your dashboard, revalidate your Git settings.

<Steps>
  <Step title="Navigate to Git Settings">
    Go to [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) in your dashboard.
  </Step>
  <Step title="Revalidate your settings">
    Click the green check mark in the corner of the Git settings box to revalidate your repository settings. This forces an update to your repository settings to reflect whether your repository is public or private.

    <Frame>
      <img
        src="/images/github/revalidate-settings-light.png"
        alt="The Git Settings page in the Mintlify dashboard. An orange arrow points to the green check mark that revalidates the repository settings."
        className="block dark:hidden"
      />

      <img
        src="/images/github/revalidate-settings-dark.png"
        alt="The Git Settings page in the Mintlify dashboard. An orange arrow points to the green check mark that revalidates the repository settings."
        className="hidden dark:block"
      />
    </Frame>
  </Step>
</Steps>