docs: add missing env configuration step to docker quick start#560
docs: add missing env configuration step to docker quick start#560Mohit-001-hash wants to merge 3 commits into
Conversation
|
@Mohit-001-hash is attempting to deploy a commit to the firefistisdead's projects Team on Vercel. A member of the Team first needs to authorize it. |
|
Caution Review failedAn error occurred during the review process. Please try again later. No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughThe Docker "Quick Start" section in ChangesDocker Quick Start Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly related PRs
Suggested labels
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Around line 265-269: The environment setup instructions in the README only
include copying the example env file but do not explicitly tell users to edit
and set the INTERNAL_RAG_TOKEN variable. After the cp .env.example .env command,
add a follow-up instruction that explicitly directs users to open the generated
.env file and set the INTERNAL_RAG_TOKEN to a secure value, either by showing a
brief edit command example or adding a separate step that makes it clear this
token must be configured before running docker-compose up.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
Added instruction to edit the .env file for INTERNAL_RAG_TOKEN.
Summary
Added the missing environment variable configuration step (
cp .env.example .env) to the Docker Compose Quick Start instructions.Previously, the guide instructed users to run
docker-compose up -d --buildimmediately after cloning the repository. Because the backend architecture intentionally fails closed if theINTERNAL_RAG_TOKENis missing, skipping the.envinitialization caused container connection rejections. This update ensures developers properly set up their secrets before booting the multi-container stack, creating a frictionless local setup experience.Related issue
Closes #560
Testing
Checklist:
Screenshots / recordings
Not applicable. This is a documentation-only update to the README.
Notes
This update solely modifies the
README.mdfile. As a reminder for testing, ensure that the root.envfile generated from this new step contains a secureINTERNAL_RAG_TOKENto successfully authenticate the Express gateway with the RAG service.Security
Summary by CodeRabbit
.envand edit it with the required token), improving deployment readiness.