This page guides you through the process of integrating your Self-Managed GitHubwith CodeRabbit.

To initiate the integration, we require specific information. This is essentialfor the initial setup of CodeRabbit within your domain. Once this setup iscomplete, you can log in directly.

Step 1: Getting Started​

Visit CodeRabbit: Visit ourLogin page andselect Self-Hosted GitHub

On this page, enter the URL of your self-managed GitHub instance and clicksubmit. Once, you submit, we check our database for a record of yourorganization 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 entermore details for the onboarding.

Step 2: GitHub OAuth App​

Navigate to your GitHub Enterprise Server (Self-Hosted) Instance and follow thesteps below tocreate 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 clickSettings.
3. In the left sidebar, clickDeveloper settings >OAuth Apps.
4. ClickNew 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. ClickRegister application.

Once the OAuth App has been created, click onGenerate a new client secretunder the 'Client secrets' section and copy the secret as it will be visibleonce only

Keep the following details handy:

• Client ID
• Client secret

Step 3: GitHub App​

Navigate to your GitHub Enterprise Server (Self-Hosted) Instance and follow thesteps below tocreate 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 clickSettings.
3. In the left sidebar, clickDeveloper settings >GitHub Apps
4. ClickNew GitHub App.
5. Set the following fields:
   • GitHub App name:CodeRabbit
   • 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:
       • Actions: Read-only
       • Checks: Read-only
       • Contents: Read and write
       • Commit statuses: 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
   • Where can this GitHub App be installed?: SelectAny account
6. ClickCreate GitHub App.

Once the GitHub App has been created, click onGenerate a new client secretunder the 'Client secrets' section and copy the secret as it will be visibleonce only.

Scroll down and click onGenerate a private key under the 'Private keys'section and download the PEM file.

Keep the following details handy:

• App ID
• Client ID
• Client secret
• Webhook secret
• Private key

We recommend using the CodeRabbitlogo as the profile picture to ensures easy recognition.

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: Install the GitHub App​

Navigate to the GitHub App that was created from your GitHub Enterprise Server(self-hosted) instance and click on theInstall App tab. Then, install theGitHub App to your organization(s).

Step 6: Whitelist CodeRabbit IP address​

Use this CodeRabbit IP if your instance requires IP whitelisting35.222.179.152/32 and34.170.211.100/32.

VPN tunneling is available as an add-on package. Please reach out to us atsupport@coderabbit.ai 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 administrativeprivileges 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.
• The browser local storage and cookies related to CodeRabbit are cleared.

If the issue persists, contact our support team.