You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
If the self-managed GitHub instance is not found, you will be required to enter more details for the onboarding.
36
+
If the self-managed GitHub instance is not found, you will be required to enter
37
+
more details for the onboarding.
35
38
36
39
### **Step 2: GitHub OAuth App**
37
40
38
-
Navigate to your GitHub Enterprise Server (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):
41
+
Navigate to your GitHub Enterprise Server (Self-Hosted) Instance and follow the
42
+
steps below to
43
+
[create an OAuth App](https://docs.github.com/en/enterprise-server@latest/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app):
39
44
40
45
1. Sign in to your GitHub Enterprise account.
41
-
2. In the upper-right corner of any page, click your profile photo, then click **Settings**.
46
+
2. In the upper-right corner of any page, click your profile photo, then click
47
+
**Settings**.
42
48
3. In the left sidebar, click **Developer settings** > **OAuth Apps**.
43
49
4. Click **New OAuth App**.
44
50
5. Set the following fields:
45
51
-**Application name**: `CodeRabbit OAuth`
46
52
-**Homepage URL**: `https://coderabbit.ai`
47
-
-**Application description**: `OAuth application for signing into CodeRabbit`
Once the OAuth App has been created, click on **Generate a new client secret** under the 'Client secrets' section and copy the secret as it will be visible once only
60
+
Once the OAuth App has been created, click on **Generate a new client secret**
61
+
under the 'Client secrets' section and copy the secret as it will be visible
62
+
once only
54
63
55
64
Keep the following details handy:
56
65
@@ -61,10 +70,13 @@ Keep the following details handy:
61
70
62
71
### **Step 3: GitHub App**
63
72
64
-
Navigate to your GitHub Enterprise Server (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):
73
+
Navigate to your GitHub Enterprise Server (Self-Hosted) Instance and follow the
74
+
steps below to
75
+
[create a GitHub App](https://docs.github.com/en/enterprise-server@latest/apps/creating-github-apps/registering-a-github-app/registering-a-github-app):
65
76
66
77
1. Sign in to your GitHub Enterprise account.
67
-
2. In the upper-right corner of any page, click your profile photo, then click **Settings**.
78
+
2. In the upper-right corner of any page, click your profile photo, then click
79
+
**Settings**.
68
80
3. In the left sidebar, click **Developer settings** > **GitHub Apps**
69
81
4. Click **New GitHub App**.
70
82
5. Set the following fields:
@@ -100,9 +112,12 @@ Navigate to your GitHub Enterprise Server (Self-Hosted) Instance and follow the
100
112
- Release
101
113
6. Click **Create GitHub App**.
102
114
103
-
Once the GitHub App has been created, click on **Generate a new client secret** under the 'Client secrets' section and copy the secret as it will be visible once only.
115
+
Once the GitHub App has been created, click on **Generate a new client secret**
116
+
under the 'Client secrets' section and copy the secret as it will be visible
117
+
once only.
104
118
105
-
Scroll down and click on **Generate a private key** under the 'Private keys' section and download the PEM file.
119
+
Scroll down and click on **Generate a private key** under the 'Private keys'
120
+
section and download the PEM file.
106
121
107
122
Keep the following details handy:
108
123
@@ -127,18 +142,21 @@ Submit the details that were accumulated in previous steps:
127
142
- GitHub App Webhook Secret
128
143
- GitHub App Private Key
129
144
130
-
Click on Submit and the login process will be initiated.
131
-
On subsequent visits, your setup will be automatically detected, allowing for direct login.
145
+
Click on Submit and the login process will be initiated. On subsequent visits,
146
+
your setup will be automatically detected, allowing for direct login.
132
147
133
148
### **Step 5: Install the GitHub App**
134
149
135
-
Navigate to the GitHub App that was created from your Github Enterprise Server (self-hosted) instance and click on the **Install App** tab.
136
-
Then, install the GitHub App to your organization(s).
150
+
Navigate to the GitHub App that was created from your GitHub Enterprise Server
151
+
(self-hosted) instance and click on the **Install App** tab. Then, install the
152
+
GitHub App to your organization(s).
137
153
138
154
:::warning
139
155
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.
156
+
If you performed this step before Step 4, the installation event likely will
157
+
have failed, and you will need to re-send the installation event.
158
+
Navigate to the **Advanced** tab in the GitHub App and click on the
159
+
**Redeliver** button for the failed `installation.created` event.
0 commit comments