> ## Documentation Index
> Fetch the complete documentation index at: https://docs.coderabbit.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# GitHub

> Learn how to integrate CodeRabbit with GitHub.com repositories for automated AI-powered code reviews, including setup, permissions, and repository configuration.

<Info>
  For an overview of how CodeRabbit integrates with Git platforms, see [Add CodeRabbit to your repository](/platforms).

  For a hands-on tutorial with CodeRabbit performing code reviews on a live GitHub repository that you create, see [Quickstart](/getting-started/quickstart).

  GitHub Enterprise Cloud users on `*.ghe.com` should use the [Self-Hosted GitHub guide](/platforms/github-enterprise-server).
</Info>

## Prerequisites

<Warning>
  **Required permissions**

  You need to have a GitHub account with **owner-level permissions** for at least one repository associated with that account.

  If you want to authorize CodeRabbit for repositories in a GitHub organization, you need **organization owner permissions** as well.
</Warning>

## Authorize CodeRabbit with your GitHub account

<Steps>
  <Step title="Visit CodeRabbit login page">
    Navigate to [the CodeRabbit login page](https://app.coderabbit.ai/login).
  </Step>

  <Step title="Initiate GitHub login">
    Click **Login with GitHub**. Your browser will redirect to GitHub.com.
  </Step>

  <Step title="Sign in to GitHub (if required)">
    If GitHub prompts you to sign in, enter your GitHub login credentials as you normally would.
  </Step>

  <Step title="Review and authorize permissions">
    GitHub displays a summary of the information that CodeRabbit needs to integrate with your account. This includes read-only access to:

    * Organizations and teams associated with your GitHub account
    * Email addresses associated with your GitHub account

    Click **Authorize coderabbitai** to grant these permissions.
  </Step>

  <Step title="Select an organization">
    Choose the organization where you want to install CodeRabbit.

    * If you belong to multiple organizations, select from the list
    * For personal repositories, select your account name

    <Tip>
      If your organization doesn't appear in the list, add it from the organization switcher. If you select an organization with no repositories connected yet, CodeRabbit guides you through **Grant GitHub bot access** and **Select repositories**. See [Adding organizations](/management/adding-organizations) for details.
    </Tip>
  </Step>

  <Step title="Install and authorize CodeRabbit">
    Configure repository access and review the permissions CodeRabbit needs.

    ### Choose repository access

    Select which repositories CodeRabbit can access:

    **All repositories**: Grants access to all current and future repositories owned by this organization, including public repositories.

    **Only select repositories**: Limits access to specific repositories you choose from the list.

    <Tip>
      You can change this setting later if needed.
    </Tip>

    ### Review permissions

    CodeRabbit requires the following permissions to perform code reviews and manage pull requests:

    **Read-only access:**

    * Actions, discussions, members, and metadata
    * [Merge queues](https://docs.github.com/en/webhooks/webhook-events-and-payloads#merge_group)

    **Read-and-write access:**

    * [Checks](https://docs.github.com/en/rest/checks/runs#create-a-check-run), code, commit statuses, issues, and pull requests

    CodeRabbit needs read-and-write access to checks so that it can publish the `CodeRabbit` check run that reports review status on your pull requests.

    Read-only access to merge queues lets CodeRabbit receive GitHub's `merge_group` webhook. When a pull request enters a merge queue, GitHub creates a synthetic merge-group commit, and the check from the original pull request does not carry over to it. CodeRabbit publishes a check for that commit so the merge queue is not blocked. This does not rerun the review.

    <Info>
      CodeRabbit requests read and write access to your repository for its code review, issue management, and pull request generation features to work. CodeRabbit does not retain your source code after review, except when [review caching](/reference/caching) is enabled to speed up future reviews. For more information, see [the CodeRabbit Trust Center](https://trust.coderabbit.ai).
    </Info>

    ### Complete installation

    Click **Install & Authorize** (for new integrations) or **Save** (for existing integrations).
  </Step>

  <Step title="Trigger your first review (optional)">
    After installation, you can immediately see CodeRabbit in action or skip to configure settings first.

    **Option 1: Trigger a review**

    1. Select a repository from your list
    2. Choose an existing pull request
    3. CodeRabbit will perform a code review on that pull request

    **Option 2: Skip to dashboard**

    Click **Skip to App** to access the CodeRabbit dashboard and configure settings before your first review.
  </Step>
</Steps>

## Troubleshooting

<AccordionGroup>
  <Accordion title="Organization is blocked by a GitHub IP allow list">
    When you switch to a GitHub organization that is blocked by its IP allow list, CodeRabbit keeps you in your previous organization. The error identifies the blocked organization and its GitHub IP allow list.

    Access can be blocked for one or both of these reasons: one or more CodeRabbit egress IP addresses are missing from the organization's allow list, or CodeRabbit is experiencing a connectivity or routing problem. Verify that all documented CodeRabbit egress IP addresses are allowed.

    **IP allow list configuration:**

    1. Ask a GitHub organization owner to open the organization's IP allow list settings.
    2. Add CodeRabbit's outbound IP addresses:

    <CodeGroup>
      ```text IPs to allow list theme={null}
      35.222.179.152/32, 34.170.211.100/32, 136.113.208.247/32
      ```
    </CodeGroup>

    3. Save the policy changes, then switch to the organization again in CodeRabbit.

    If CodeRabbit detects intermittent access, it sends an action-required email with the subject **"CodeRabbit is intermittently unable to access your GitHub organization"** and the action **"Review IP allowlist"**. Once access is consistently restored, CodeRabbit automatically sends a recovery email with the subject **"CodeRabbit can access your GitHub organization again"**. This email confirms that no further action is required.

    <Warning>
      If the organization remains blocked after updating its IP allow list, [contact our support team](/support).
    </Warning>
  </Accordion>
</AccordionGroup>
