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.
Navigate to Settings > Workspace > Integrations.
Click on Configure for GitHub Enterprise.
Enter the URL of your GitHub Enterprise instance to create your dedicated GitHub app
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.
The GitHub App is now created and you can install it for users and organizations.
Follow the exact same steps as for the GitHub.com SaaS integration.
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.
IMPORTANT: GitGuardian cannot monitor repositories whose owner (user or organization) has not installed the GitHub App.
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.
By default, GitGuardian performs a historical scan for each new GitHub Enterprise repository added to your perimeter.
You can deactivate this behavior in your GitHub Enterprise settings if you are a Manager of the workspace.
GitHub Check Runs will be triggered on GitHub pull requests on repositories monitored by GitGuardian. To configure Check Runs, please refer to this documentation section — Managing Check Runs.