Skip to content

Commit 710cb04

Browse files
authored
Update self-hosted docs (#222)
Add OAuth2 configuration options and specify LLM timeout for self-hosted setups
1 parent 5e0e1b8 commit 710cb04

File tree

4 files changed

+34
-7
lines changed

4 files changed

+34
-7
lines changed

Diff for: docs/self-hosted/azure-devops.md

+8
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,15 @@ AZURE_O1_DEPLOYMENT_NAME=<o1-deployment-name>
6868
# optionally, you can swap o3-mini with o1-mini
6969
AZURE_O1MINI_DEPLOYMENT_NAME=[<o1-mini-deployment-name>]
7070

71+
# OAuth2 Configuration (optional)
72+
# 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.
73+
OAUTH2_ENDPOINT=[<endpoint>]
74+
OAUTH2_CLIENT_ID=[<client-id>]
75+
OAUTH2_CLIENT_SECRET=[<client-secret>]
76+
7177
# if using AWS Bedrock
7278
LLM_PROVIDER=bedrock-anthropic
79+
LLM_TIMEOUT=360000
7380
AWS_ACCESS_KEY_ID=<aws-access-key>
7481
AWS_SECRET_ACCESS_KEY=<aws-secret-access-key>
7582
AWS_REGION=<aws-region>
@@ -80,6 +87,7 @@ SELF_HOSTED=azure-devops
8087

8188
AZURE_DEVOPS_BOT_TOKEN=<personal-access-token>
8289
AZURE_DEVOPS_BOT_USERNAME=<bot-user-username>
90+
8391
CODERABBIT_LICENSE_KEY=<license-key>
8492

8593
CODERABBIT_API_KEY=<coderabbitai-api-key>

Diff for: docs/self-hosted/bitbucket.md

+10-2
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,15 @@ AZURE_O1_DEPLOYMENT_NAME=<o1-deployment-name>
6161
# optionally, you can swap o3-mini with o1-mini
6262
AZURE_O1MINI_DEPLOYMENT_NAME=[<o1-mini-deployment-name>]
6363

64+
# OAuth2 Configuration (optional)
65+
# 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.
66+
OAUTH2_ENDPOINT=[<endpoint>]
67+
OAUTH2_CLIENT_ID=[<client-id>]
68+
OAUTH2_CLIENT_SECRET=[<client-secret>]
69+
6470
# if using AWS Bedrock
6571
LLM_PROVIDER=bedrock-anthropic
72+
LLM_TIMEOUT=360000
6673
AWS_ACCESS_KEY_ID=<aws-access-key>
6774
AWS_SECRET_ACCESS_KEY=<aws-secret-access-key>
6875
AWS_REGION=<aws-region>
@@ -78,13 +85,14 @@ BITBUCKET_SERVER_BOT_TOKEN=<personal-access-token>
7885
BITBUCKET_SERVER_BOT_USERNAME=<bot-user-username>
7986

8087
CODERABBIT_LICENSE_KEY=<license-key>
81-
CODERABBIT_API_KEY=<coderabbitai-api-key>
8288

83-
# Optional Features
89+
CODERABBIT_API_KEY=<coderabbitai-api-key>
8490
ENABLE_LEARNINGS=[true]
8591
ENABLE_METRICS=[true]
92+
8693
JIRA_HOST=[<jira-host-url>]
8794
JIRA_PAT=[<jira-personal-access-token>]
95+
8896
LINEAR_PAT=[<linear-personal-access-token>]
8997
```
9098

Diff for: docs/self-hosted/github.md

+8-5
Original file line numberDiff line numberDiff line change
@@ -72,8 +72,15 @@ AZURE_O1_DEPLOYMENT_NAME=<o1-deployment-name>
7272
# optionally, you can swap o3-mini with o1-mini
7373
AZURE_O1MINI_DEPLOYMENT_NAME=[<o1-mini-deployment-name>]
7474

75+
# OAuth2 Configuration (optional)
76+
# 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.
77+
OAUTH2_ENDPOINT=[<endpoint>]
78+
OAUTH2_CLIENT_ID=[<client-id>]
79+
OAUTH2_CLIENT_SECRET=[<client-secret>]
80+
7581
# if using AWS Bedrock
7682
LLM_PROVIDER=bedrock-anthropic
83+
LLM_TIMEOUT=360000
7784
AWS_ACCESS_KEY_ID=<aws-access-key>
7885
AWS_SECRET_ACCESS_KEY=<aws-secret-access-key>
7986
AWS_REGION=<aws-region>
@@ -98,18 +105,13 @@ GITHUB_APP_PEM_FILE=<flattened-pem-file>
98105
CODERABBIT_LICENSE_KEY=<license-key>
99106

100107
CODERABBIT_API_KEY=<coderabbitai-api-key>
101-
# This will use your CodeRabbit API key to store learnings on our servers.
102108
ENABLE_LEARNINGS=[true]
103109
ENABLE_METRICS=[true]
104110

105111
JIRA_HOST=[<jira-host-url>]
106112
JIRA_PAT=[<jira-personal-access-token>]
107113

108114
LINEAR_PAT=[<linear-personal-access-token>]
109-
110-
OAUTH2_ENDPOINT=[<endpoint>]
111-
OAUTH2_CLIENT_ID=[<client-id>]
112-
OAUTH2_CLIENT_SECRET=[<client-secret>]
113115
```
114116

115117
:::note
@@ -119,6 +121,7 @@ OAUTH2_CLIENT_SECRET=[<client-secret>]
119121
- For `GITHUB_APP_PEM_FILE`, flatten the PEM file by replacing newlines with `\n`.
120122
- For `GITHUB_HOSTNAME`, use GitHub Enterprise server's hostname, for example, “github.acme-inc.com”
121123
- You can generate `CODERABBIT_API_KEY` from CodeRabbit UI -> Organizations Settings -> API Keys.
124+
- When `ENABLE_LEARNINGS` is set to `true`, CodeRabbit will use `CODERABBIT_API_KEY` to store learnings on our servers.
122125

123126
:::
124127

Diff for: docs/self-hosted/gitlab.md

+8
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,15 @@ AZURE_O1_DEPLOYMENT_NAME=<o1-deployment-name>
6767
# optionally, you can swap o3-mini with o1-mini
6868
AZURE_O1MINI_DEPLOYMENT_NAME=[<o1-mini-deployment-name>]
6969

70+
# OAuth2 Configuration (optional)
71+
# 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.
72+
OAUTH2_ENDPOINT=[<endpoint>]
73+
OAUTH2_CLIENT_ID=[<client-id>]
74+
OAUTH2_CLIENT_SECRET=[<client-secret>]
75+
7076
# if using AWS Bedrock
7177
LLM_PROVIDER=bedrock-anthropic
78+
LLM_TIMEOUT=360000
7279
AWS_ACCESS_KEY_ID=<aws-access-key>
7380
AWS_SECRET_ACCESS_KEY=<aws-secret-access-key>
7481
AWS_REGION=<aws-region>
@@ -85,6 +92,7 @@ SELF_HOSTED=gitlab
8592

8693
GITLAB_BOT_TOKEN=<personal-access-token>
8794
GITLAB_WEBHOOK_SECRET=<webhook-secret-key>
95+
8896
CODERABBIT_LICENSE_KEY=<license-key>
8997

9098
CODERABBIT_API_KEY=<coderabbitai-api-key>

0 commit comments

Comments
 (0)