Skip to content

Add knowledge base feature flag defns in self hosted docs #469

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 24, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 13 additions & 4 deletions docs/self-hosted/azure-devops.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,10 +118,19 @@ CODERABBIT_LICENSE_KEY=<license-key>

CODERABBIT_API_KEY=<coderabbitai-api-key>
ENABLE_METRICS=[true]
ENABLE_LEARNINGS=[true]
# if using CodeRabbit's learnings, also provide the following
# for example, s3://bucket/path/to/database, gs://bucket/path/to/database, etc.
OBJECT_STORE_URI=[<object-store-uri>]

# CodeRabbit - KNOWLEDGE BASE
#
# Requisite: To enable CodeRabbit's knowledge base, you need to provide an object store URI.
OBJECT_STORE_URI=[<object-store-uri>] # All major object stores are supported e.g., s3://bucket/path/to/database, gs://bucket/path/to/database, etc.

ENABLE_KNOWLEDGE_BASE=[true] # Global feature flag to enable/disable all knowledge base features.

ENABLE_PRS_INDEX=[true] # Feature flag to enable/disable PRs indexing.
ENABLE_ISSUES_INDEX=[true] # Feature flag to enable/disable Issues indexing.
ENABLE_LEARNING_INDEX=[true] # Feature flag to enable/disable Learning indexing.
ENABLE_CODE_GUIDELINES_INDEX=[true] # Feature flag to enable/disable Code Guidelines indexing.
ENABLE_CODE_INDEX=[true] # Feature flag to enable/disable Code indexing.

JIRA_HOST=[<jira-host-url>]
JIRA_PAT=[<jira-personal-access-token>]
Expand Down
18 changes: 14 additions & 4 deletions docs/self-hosted/bitbucket.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,10 +113,20 @@ CODERABBIT_LICENSE_KEY=<license-key>

CODERABBIT_API_KEY=<coderabbitai-api-key>
ENABLE_METRICS=[true]
ENABLE_LEARNINGS=[true]
# if using CodeRabbit's learnings, also provide the following
# for example, s3://bucket/path/to/database, gs://bucket/path/to/database, etc.
OBJECT_STORE_URI=[<object-store-uri>]


# CodeRabbit - KNOWLEDGE BASE
#
# Requisite: To enable CodeRabbit's knowledge base, you need to provide an object store URI.
OBJECT_STORE_URI=[<object-store-uri>] # All major object stores are supported e.g., s3://bucket/path/to/database, gs://bucket/path/to/database, etc.

ENABLE_KNOWLEDGE_BASE=[true] # Global feature flag to enable/disable all knowledge base features.

ENABLE_PRS_INDEX=[true] # Feature flag to enable/disable PRs indexing.
ENABLE_ISSUES_INDEX=[true] # Feature flag to enable/disable Issues indexing.
ENABLE_LEARNING_INDEX=[true] # Feature flag to enable/disable Learning indexing.
ENABLE_CODE_GUIDELINES_INDEX=[true] # Feature flag to enable/disable Code Guidelines indexing.
ENABLE_CODE_INDEX=[true] # Feature flag to enable/disable Code indexing.

JIRA_HOST=[<jira-host-url>]
JIRA_PAT=[<jira-personal-access-token>]
Expand Down
18 changes: 14 additions & 4 deletions docs/self-hosted/github.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,10 +131,20 @@ CODERABBIT_LICENSE_KEY=<license-key>

CODERABBIT_API_KEY=<coderabbitai-api-key>
ENABLE_METRICS=[true]
ENABLE_LEARNINGS=[true]
# if using CodeRabbit's learnings, also provide the following
# for example, s3://bucket/path/to/database, gs://bucket/path/to/database, etc.
OBJECT_STORE_URI=[<object-store-uri>]


# CodeRabbit - KNOWLEDGE BASE
#
# Requisite: To enable CodeRabbit's knowledge base, you need to provide an object store URI.
OBJECT_STORE_URI=[<object-store-uri>] # All major object stores are supported e.g., s3://bucket/path/to/database, gs://bucket/path/to/database, etc.

ENABLE_KNOWLEDGE_BASE=[true] # Global feature flag to enable/disable all knowledge base features.

ENABLE_PRS_INDEX=[true] # Feature flag to enable/disable PRs indexing.
ENABLE_ISSUES_INDEX=[true] # Feature flag to enable/disable Issues indexing.
ENABLE_LEARNING_INDEX=[true] # Feature flag to enable/disable Learning indexing.
ENABLE_CODE_GUIDELINES_INDEX=[true] # Feature flag to enable/disable Code Guidelines indexing.
ENABLE_CODE_INDEX=[true] # Feature flag to enable/disable Code indexing.

JIRA_HOST=[<jira-host-url>]
JIRA_PAT=[<jira-personal-access-token>]
Expand Down
19 changes: 15 additions & 4 deletions docs/self-hosted/gitlab.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,10 +158,21 @@ CODERABBIT_LICENSE_KEY=<license-key>

CODERABBIT_API_KEY=<coderabbitai-api-key>
ENABLE_METRICS=[true]
ENABLE_LEARNINGS=[true]
# if using CodeRabbit's learnings, also provide the following
# for example, s3://bucket/path/to/database, gs://bucket/path/to/database, etc.
OBJECT_STORE_URI=[<object-store-uri>]


# CodeRabbit - KNOWLEDGE BASE
#
# Requisite: To enable CodeRabbit's knowledge base, you need to provide an object store URI.
OBJECT_STORE_URI=[<object-store-uri>] # All major object stores are supported e.g., s3://bucket/path/to/database, gs://bucket/path/to/database, etc.

ENABLE_KNOWLEDGE_BASE=[true] # Global feature flag to enable/disable all knowledge base features.

ENABLE_PRS_INDEX=[true] # Feature flag to enable/disable PRs indexing.
ENABLE_ISSUES_INDEX=[true] # Feature flag to enable/disable Issues indexing.
ENABLE_LEARNING_INDEX=[true] # Feature flag to enable/disable Learning indexing.
ENABLE_CODE_GUIDELINES_INDEX=[true] # Feature flag to enable/disable Code Guidelines indexing.
ENABLE_CODE_INDEX=[true] # Feature flag to enable/disable Code indexing.


JIRA_HOST=[<jira-host-url>]
JIRA_PAT=[<jira-personal-access-token>]
Expand Down