This repository was archived by the owner on Aug 16, 2025. It is now read-only.
- Notifications
You must be signed in to change notification settings - Fork69
add bitbucket docs#176
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
Show all changes
9 commits Select commitHold shift + click to select a range
4ebcc0c add bitbucket docs
alexcoderabbitaidd5438c Update docs/self-hosted/bitbucket.md
alexcoderabbitai78d723a 🎨 pnpm run lint:fix
github-actions[bot]f076207 fix bitbucket name
alexcoderabbitai6e672ad 🎨 pnpm run lint:fix
github-actions[bot]91d2d1a Merge branch 'main' into feat/bitbucket-docs
alexcoderabbitaibb78a2b add to platform list
alexcoderabbitaibdd0311 🎨 pnpm run lint:fix
github-actions[bot]a26a251 fixing platforms page
alexcoderabbitaiFile filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
28 changes: 15 additions & 13 deletionsdocs/platforms/platforms.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -11,28 +11,30 @@ CodeRabbit supports various Git platforms to provide code review for your reposi | ||
| | Host | Support | | ||
| | ------------------------ | ---------------------------------------- | | ||
| | GitHub.com | [Supported](github-com.md) | | ||
| | GitHub Enterprise Server | [Supported](github-enterprise-server.md) | | ||
| | GitHub Self Hosted | [Supported](../self-hosted/github.md) | | ||
| ## GitLab | ||
| | Host | Support | | ||
| | ------------------- | ------------------------------------- | | ||
| | GitLab.com | [Supported](gitlab-com.md) | | ||
| | GitLab Self Managed | [Supported](self-hosted-gitlab.md) | | ||
| | GitLab Self Hosted | [Supported](../self-hosted/gitlab.md) | | ||
| ## Azure DevOps | ||
| | Host | Support| | ||
| | ------------------- | ------------------------------------------- | | ||
| | Azure DevOps | [Supported](azure-devops.md)| | ||
| | Azure DevOps Server | [Supported](../self-hosted/azure-devops.md) | | ||
| ## Bitbucket | ||
| | Host | Support | | ||
| | -------------------- |---------------------------------------- | | ||
| |Bitbucket Datacenter | [Supported](../self-hosted/bitbucket.md) | | ||
| | BitbucketCloud | Coming soon | | ||
alexcoderabbitai marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| [login]: https://app.coderabbit.ai/login | ||
114 changes: 114 additions & 0 deletionsdocs/self-hosted/bitbucket.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,114 @@ | ||
| --- | ||
| title:Use Self-Hosted CodeRabbit With Bitbucket Datacenter | ||
| sidebar_label:Bitbucket Datacenter | ||
| description:Instructions to self-host CodeRabbit and integrate it with Bitbucket Datacenter. | ||
| sidebar_position:4 | ||
| --- | ||
| :::note | ||
| The self-hosted option is only available for CodeRabbit Enterprise customers with 500 user seats or more. Please contact[CodeRabbit Sales](mailto:sales@coderabbit.ai) to learn more about the CodeRabbit Enterprise plan. | ||
| ::: | ||
| ##Create a Bitbucket User | ||
| -**Username**: Set the username to "CodeRabbit" for easier identification (optional). | ||
| -**Profile Image**: Use the CodeRabbitAI logo for the user image (optional). | ||
| ##Add User to Projects | ||
| Add the CodeRabbit user to each project where you want CodeRabbit to post reviews, with permissions to: | ||
| - Post reviews | ||
| - Open pull requests | ||
| ##Create a Personal Access Token for CodeRabbit user | ||
| Generate a personal access token for the CodeRabbit user to be added in the`.env` file as`BITBUCKET_SERVER_BOT_TOKEN`. | ||
| ##Add a webhook to each project | ||
| 1.**Navigate to Webhook Settings**: Go to the repository settings and locate the webhooks configuration page. | ||
| 2.**Configure Events**: Enable the following Pull Request events: | ||
| - "Opened" | ||
| - "Modified" | ||
| - "Comment Added" | ||
| 3.**Add Webhook URL**: Enter the URL pointing to the CodeRabbit service, followed by`/bitbucket_server_webhooks` (e.g.,`http://127.0.0.1:8080/bitbucket_server_webhooks`). | ||
alexcoderabbitai marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| ##Prepare an`.env` file | ||
| Create an`.env` file with the following content: | ||
| ```bash | ||
| # if using OpenAI | ||
| LLM_PROVIDER=openai | ||
| LLM_TIMEOUT=360000 | ||
| OPENAI_API_KEYS=<openai-key> | ||
| OPENAI_BASE_URL=[<openai-base-url>] | ||
| OPENAI_ORG_ID=[<openai-org-id>] | ||
| OPENAI_PROJECT_ID=[<openai-project-id>] | ||
| # if using Azure OpenAI | ||
| LLM_PROVIDER=azure-openai | ||
| LLM_TIMEOUT=360000 | ||
| AZURE_OPENAI_ENDPOINT=<azure-openai-endpoint> | ||
| AZURE_OPENAI_API_KEY=<key> | ||
| AZURE_GPT4OMINI_DEPLOYMENT_NAME=<gpt-4o-mini-deployment-name> | ||
| AZURE_GPT4O_DEPLOYMENT_NAME=<gpt-4o-deployment-name># modelVersion: 2024-08-06 | ||
| AZURE_O1_MINI_DEPLOYMENT_NAME=[<o1-mini-deployment-name>]# Optional | ||
| AZURE_O1_DEPLOYMENT_NAME=[<o1-preview-deployment-name>]# Optional: Provides best reviews but very expensive | ||
| AZURE_GPT4TURBO_DEPLOYMENT_NAME=[<gpt-4-turbo-deployment-name>]# Optional: modelVersion: turbo-2024-04-09 | ||
| # System Configuration | ||
| TEMP_PATH=/cache | ||
| AST_GREP_RULES_PATH=/home/jailuser/ast-grep-rules | ||
| AST_GREP_ESSENTIALS=ast-grep-essentials | ||
| SELF_HOSTED=bitbucket-server | ||
| BITBUCKET_SERVER_URL=<bitbucket-server-url>/rest | ||
| BITBUCKET_SERVER_WEBHOOK_SECRET=<webhook-secret> | ||
| BITBUCKET_SERVER_BOT_TOKEN=<personal-access-token> | ||
alexcoderabbitai marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| BITBUCKET_SERVER_BOT_USERNAME=<bot-user-username> | ||
| CODERABBIT_LICENSE_KEY=<license-key> | ||
| CODERABBIT_API_KEY=[<coderabbitai-api-key>] | ||
| # Optional Features | ||
| ENABLE_LEARNINGS=[true] | ||
| ENABLE_METRICS=[true] | ||
| JIRA_HOST=[<jira-host-url>] | ||
| JIRA_PAT=[<jira-personal-access-token>] | ||
| LINEAR_PAT=[<linear-personal-access-token>] | ||
| ``` | ||
| :::note | ||
| - If you are using Azure OpenAI, verify that the model deployment names are in the .env file. | ||
| Values marked with[] are optional and can be omitted if the feature is not needed. | ||
| - You can generate`CODERABBIT_API_KEY` from CodeRabbit UI -> Organizations Settings -> API Keys. | ||
| ::: | ||
| ##Pull the CodeRabbit Docker image | ||
| Authenticate and pull the Docker image using the provided credentials file: | ||
| ```bash | ||
| cat coderabbit.json| docker login -u _json_key --password-stdin us-docker.pkg.dev | ||
| docker pull us-docker.pkg.dev/coderabbitprod/self-hosted/coderabbit-agent:latest | ||
| ``` | ||
alexcoderabbitai marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| ###Verify the image is up | ||
| You can query`/health` endpoint to verify that the coderabbit-agent service is up and running. | ||
| ```bash | ||
| curl 127.0.0.1:8080/health | ||
| ``` | ||
| ##Host the image | ||
| You can host the image on a server, serverless function, or container environment and expose port`8080`. Run the Docker image with the equivalent command on your chosen platform, ensuring you replace the`.env` file path with the path to your actual`.env` file: | ||
| ```bash | ||
| docker run --env-file .env --publish 127.0.0.1:8080:8080 us-docker.pkg.dev/coderabbitprod/self-hosted/coderabbit-agent:latest | ||
alexcoderabbitai marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| ``` | ||
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.