This repository was archived by the owner on Aug 16, 2025. It is now read-only.
- Notifications
You must be signed in to change notification settings - Fork69
Self-Hosted GitHub onboarding docs#66
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
Show all changes
4 commits Select commitHold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
2 changes: 1 addition & 1 deletiondocs/integrations/knowledge-base.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
134 changes: 134 additions & 0 deletionsdocs/integrations/self-hosted-github.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,134 @@ | ||
| --- | ||
| title: CodeRabbit for Self-Managed GitHub | ||
| description: Integrate CodeRabbit with your Self-Managed GitHub instance. | ||
| sidebar_label: Self-Managed GitHub | ||
| sidebar_position: 3 | ||
| --- | ||
| 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 | ||
| for the initial setup of CodeRabbit within your domain. Once this setup is | ||
| complete, you can log in directly. | ||
| ### **Step 1: Getting Started** | ||
| **Visit CodeRabbit:** Visit our [Login](https://coderabbit.ai/login) page and | ||
| select Self-Hosted GitHub | ||
|  | ||
| On this page, enter the URL of your self-managed GitHub instance and click | ||
| submit. Once, you submit, we check our database for a record of your | ||
| organization and if we find an existing one, we will start the login process. | ||
|  | ||
| If the self-managed GitHub instance is not found, you will be required to enter more details for the onboarding. | ||
| ### **Step 2: GitHub OAuth App** | ||
| 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): | ||
| 1. Sign in to your GitHub Enterprise account. | ||
| 2. In the upper-right corner of any page, click your profile photo, then click **Settings**. | ||
| 3. In the left sidebar, click **Developer settings** > **OAuth Apps**. | ||
| 4. Click **New OAuth App**. | ||
| 5. Set the following fields: | ||
| - **Application name**: `CodeRabbit OAuth` | ||
| - **Homepage URL**: `https://coderabbit.ai` | ||
| - **Application description**: `OAuth application for signing into CodeRabbit` | ||
| - **Authorization callback URL**: `https://app.coderabbit.ai/login` | ||
| 6. Click **Register application**. | ||
|  | ||
| 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 | ||
| Keep the following details handy: | ||
| - Client ID | ||
| - Client secret | ||
|  | ||
| ### **Step 3: GitHub App** | ||
| 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): | ||
| 1. Sign in to your GitHub Enterprise account. | ||
| 2. In the upper-right corner of any page, click your profile photo, then click **Settings**. | ||
| 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` | ||
| - **Description**: `GitHub App for CodeRabbit` | ||
| - **Homepage URL**: `https://coderabbit.ai` | ||
| - **Callback URL**: `https://app.coderabbit.ai/login` | ||
| - **Request user authorization (OAuth) during installation**: `true` | ||
| - **Webhook Active**: `true` | ||
| - **Webhook URL**: `https://app.coderabbit.ai/githubHandler` | ||
| - **Webhook secret**: Use a secure string and keep it handy. | ||
| - **Permissions**: | ||
| - **Repository permissions**: | ||
| - **Checks**: Read-only | ||
| - **Contents**: Read and write | ||
| - **Discussions**: Read-only | ||
| - **Issues**: Read and write | ||
| - **Metadata**: Read-only | ||
| - **Pull requests**: Read and write | ||
| - **Organization permissions**: | ||
| - **Members**: Read-only | ||
| - **Events**: | ||
| - Meta | ||
| - Issue comment | ||
| - Issues | ||
| - Label | ||
| - Public | ||
| - Pull request | ||
| - Pull request review | ||
| - Pull request review comment | ||
| - Pull request review thread | ||
| - Push | ||
| - Release | ||
| 6. Click **Create GitHub App**. | ||
| 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. | ||
| 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 | ||
| - Client ID | ||
| - Client secret | ||
| - Webhook secret | ||
| - Private key | ||
|  | ||
| ### **Step 4: CodeRabbit UI Onboarding** | ||
| Submit the details that were accumulated in previous steps: | ||
| - Host URL of your GitHub instance | ||
| - OAuth Client ID | ||
| - OAuth Client Secret | ||
| - GitHub App ID | ||
| - GitHub App Client ID | ||
| - GitHub App Client Secret | ||
| - GitHub App Webhook Secret | ||
| - GitHub App Private Key | ||
| 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** | ||
| Use this CodeRabbit IP if your instance requires IP whitelisting | ||
| `35.222.179.152/32` | ||
| VPN tunneling is available as an add-on package. Please reach out to us at | ||
| [contact@coderabbit.ai](mailto:contact@coderabbit.ai) if you are interested. |
2 changes: 1 addition & 1 deletiondocs/integrations/self-hosted-gitlab.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong.Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file addedstatic/img/integrations/github-create-oauth-app.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 addedstatic/img/integrations/github-oauth-client-id-secret.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 removedstatic/img/integrations/login-page.png
Binary file not shown.
Binary file addedstatic/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 addedstatic/img/integrations/login-self-hosted-gitlab.png
Loading
Sorry, something went wrong.Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong.Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.