Skip to content

Commit 2c85895

Browse files
authored
Add FAQ section and installation details for GitHub App integration (#364)
* Add FAQ section and installation details for GitHub App integration * Refine troubleshooting instructions for login errors in GitHub Enterprise Server integration
1 parent 002a4b4 commit 2c85895

File tree

3 files changed

+17
-0
lines changed

3 files changed

+17
-0
lines changed

docs/platforms/github-enterprise-server.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,7 @@ steps below to
111111
- Pull request review thread
112112
- Push
113113
- Release
114+
- **Where can this GitHub App be installed?**: Select `Any account`
114115
6. Click **Create GitHub App**.
115116

116117
Once the GitHub App has been created, click on **Generate a new client secret**
@@ -170,3 +171,19 @@ Use this CodeRabbit IP if your instance requires IP whitelisting
170171

171172
VPN tunneling is available as an add-on package. Please reach out to us at
172173
[contact@coderabbit.ai](mailto:contact@coderabbit.ai) if you are interested.
174+
175+
### **FAQ**
176+
177+
#### Who should create the OAuth App and GitHub App?
178+
179+
The OAuth App and GitHub App should be created by a user with administrative
180+
privileges on the GitHub Enterprise Server instance. This user will be responsible for managing the integration with CodeRabbit.
181+
182+
#### I see an error when trying to log in to CodeRabbit. What should I do?
183+
184+
If you encounter an error during the login process, please ensure that:
185+
186+
- The OAuth App and GitHub App are correctly configured with the right URLs and permissions.
187+
- The browser local storage and cookies related to CodeRabbit are cleared.
188+
189+
If the issue persists, contact our support team.
Loading
Loading

0 commit comments

Comments
 (0)