Add step to install GitHub App for Self-Hosted (#70)

Spikatrix · web-flow · commit 2f96bbe6167a · 2024-07-24T18:08:02.000+05:30
* Add step to install GitHub App

* Disclaimer

* Coderabbit suggestion: install -&gt; installation

* Coderabbit suggestions
diff --git a/docs/integrations/self-hosted-github.md b/docs/integrations/self-hosted-github.md
@@ -5,6 +5,13 @@ sidebar_label: Self-Managed GitHub
 sidebar_position: 3
 ---
 
+:::info
+
+This page is for GitHub Enterprise Self-Hosted users only.  
+If you're using github.com, [log in to CodeRabbit](https://app.coderabbit.ai) and add your repositories from there
+
+:::
+
 This page guides you through the process of integrating your Self-Managed GitHub with CodeRabbit.
 
 To 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
 3. In the left sidebar, click **Developer settings** > **GitHub Apps**
 4. Click **New GitHub App**.
 5. Set the following fields:
-   - **GitHub App name**: `CodeRabbit GitHub App`
+   - **GitHub App name**: `CodeRabbit`
    - **Description**: `GitHub App for CodeRabbit`
    - **Homepage URL**: `https://coderabbit.ai`
    - **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**
 
 Scroll down and click on **Generate a private key** under the 'Private keys' section and download the PEM file.
 
-Also, from the **Install App** tab, install the GitHub App to your organizations.
-
 Keep the following details handy:
 
 - App ID
@@ -122,10 +127,22 @@ Submit the details that were accumulated in previous steps:
 - GitHub App Webhook Secret
 - GitHub App Private Key
 
-Click on Submit and the login process will be initiated. 
+Click on Submit and the login process will be initiated.
 On subsequent visits, your setup will be automatically detected, allowing for direct login.
 
-### **Step 5: Whitelist CodeRabbit IP address**
+### **Step 5: Install the GitHub App**
+
+Navigate to the GitHub App that was created from your self-hosted instance and click on the **Install App** tab.
+Then, install the GitHub App to your organization(s).
+
+:::warning
+
+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.  
+Navigate to the **Advanced** tab in the GitHub App and click on the **Redeliver** button for the failed `installation.created` event.
+
+:::
+
+### **Step 6: Whitelist CodeRabbit IP address**
 
 Use this CodeRabbit IP if your instance requires IP whitelisting
 `35.222.179.152/32`
