Skip to content
This repository was archived by the owner on Aug 16, 2025. It is now read-only.
Merged
Prev Previous commit
Improve formatting and organization of GitHub App configuration instr…
…uctions
  • Loading branch information
hasit committed Mar 27, 2025
commit 6c132c19d528da436309ca7355629bf92dbe7fdc
69 changes: 33 additions & 36 deletions docs/platforms/github-enterprise-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,45 +75,42 @@ 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**.
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`
- **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

- **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
6. Click **Create GitHub App**.

Once the GitHub App has been created, click on **Generate a new client secret**
Expand Down