Skip to main content

GitHub Enterprise

GitGuardian integrates natively with GitHub Enterprise via a GitHub App that you can install on your personal GitHub Enterprise repositories and the repositories of your GitHub Enterprise organizations.

Note: the GitGuardian GitHub app only has read access to your code. You will need Owner or Manager rights in GitGuardian to set up an integration or customize your settings.

The pre-existing GitGuardian GitHub App cannot be leveraged to integrate with self hosted GitHub Enterprise. Instead, you will need to create a separate GitHub App on your own GitHub Enterprise instance. This process is extremely straightforward since GitGuardian will automatically indicate the required configurations to your GitHub Enterprise.

You can refer to the GitHub documentation for more information on GitHub apps.

Setup your GitHub Enterprise integration#

  1. Navigate to Settings > Workspace > Integrations.

  2. Click on Configure for GitHub Enterprise.

  3. Enter the URL of your GitHub Enterprise instance to create your dedicated GitHub app

    GitGuardian GHE app creation form

  4. Validate the GitHub App creation. We recommend that you choose a simple name for your GitHub app such as GitGuardian, which will make it easily recognizable.

    GHE app creation via manifest

  5. The GitHub App is now created and you can install it for users and organizations.

  6. Follow the exact same steps as for the SaaS integration.

Configuration page#

When you integrate your GitHub Enterprise instance, you have access to a configuration page.

From this page, you have the possibility to:

  • integrate another GitHub Enterprise instance with GitGuardian.
  • manage your existing instances and their dedicated GitHub app. GitGuardian tells you which ones are considered inactive.

GHE configuration page

Important notes#

WARNING: the GitHub App belongs to the user who created it. We recommend that you transfer the ownership to an organization in case the user is later deactivated.

Transfer GitHub app

IMPORTANT: GitGuardian cannot monitor repositories whose owner (user or organization) has not installed the GitHub App.