Skip to content
This repository was archived by the owner on Aug 16, 2025. It is now read-only.

Add documentation for integrating CodeRabbit with self-hosted GitHub #41

Closed
wants to merge 5 commits into from
Closed
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
docs: Update CodeRabbit integration documentation for self-hosted GitHub
  • Loading branch information
hasit committed May 9, 2024
commit 801614e96ad0fb0a715ac67eec46c5984a69e35c
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,13 @@ This page guides you through the process of integrating your CodeRabbit with you

4. Pull the CodeRabbit Docker image. The CodeRabbit Docker image is not available for public use. Please contact us at [[email protected]](mailto:[email protected]) for access.

```bash
cat coderabbit.json | docker login -u _json_key --password-stdin https://gcr.io
docker pull gcr.io/coderabbitprod/coderabbit-agent:latest
```

> Note: The `coderabbit.json` file is a service account key file that will be shared with you.

5. Host the image on a server, serverless function, or a container environment and expose the port `8080`.

6. Install the GitHub App on your GitHub organization or user account and point the Webhook URL to the hosted CodeRabbit instance, for example, `127.0.0.1:8080/github_webhooks`. GitHub will send events to the CodeRabbit instance.
6. Install the GitHub App on your GitHub organization or user account and point the Webhook URL to the hosted CodeRabbit instance, for example, `http://127.0.0.1:8080/github_webhooks`. GitHub will send events to the CodeRabbit instance.