From 17758de100e6776a891f03740999c21a32f23f77 Mon Sep 17 00:00:00 2001 From: Hasit Mistry Date: Wed, 5 Feb 2025 18:11:22 -0800 Subject: [PATCH] Update self-hosted docs Add OAuth2 configuration options and specify LLM timeout for self-hosted setups --- docs/self-hosted/azure-devops.md | 8 ++++++++ docs/self-hosted/bitbucket.md | 12 ++++++++++-- docs/self-hosted/github.md | 13 ++++++++----- docs/self-hosted/gitlab.md | 8 ++++++++ 4 files changed, 34 insertions(+), 7 deletions(-) diff --git a/docs/self-hosted/azure-devops.md b/docs/self-hosted/azure-devops.md index 4f8842b3..bc9351f5 100644 --- a/docs/self-hosted/azure-devops.md +++ b/docs/self-hosted/azure-devops.md @@ -68,8 +68,15 @@ AZURE_O1_DEPLOYMENT_NAME= # optionally, you can swap o3-mini with o1-mini AZURE_O1MINI_DEPLOYMENT_NAME=[] +# OAuth2 Configuration (optional) +# This will use client credentials grant flow to get an access token, and use that token in headers while making requests to AZURE_OPENAI_ENDPOINT. +OAUTH2_ENDPOINT=[] +OAUTH2_CLIENT_ID=[] +OAUTH2_CLIENT_SECRET=[] + # if using AWS Bedrock LLM_PROVIDER=bedrock-anthropic +LLM_TIMEOUT=360000 AWS_ACCESS_KEY_ID= AWS_SECRET_ACCESS_KEY= AWS_REGION= @@ -80,6 +87,7 @@ SELF_HOSTED=azure-devops AZURE_DEVOPS_BOT_TOKEN= AZURE_DEVOPS_BOT_USERNAME= + CODERABBIT_LICENSE_KEY= CODERABBIT_API_KEY= diff --git a/docs/self-hosted/bitbucket.md b/docs/self-hosted/bitbucket.md index d4e12a81..746727a8 100644 --- a/docs/self-hosted/bitbucket.md +++ b/docs/self-hosted/bitbucket.md @@ -61,8 +61,15 @@ AZURE_O1_DEPLOYMENT_NAME= # optionally, you can swap o3-mini with o1-mini AZURE_O1MINI_DEPLOYMENT_NAME=[] +# OAuth2 Configuration (optional) +# This will use client credentials grant flow to get an access token, and use that token in headers while making requests to AZURE_OPENAI_ENDPOINT. +OAUTH2_ENDPOINT=[] +OAUTH2_CLIENT_ID=[] +OAUTH2_CLIENT_SECRET=[] + # if using AWS Bedrock LLM_PROVIDER=bedrock-anthropic +LLM_TIMEOUT=360000 AWS_ACCESS_KEY_ID= AWS_SECRET_ACCESS_KEY= AWS_REGION= @@ -78,13 +85,14 @@ BITBUCKET_SERVER_BOT_TOKEN= BITBUCKET_SERVER_BOT_USERNAME= CODERABBIT_LICENSE_KEY= -CODERABBIT_API_KEY= -# Optional Features +CODERABBIT_API_KEY= ENABLE_LEARNINGS=[true] ENABLE_METRICS=[true] + JIRA_HOST=[] JIRA_PAT=[] + LINEAR_PAT=[] ``` diff --git a/docs/self-hosted/github.md b/docs/self-hosted/github.md index 04696687..821f951f 100644 --- a/docs/self-hosted/github.md +++ b/docs/self-hosted/github.md @@ -72,8 +72,15 @@ AZURE_O1_DEPLOYMENT_NAME= # optionally, you can swap o3-mini with o1-mini AZURE_O1MINI_DEPLOYMENT_NAME=[] +# OAuth2 Configuration (optional) +# This will use client credentials grant flow to get an access token, and use that token in headers while making requests to AZURE_OPENAI_ENDPOINT. +OAUTH2_ENDPOINT=[] +OAUTH2_CLIENT_ID=[] +OAUTH2_CLIENT_SECRET=[] + # if using AWS Bedrock LLM_PROVIDER=bedrock-anthropic +LLM_TIMEOUT=360000 AWS_ACCESS_KEY_ID= AWS_SECRET_ACCESS_KEY= AWS_REGION= @@ -98,7 +105,6 @@ GITHUB_APP_PEM_FILE= CODERABBIT_LICENSE_KEY= CODERABBIT_API_KEY= -# This will use your CodeRabbit API key to store learnings on our servers. ENABLE_LEARNINGS=[true] ENABLE_METRICS=[true] @@ -106,10 +112,6 @@ JIRA_HOST=[] JIRA_PAT=[] LINEAR_PAT=[] - -OAUTH2_ENDPOINT=[] -OAUTH2_CLIENT_ID=[] -OAUTH2_CLIENT_SECRET=[] ``` :::note @@ -119,6 +121,7 @@ OAUTH2_CLIENT_SECRET=[] - For `GITHUB_APP_PEM_FILE`, flatten the PEM file by replacing newlines with `\n`. - For `GITHUB_HOSTNAME`, use GitHub Enterprise server's hostname, for example, “github.acme-inc.com” - You can generate `CODERABBIT_API_KEY` from CodeRabbit UI -> Organizations Settings -> API Keys. +- When `ENABLE_LEARNINGS` is set to `true`, CodeRabbit will use `CODERABBIT_API_KEY` to store learnings on our servers. ::: diff --git a/docs/self-hosted/gitlab.md b/docs/self-hosted/gitlab.md index 5bc87d4a..eabe410e 100644 --- a/docs/self-hosted/gitlab.md +++ b/docs/self-hosted/gitlab.md @@ -67,8 +67,15 @@ AZURE_O1_DEPLOYMENT_NAME= # optionally, you can swap o3-mini with o1-mini AZURE_O1MINI_DEPLOYMENT_NAME=[] +# OAuth2 Configuration (optional) +# This will use client credentials grant flow to get an access token, and use that token in headers while making requests to AZURE_OPENAI_ENDPOINT. +OAUTH2_ENDPOINT=[] +OAUTH2_CLIENT_ID=[] +OAUTH2_CLIENT_SECRET=[] + # if using AWS Bedrock LLM_PROVIDER=bedrock-anthropic +LLM_TIMEOUT=360000 AWS_ACCESS_KEY_ID= AWS_SECRET_ACCESS_KEY= AWS_REGION= @@ -85,6 +92,7 @@ SELF_HOSTED=gitlab GITLAB_BOT_TOKEN= GITLAB_WEBHOOK_SECRET= + CODERABBIT_LICENSE_KEY= CODERABBIT_API_KEY= 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