Dev Docker setup documents for contributors fix#1595
Conversation
|
@Benebo7 is attempting to deploy a commit to the Rohan Verma's projects Team on Vercel. A member of the Team first needs to authorize it. |
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ 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 |
Summary
surfsense_backend/.env.example(AUTH_TYPE,REGISTRATION_ENABLED) that silently broke some authentication routes.envfiles, full service list, andbuildxrequirementDOCKER_SETUP.mdlink inCONTRIBUTING.mdCloses #1594
Testing
docker compose -f docker-compose.dev.yml up --build, and confirmedPOST /auth/registerreturns201after the.env.examplefix (previously403with ambiguous placeholder).High-level PR Summary
This PR fixes the contributor Docker setup documentation and addresses authentication issues caused by invalid placeholder values. The main changes include correcting the
AUTH_TYPEandREGISTRATION_ENABLEDvalues insurfsense_backend/.env.examplethat were previously breaking authentication routes, significantly expanding the "Building from Source (Contributors)" documentation section with detailed setup instructions including all three required.envfiles, service port mappings, andbuildxrequirements, and updating the broken Docker setup link inCONTRIBUTING.mdto point to the correct documentation section.⏱️ Estimated Review Time: 5-15 minutes
💡 Review Order Suggestion
surfsense_backend/.env.examplesurfsense_web/content/docs/docker-installation/index.mdxCONTRIBUTING.md