Add more details on how to use on-prem knowledge base #154
Conversation
WalkthroughThe pull request includes updates to two documentation files: Changes
Possibly related PRs
Suggested reviewers
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
[dependabot skip]
Deploying coderabbit-docs with
|
| Latest commit: |
bf47d6e
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://d857e7e9.coderabbit-docs.pages.dev |
| Branch Preview URL: | https://nick-kb-walkthrough.coderabbit-docs.pages.dev |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (3)
docs/integrations/knowledge-base.md (3)
50-57: Enhance environment variables documentation and security guidance.Consider the following improvements for clarity and security:
- Format environment variables consistently using code blocks
- Add version compatibility information
- Include security best practices for authentication
Apply these changes:
-For self-hosted / on-premises deployments, you can enable the knowledge base features by setting `ON_PREM_KNOWLEDGE_BASE=true` in the environment variables for your self-hosted docker image. +For self-hosted / on-premises deployments, you can enable the knowledge base features by configuring the following environment variables in your self-hosted docker image: + +```env +# Required: Enable on-premises knowledge base +ON_PREM_KNOWLEDGE_BASE=true + +# Required: ChromaDB connection URL +CHROMADB_URL=http://your-chromadb-host:8000 + +# Optional: Override default branch for storing learnings +ON_PREM_KNOWLEDGE_BASE_BRANCH=your-branch-name + +# Optional: ChromaDB authentication credentials +CHROMA_CLIENT_AUTH_CREDENTIALS=your-credentials +``` + +> **Security Note**: When deploying to production, always enable authentication for ChromaDB and use secure credentials.
66-69: Add language specification to code block.The code block should specify the language for better syntax highlighting and to comply with markdown best practices.
-``` +```bash @coderabbitai always make sure to enforce camelCase<details> <summary>🧰 Tools</summary> <details> <summary>🪛 Markdownlint (0.35.0)</summary> 66-66: null Fenced code blocks should have a language specified (MD040, fenced-code-language) </details> </details> --- `70-72`: **Enhance the verification steps with more details.** Consider adding: 1. Expected bot response examples 2. Common troubleshooting steps 3. Verification timeframes Add the following content: ```diff -CodeRabbit should respone that it has added a learning. +CodeRabbit should respond with a confirmation message like: +> "I've recorded this learning and will apply it in future reviews." + +If you don't receive a response within a few minutes: +- Verify that CodeRabbit has the necessary repository permissions +- Check the CodeRabbit logs for any connection errors to ChromaDB +- Ensure the knowledge base branch exists and is writable
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (2)
docs/integrations/knowledge-base.md(1 hunks)docs/self-hosted/github.md(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- docs/self-hosted/github.md
🧰 Additional context used
🪛 Markdownlint (0.35.0)
docs/integrations/knowledge-base.md
66-66: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (4)
docs/integrations/knowledge-base.md (4)
50-57: Fix missing comma in line 56.The section provides clear instructions, but there's a minor grammatical issue.
-By default, CodeRabbit will store its data in the `coderabbitai/data` branch unless you set `ON_PREM_KNOWLEDGE_BASE_BRANCH=<branch_name>` with a value. +By default, CodeRabbit will store its data in the `coderabbitai/data` branch, unless you set `ON_PREM_KNOWLEDGE_BASE_BRANCH=<branch_name>` with a value.🧰 Tools
🪛 LanguageTool
[uncategorized] ~56-~56: Possible missing comma found.
Context: ...ore its data in thecoderabbitai/databranch unless you set `ON_PREM_KNOWLEDGE_BASE_...(AI_HYDRA_LEO_MISSING_COMMA)
54-54: Consider adding an environment variables code block.To improve clarity, consider adding a code block showing all the required environment variables together.
You must also be running ChromaDB. Use image `chromadb/chroma:0.5.20`. In your CodeRabbit docker image environment variables, set `CHROMADB_URL` to point to the hostname where ChromaDB can be reached. For persistance of your ChromaDB data, mount `/chroma/chroma` in the container to a volume mount. For more information on ChromaDB docker deployment, including how to set up authentication, refer to the [official documentation](https://docs.trychroma.com/deployment/docker). CodeRabbit will use `CHROMA_CLIENT_AUTH_CREDENTIALS` if it is set. + +Example environment variables: +```env +ON_PREM_KNOWLEDGE_BASE=true +CHROMADB_URL=http://chromadb:8000 +CHROMA_CLIENT_AUTH_CREDENTIALS=your_auth_token # Optional +ON_PREM_KNOWLEDGE_BASE_BRANCH=custom_branch # Optional +```
66-69: Fix code block and grammar issues.The walkthrough is clear, but there are a few minor improvements needed:
-``` +```markdown @coderabbitai always make sure to enforce camelCase-Check out the branch called
coderabbit/datain the repository (or whatever branch name you have set forON_PREM_KNOWLEDGE_BASE_BRANCH). It should contain a file called learnings.json with an entry containing what you told it to remember.
+Check out the branch calledcoderabbit/datain the repository (or whatever branch name you have set forON_PREM_KNOWLEDGE_BASE_BRANCH). It should contain a file called learnings.json, with an entry containing what you told it to remember.Also applies to: 71-72 <details> <summary>🧰 Tools</summary> <details> <summary>🪛 Markdownlint (0.35.0)</summary> 66-66: null Fenced code blocks should have a language specified (MD040, fenced-code-language) </details> </details> --- `60-72`: **Consider adding verification steps.** The walkthrough would benefit from steps to verify the ChromaDB connection before proceeding with the PR creation. Add these steps after the ChromaDB setup: ```diff - Configure your environment variables for your CodeRabbit self-hosted deploy to be able to access Chroma. - Restart your CodeRabbit service so it has access to the new environment variable settings. +- Verify the ChromaDB connection by checking the CodeRabbit logs for successful connection messages. +- Ensure the `coderabbit/data` branch (or your custom branch) exists and is accessible. - Create a new PR in your SCM platform.🧰 Tools
🪛 LanguageTool
[uncategorized] ~71-~71: Possible missing comma found.
Context: ... should contain a file called learnings.json with an entry containing what you told ...(AI_HYDRA_LEO_MISSING_COMMA)
🪛 Markdownlint (0.35.0)
66-66: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
docs/integrations/knowledge-base.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/integrations/knowledge-base.md
[uncategorized] ~56-~56: Possible missing comma found.
Context: ...ore its data in the coderabbitai/data branch unless you set `ON_PREM_KNOWLEDGE_BASE_...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~71-~71: Possible missing comma found.
Context: ... should contain a file called learnings.json with an entry containing what you told ...
(AI_HYDRA_LEO_MISSING_COMMA)
🪛 Markdownlint (0.35.0)
docs/integrations/knowledge-base.md
66-66: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
No description provided.