This guide is specifically for GitHub Enterprise Server (Self-Hosted) users. If you’re using GitHub.com, see our GitHub integration guide instead.
Before you begin: Ensure you have the following prerequisites before starting the integration process: Administrative privileges on your GitHub Enterprise Server instance
Access to create OAuth Apps and GitHub Apps in your organization
Network connectivity allowing webhooks from CodeRabbit to your instance
Ability to whitelist IP addresses if required by your security policy
Ability to whitelist IP addresses if required by your security policy
Integration overview
The GitHub Enterprise Server integration requires several components working together:OAuth App
Handles user authentication and login flow
GitHub App
Provides repository access and webhook functionality
Webhook Configuration
Enables real-time event processing
Network Access
Allows CodeRabbit to communicate with your instance
Setup process
Follow these steps to integrate CodeRabbit with your GitHub Enterprise Server:1
Initialize CodeRabbit connection
Visit the CodeRabbit login page and select Self-Hosted GitHub.
- Start the login process if your instance is already configured
-
Prompt for additional setup details if this is a new integration
2
Create GitHub OAuth App
Navigate to your GitHub Enterprise Server instance and create an OAuth App for user authentication.Configuration steps:
For detailed instructions, see GitHub’s official documentation on creating an OAuth App.
- Sign in to your GitHub Enterprise Server as an administrator
- Navigate to Settings → Developer settings → OAuth Apps
- Click New OAuth App
- Configure the OAuth App with these exact settings:
| Field | Value |
|---|---|
| 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 |
-
Click Register application
- Click Generate a new client secret under the ‘Client secrets’ section
-
Copy and securely store the following credentials:
- Client ID
- Client secret (visible only once)
The client secret is only displayed once. Make sure to copy it immediately and store it securely.
3
Create GitHub App
Create a GitHub App to enable CodeRabbit’s repository access and webhook functionality.App configuration:
For detailed instructions, see GitHub’s official documentation on registering a GitHub App.
- Navigate to Settings → Developer settings → GitHub Apps
- Click New GitHub App
- Configure the basic app settings:
| Field | Value |
|---|---|
| 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 | ✓ Enabled |
| Where can this GitHub App be installed? | Any account |
- Click Create GitHub App
- Client Secret: Click Generate a new client secret and copy it immediately
- Private Key: Click Generate a private key and download the PEM file
- Note the App ID and Client ID displayed on the page
Required credentials checklist
Required credentials checklist
Make sure you have saved all of these:
- ✅ App ID
- ✅ Client ID
- ✅ Client secret
- ✅ Webhook secret
- ✅ Private key (PEM file)
Customize the app appearance: Use the CodeRabbit logo as the profile picture for easy recognition in your GitHub interface.
4
Complete CodeRabbit setup
Submit all the credentials you’ve gathered to complete the integration setup.In the CodeRabbit onboarding form, enter the following information:
Click Submit to complete the setup. CodeRabbit will validate the configuration and initiate the login process. On subsequent visits, your setup will be automatically detected for direct login.
GitHub instance configuration
GitHub instance configuration
- Host URL: Your GitHub Enterprise Server URL
OAuth App credentials
OAuth App credentials
- OAuth Client ID: From Step 2
- OAuth Client Secret: From Step 2
GitHub App credentials
GitHub App credentials
- GitHub App ID: From Step 3
- GitHub App Client ID: From Step 3
- GitHub App Client Secret: From Step 3
- GitHub App Webhook Secret: From Step 3
- GitHub App Private Key: Upload the PEM file from Step 3
5
Install the GitHub App
Install the GitHub App to your organizations to enable CodeRabbit access to repositories.
- Navigate to your GitHub App in GitHub Enterprise Server
- Click the Install App tab
- Select the organization(s) where you want to install CodeRabbit
- Choose repository access:
- All repositories (recommended for full integration)
- Selected repositories (for limited access)
- Click Install
Important timing: If you install the GitHub App before completing Step 4 (CodeRabbit setup), the installation event will fail. If this happens:
- Go to your GitHub App’s Advanced tab
- Find the failed
installation.createdevent - Click Redeliver to resend the webhook
6
Configure network access
Ensure your GitHub Enterprise Server can communicate with CodeRabbit by configuring network access.IP Allowlisting:If your instance requires IP allowlisting, add these CodeRabbit IP addresses to your firewall:VPN Integration:For enhanced security or complex network setups, CodeRabbit offers VPN tunneling to enable secure, direct connectivity between CodeRabbit and your GitHub Enterprise Server through an encrypted tunnel.
Enterprise Feature: VPN tunneling is available to customers on the Enterprise tier only.
Troubleshooting
Who should create the OAuth App and GitHub App?
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 CodeRabbit integration
- Handling app installations across organizations
- Troubleshooting permission issues
The administrator who creates these apps will have access to manage CodeRabbit’s integration settings.
I see an error when trying to log in to CodeRabbit
I see an error when trying to log in to CodeRabbit
If you encounter login errors, try these troubleshooting steps:Configuration verification:
- Verify all OAuth App and GitHub App settings match the required configuration
- Ensure webhook URLs are accessible from your GitHub Enterprise Server
- Confirm all credentials are correctly entered in CodeRabbit
- Clear browser cache and cookies for both CodeRabbit and your GitHub instance
- Try logging in from an incognito/private browser window
- Disable browser extensions that might interfere with authentication
- Verify your GitHub Enterprise Server can reach
app.coderabbit.ai - Check firewall rules and proxy settings
- Ensure CodeRabbit IPs are allowlisted if required
If issues persist after trying these steps, contact our support team with details about the error messages you’re seeing.
Webhook events are not being received
Webhook events are not being received
If CodeRabbit isn’t responding to repository events:
-
Check webhook configuration:
- Verify the webhook URL is
https://app.coderabbit.ai/githubHandler - Ensure webhook is active in your GitHub App settings
- Confirm the webhook secret matches what you entered in CodeRabbit
- Verify the webhook URL is
-
Test webhook delivery:
- Go to your GitHub App’s Advanced tab
- Look for recent webhook deliveries and their response codes
- Redeliver failed webhooks to test connectivity
-
Network connectivity:
- Ensure your GitHub Enterprise Server can reach CodeRabbit’s webhook URL
- Check for any proxy or firewall blocking outbound requests
CodeRabbit isn't reviewing pull requests
CodeRabbit isn't reviewing pull requests
If CodeRabbit has access but isn’t providing reviews:
-
Verify installation:
- Confirm the GitHub App is installed on the correct organization
- Check that CodeRabbit has access to the specific repository
- Ensure the repository isn’t archived or has restrictions
-
Check permissions:
- Verify all required repository permissions are granted
- Confirm CodeRabbit can read pull requests and write comments
-
Review configuration:
- Check if there are any custom review instructions blocking reviews
- Verify the repository doesn’t have CodeRabbit disabled in settings
What’s next
Once your GitHub Enterprise Server integration is complete, you can customize CodeRabbit to fit your team’s workflow:Configure repositories
Set up repository-specific preferences and review settings
Add review instructions
Create custom guidelines for CodeRabbit to follow
Learn about code reviews
Understand how CodeRabbit reviews your pull requests
Explore integrations
Connect additional tools and knowledge sources