Skip to content

Commit b3fb606

Browse files
committed
Fix issues and reorg steps
1 parent 7425765 commit b3fb606

File tree

1 file changed

+9
-11
lines changed

1 file changed

+9
-11
lines changed

docs/integrations/self-hosted-github.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,28 +8,24 @@ This page guides you through the process of integrating your Self-Managed GitHub
88

99
To initiate the integration, we require specific information. This is essential
1010
for the initial setup of CodeRabbit within your domain. Once this setup is
11-
complete, you can log in directly using the OAuth2 flow.
11+
complete, you can log in directly.
1212

1313
### **Step 1: Getting Started**
1414

1515
**Visit CodeRabbit:** Visit our [Login](https://coderabbit.ai/login) page and
1616
select Self-Hosted GitHub
1717

18-
![login-page](./images/login-page.png)![alt text](image.png)
19-
20-
### Step 2: Enter your Self-Managed GitHub URL
18+
![login-page](./images/login-self-hosted-github.png)
2119

2220
On this page, enter the URL of your self-managed GitHub instance and click
2321
submit. Once, you submit, we check our database for a record of your
2422
organization and if we find an existing one, we will start the login process.
2523

2624
![Untitled](./images/self-hosted-github-host-url.png)
2725

28-
If the self-managed GitHub instance is not found, we initiate the onboarding process, which can be either manual or automated.
29-
30-
### **Step 3: Onboarding**
26+
If the self-managed GitHub instance is not found, you will be required to enter more details for the onboarding.
3127

32-
#### Creating an OAuth App
28+
### **Step 2: GitHub OAuth App**
3329

3430
Navigate to your GitHub Self-Hosted Instance and follow the steps below to [create an OAuth App](https://docs.github.com/en/enterprise-server@latest/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app):
3531

@@ -55,7 +51,7 @@ Keep the following details handy:
5551

5652
![GitHub OAuth Client ID & Secret](./images/github-oauth-client-id-secret.png)
5753

58-
#### Creating a GitHub App**
54+
### **Step 3: GitHub App**
5955

6056
Navigate to your GitHub Self-Hosted Instance and follow the steps below to [create a GitHub App](https://docs.github.com/en/enterprise-server@latest/apps/creating-github-apps/registering-a-github-app/registering-a-github-app):
6157

@@ -81,7 +77,7 @@ Navigate to your GitHub Self-Hosted Instance and follow the steps below to [crea
8177
- **Metadata**: Read-only
8278
- **Pull requests**: Read and write
8379
- **Organization permissions**:
84-
**Members**: Read-only
80+
- **Members**: Read-only
8581
- **Events**:
8682
- Meta
8783
- Issue comment
@@ -100,6 +96,8 @@ Once the GitHub App has been created, click on **Generate a new client secret**
10096

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

99+
Also, from the **Install App** tab, install the GitHub App to your organizations.
100+
103101
Keep the following details handy:
104102

105103
- App ID
@@ -112,7 +110,7 @@ Keep the following details handy:
112110

113111
### **Step 4: CodeRabbit UI Onboarding**
114112

115-
Submit the details that were accumulated:
113+
Submit the details that were accumulated in previous steps:
116114

117115
- Host URL of your GitHub instance
118116
- OAuth Client ID

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