Add YAML_CONFIG option to self-hosted documentation (#445)

hasit · web-flow · commit 5aa268e0990e · 2025-07-14T08:55:49.000-07:00
* Add YAML_CONFIG option to self-hosted documentation for Azure DevOps, Bitbucket, GitHub, and GitLab

* Update YAML_CONFIG placeholder to escaped format in self-hosted documentation for Azure DevOps, Bitbucket, GitHub, and GitLab
diff --git a/docs/self-hosted/azure-devops.md b/docs/self-hosted/azure-devops.md
@@ -127,13 +127,16 @@ LINEAR_PAT=[<linear-personal-access-token>]
 
 ENABLE_WEB_SEARCH=[true]
 PERPLEXITY_API_KEY=[<perplexity-api-key>]
+
+YAML_CONFIG=[<escaped-yaml-config>]
 ```
 
 :::note
 
 - If you are using Azure OpenAI, verify that the model deployment names are in the .env file.
 - Values marked with [] are not optional to provide.
 - You can generate `CODERABBIT_API_KEY` from CodeRabbit UI -> Organizations Settings -> API Keys.
+- `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.
 
 :::
 
diff --git a/docs/self-hosted/bitbucket.md b/docs/self-hosted/bitbucket.md
@@ -122,13 +122,16 @@ LINEAR_PAT=[<linear-personal-access-token>]
 
 ENABLE_WEB_SEARCH=[true]
 PERPLEXITY_API_KEY=[<perplexity-api-key>]
+
+YAML_CONFIG=[<escaped-yaml-config>]
 ```
 
 :::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.
+- `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.
 
 :::
 
diff --git a/docs/self-hosted/github.md b/docs/self-hosted/github.md
@@ -140,6 +140,8 @@ LINEAR_PAT=[<linear-personal-access-token>]
 
 ENABLE_WEB_SEARCH=[true]
 PERPLEXITY_API_KEY=[<perplexity-api-key>]
+
+YAML_CONFIG=[<escaped-yaml-config>]
 ```
 
 :::note
@@ -150,6 +152,7 @@ PERPLEXITY_API_KEY=[<perplexity-api-key>]
 - 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.
+- `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.
 
 :::
 
diff --git a/docs/self-hosted/gitlab.md b/docs/self-hosted/gitlab.md
@@ -134,13 +134,16 @@ LINEAR_PAT=[<linear-personal-access-token>]
 
 ENABLE_WEB_SEARCH=[true]
 PERPLEXITY_API_KEY=[<perplexity-api-key>]
+
+YAML_CONFIG=[<escaped-yaml-config>]
 ```
 
 :::note
 
 - If you are using Azure OpenAI, verify that the model deployment names are in the .env file.
 - Values marked with [] are not optional to provide.
 - You can generate `CODERABBIT_API_KEY` from CodeRabbit UI -> Organizations Settings -> API Keys.
+- `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.
 
 :::
 
