Skip to content

Add FAQ section and installation details for GitHub App integration #364

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 27, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions docs/platforms/github-enterprise-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,7 @@ steps below to
- Pull request review thread
- Push
- Release
- **Where can this GitHub App be installed?**: Select `Any account`
6. Click **Create GitHub App**.

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

VPN tunneling is available as an add-on package. Please reach out to us at
[[email protected]](mailto:[email protected]) if you are interested.

### **FAQ**

#### Who should create the OAuth App and GitHub App?

The OAuth App and GitHub App should be created by a user with administrative
privileges on the GitHub Enterprise Server instance. This user will be responsible for managing the integration with CodeRabbit.

#### I see an error when trying to log in to CodeRabbit. What should I do?

If you encounter an error during the login process, please ensure that:

- The OAuth App and GitHub App are correctly configured with the right URLs and permissions.
- Clear your browser local storage and cookies related to CodeRabbit.
- If the issue persists, contact our support team.
Binary file modified static/img/integrations/login-self-hosted-github.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/integrations/self-hosted-github-host-url.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.