Skip to content

Commit c634f7a

Browse files
committed
Add step to install GitHub App
1 parent 906a7b4 commit c634f7a

File tree

1 file changed

+15
-5
lines changed

1 file changed

+15
-5
lines changed

docs/integrations/self-hosted-github.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ Navigate to your GitHub Self-Hosted Instance and follow the steps below to [crea
6161
3. In the left sidebar, click **Developer settings** > **GitHub Apps**
6262
4. Click **New GitHub App**.
6363
5. Set the following fields:
64-
- **GitHub App name**: `CodeRabbit GitHub App`
64+
- **GitHub App name**: `CodeRabbit`
6565
- **Description**: `GitHub App for CodeRabbit`
6666
- **Homepage URL**: `https://coderabbit.ai`
6767
- **Callback URL**: `https://app.coderabbit.ai/login`
@@ -97,8 +97,6 @@ Once the GitHub App has been created, click on **Generate a new client secret**
9797

9898
Scroll down and click on **Generate a private key** under the 'Private keys' section and download the PEM file.
9999

100-
Also, from the **Install App** tab, install the GitHub App to your organizations.
101-
102100
Keep the following details handy:
103101

104102
- App ID
@@ -122,10 +120,22 @@ Submit the details that were accumulated in previous steps:
122120
- GitHub App Webhook Secret
123121
- GitHub App Private Key
124122

125-
Click on Submit and the login process will be initiated.
123+
Click on Submit and the login process will be initiated.
126124
On subsequent visits, your setup will be automatically detected, allowing for direct login.
127125

128-
### **Step 5: Whitelist CodeRabbit IP address**
126+
### **Step 5: Install the GitHub App**
127+
128+
Navigate to the GitHub App that was created from your self-hosted instance and click on the **Install App** tab.
129+
Then, install the GitHub App to your organization(s).
130+
131+
:::warning
132+
133+
If you performed this step before Step 4, the install event likely will have failed and you will need to re-send the installation event.
134+
Navigate to the **Advanced** tab in the GitHub App and click on the **Redeliver** button for the failed `installation.created` event.
135+
136+
:::
137+
138+
### **Step 6: Whitelist CodeRabbit IP address**
129139

130140
Use this CodeRabbit IP if your instance requires IP whitelisting
131141
`35.222.179.152/32`

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy