Skip to content

Commit df22dc6

Browse files
committed
Add YAML_CONFIG option to self-hosted documentation for Azure DevOps, Bitbucket, GitHub, and GitLab
1 parent 2395b7d commit df22dc6

File tree

4 files changed

+12
-0
lines changed

4 files changed

+12
-0
lines changed

docs/self-hosted/azure-devops.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,13 +127,16 @@ LINEAR_PAT=[<linear-personal-access-token>]
127127

128128
ENABLE_WEB_SEARCH=[true]
129129
PERPLEXITY_API_KEY=[<perplexity-api-key>]
130+
131+
YAML_CONFIG=[<yaml-config>]
130132
```
131133

132134
:::note
133135

134136
- If you are using Azure OpenAI, verify that the model deployment names are in the .env file.
135137
- Values marked with [] are not optional to provide.
136138
- You can generate `CODERABBIT_API_KEY` from CodeRabbit UI -> Organizations Settings -> API Keys.
139+
- `YAML_CONFIG` is an optional configuration file that can be used to customize CodeRabbit's behavior at the deployment level. It takes the same format as the [CodeRabbit YAML configuration](/docs/getting-started/configure-coderabbit.md) file. It requires the entire YAML file to be in an escaped string format, for example, `YAML_CONFIG="key1: value1\nkey2: value2"`. You can use [Escape YAML](https://escapeyaml.dev/) to generate the escaped string.
137140

138141
:::
139142

docs/self-hosted/bitbucket.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,13 +122,16 @@ LINEAR_PAT=[<linear-personal-access-token>]
122122

123123
ENABLE_WEB_SEARCH=[true]
124124
PERPLEXITY_API_KEY=[<perplexity-api-key>]
125+
126+
YAML_CONFIG=[<yaml-config>]
125127
```
126128

127129
:::note
128130

129131
- If you are using Azure OpenAI, verify that the model deployment names are in the .env file.
130132
Values marked with [] are optional and can be omitted if the feature is not needed.
131133
- You can generate `CODERABBIT_API_KEY` from CodeRabbit UI -> Organizations Settings -> API Keys.
134+
- `YAML_CONFIG` is an optional configuration file that can be used to customize CodeRabbit's behavior at the deployment level. It takes the same format as the [CodeRabbit YAML configuration](/docs/getting-started/configure-coderabbit.md) file. It requires the entire YAML file to be in an escaped string format, for example, `YAML_CONFIG="key1: value1\nkey2: value2"`. You can use [Escape YAML](https://escapeyaml.dev/) to generate the escaped string.
132135

133136
:::
134137

docs/self-hosted/github.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,8 @@ LINEAR_PAT=[<linear-personal-access-token>]
140140

141141
ENABLE_WEB_SEARCH=[true]
142142
PERPLEXITY_API_KEY=[<perplexity-api-key>]
143+
144+
YAML_CONFIG=[<yaml-config>]
143145
```
144146

145147
:::note
@@ -150,6 +152,7 @@ PERPLEXITY_API_KEY=[<perplexity-api-key>]
150152
- For `GITHUB_HOSTNAME`, use GitHub Enterprise server's hostname, for example, “github.acme-inc.com”
151153
- You can generate `CODERABBIT_API_KEY` from CodeRabbit UI -> Organizations Settings -> API Keys.
152154
- When `ENABLE_LEARNINGS` is set to `true`, CodeRabbit will use `CODERABBIT_API_KEY` to store learnings on our servers.
155+
- `YAML_CONFIG` is an optional configuration file that can be used to customize CodeRabbit's behavior at the deployment level. It takes the same format as the [CodeRabbit YAML configuration](/docs/getting-started/configure-coderabbit.md) file. It requires the entire YAML file to be in an escaped string format, for example, `YAML_CONFIG="key1: value1\nkey2: value2"`. You can use [Escape YAML](https://escapeyaml.dev/) to generate the escaped string.
153156

154157
:::
155158

docs/self-hosted/gitlab.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,13 +134,16 @@ LINEAR_PAT=[<linear-personal-access-token>]
134134

135135
ENABLE_WEB_SEARCH=[true]
136136
PERPLEXITY_API_KEY=[<perplexity-api-key>]
137+
138+
YAML_CONFIG=[<yaml-config>]
137139
```
138140

139141
:::note
140142

141143
- If you are using Azure OpenAI, verify that the model deployment names are in the .env file.
142144
- Values marked with [] are not optional to provide.
143145
- You can generate `CODERABBIT_API_KEY` from CodeRabbit UI -> Organizations Settings -> API Keys.
146+
- `YAML_CONFIG` is an optional configuration file that can be used to customize CodeRabbit's behavior at the deployment level. It takes the same format as the [CodeRabbit YAML configuration](/docs/getting-started/configure-coderabbit.md) file. It requires the entire YAML file to be in an escaped string format, for example, `YAML_CONFIG="key1: value1\nkey2: value2"`. You can use [Escape YAML](https://escapeyaml.dev/) to generate the escaped string.
144147

145148
:::
146149

0 commit comments

Comments
 (0)