diff --git a/docs/platforms/platforms.md b/docs/platforms/platforms.md index ef7a8792..ab0cc068 100644 --- a/docs/platforms/platforms.md +++ b/docs/platforms/platforms.md @@ -11,28 +11,30 @@ CodeRabbit supports various Git platforms to provide code review for your reposi | Host | Support | | ------------------------ | ---------------------------------------- | -| GitHub.com | [Supported][login] | +| 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) | +| 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] | +| Host | Support | +| ------------------- | ------------------------------------------- | +| Azure DevOps | [Supported](azure-devops.md) | +| Azure DevOps Server | [Supported](../self-hosted/azure-devops.md) | ## Bitbucket -| Host | Support | -| --------------------- | ----------- | -| Cloud | Coming soon | -| Bitbucket Data Center | [Supported] | +| Host | Support | +| -------------------- | ---------------------------------------- | +| Bitbucket Datacenter | [Supported](../self-hosted/bitbucket.md) | +| Bitbucket Cloud | Coming soon | [login]: https://app.coderabbit.ai/login diff --git a/docs/self-hosted/bitbucket.md b/docs/self-hosted/bitbucket.md new file mode 100644 index 00000000..12575148 --- /dev/null +++ b/docs/self-hosted/bitbucket.md @@ -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`). + +## 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_BASE_URL=[] +OPENAI_ORG_ID=[] +OPENAI_PROJECT_ID=[] + +# if using Azure OpenAI +LLM_PROVIDER=azure-openai +LLM_TIMEOUT=360000 +AZURE_OPENAI_ENDPOINT= +AZURE_OPENAI_API_KEY= +AZURE_GPT4OMINI_DEPLOYMENT_NAME= +AZURE_GPT4O_DEPLOYMENT_NAME= # modelVersion: 2024-08-06 +AZURE_O1_MINI_DEPLOYMENT_NAME=[] # Optional +AZURE_O1_DEPLOYMENT_NAME=[] # Optional: Provides best reviews but very expensive +AZURE_GPT4TURBO_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=/rest +BITBUCKET_SERVER_WEBHOOK_SECRET= +BITBUCKET_SERVER_BOT_TOKEN= +BITBUCKET_SERVER_BOT_USERNAME= +CODERABBIT_LICENSE_KEY= +CODERABBIT_API_KEY=[] + +# Optional Features +ENABLE_LEARNINGS=[true] +ENABLE_METRICS=[true] +JIRA_HOST=[] +JIRA_PAT=[] +LINEAR_PAT=[] +``` + +:::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 +``` + +### 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 +``` pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy