@@ -5,6 +5,13 @@ sidebar_label: Self-Managed GitHub
55sidebar_position : 3
66---
77
8+ ::: info
9+
10+ This page is for GitHub Enterprise Self-Hosted users only.
11+ If you're using github.com, [ log in to CodeRabbit] ( https://app.coderabbit.ai ) and add your repositories from there
12+
13+ :::
14+
815This page guides you through the process of integrating your Self-Managed GitHub with CodeRabbit.
916
1017To initiate the integration, we require specific information. This is essential
@@ -61,7 +68,7 @@ Navigate to your GitHub Self-Hosted Instance and follow the steps below to [crea
61683 . In the left sidebar, click ** Developer settings** > ** GitHub Apps**
62694 . Click ** New GitHub App** .
63705 . Set the following fields:
64- - ** GitHub App name** : ` CodeRabbit GitHub App `
71+ - ** GitHub App name** : ` CodeRabbit `
6572 - ** Description** : ` GitHub App for CodeRabbit `
6673 - ** Homepage URL** : ` https://coderabbit.ai `
6774 - ** Callback URL** : ` https://app.coderabbit.ai/login `
@@ -97,8 +104,6 @@ Once the GitHub App has been created, click on **Generate a new client secret**
97104
98105Scroll down and click on ** Generate a private key** under the 'Private keys' section and download the PEM file.
99106
100- Also, from the ** Install App** tab, install the GitHub App to your organizations.
101-
102107Keep the following details handy:
103108
104109- App ID
@@ -122,10 +127,22 @@ Submit the details that were accumulated in previous steps:
122127- GitHub App Webhook Secret
123128- GitHub App Private Key
124129
125- Click on Submit and the login process will be initiated.
130+ Click on Submit and the login process will be initiated.
126131On subsequent visits, your setup will be automatically detected, allowing for direct login.
127132
128- ### ** Step 5: Whitelist CodeRabbit IP address**
133+ ### ** Step 5: Install the GitHub App**
134+
135+ Navigate to the GitHub App that was created from your self-hosted instance and click on the ** Install App** tab.
136+ Then, install the GitHub App to your organization(s).
137+
138+ ::: warning
139+
140+ If you performed this step before Step 4, the installation event likely will have failed, and you will need to re-send the installation event.
141+ Navigate to the ** Advanced** tab in the GitHub App and click on the ** Redeliver** button for the failed ` installation.created ` event.
142+
143+ :::
144+
145+ ### ** Step 6: Whitelist CodeRabbit IP address**
129146
130147Use this CodeRabbit IP if your instance requires IP whitelisting
131148` 35.222.179.152/32 `
0 commit comments