Skip to content

Dev Docker setup documents for contributors fix#1595

Open
Benebo7 wants to merge 2 commits into
MODSetter:devfrom
Benebo7:docs/dev-docker-setup-guide
Open

Dev Docker setup documents for contributors fix#1595
Benebo7 wants to merge 2 commits into
MODSetter:devfrom
Benebo7:docs/dev-docker-setup-guide

Conversation

@Benebo7

@Benebo7 Benebo7 commented Jul 11, 2026

Copy link
Copy Markdown

Summary

  • Fix invalid placeholder values in surfsense_backend/.env.example (AUTH_TYPE, REGISTRATION_ENABLED) that silently broke some authentication routes
  • Expand the "Building from Source (Contributors)" section in the Docker Installation docs with the missing .env files, full service list, and buildx requirement
  • Fix the broken DOCKER_SETUP.md link in CONTRIBUTING.md

Closes #1594

Testing

  • Ran through the documented flow from docker compose -f docker-compose.dev.yml up --build, and confirmed POST /auth/register returns 201 after the .env.example fix (previously 403 with 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_TYPE and REGISTRATION_ENABLED values in surfsense_backend/.env.example that were previously breaking authentication routes, significantly expanding the "Building from Source (Contributors)" documentation section with detailed setup instructions including all three required .env files, service port mappings, and buildx requirements, and updating the broken Docker setup link in CONTRIBUTING.md to point to the correct documentation section.

⏱️ Estimated Review Time: 5-15 minutes

💡 Review Order Suggestion
Order File Path
1 surfsense_backend/.env.example
2 surfsense_web/content/docs/docker-installation/index.mdx
3 CONTRIBUTING.md

Need help? Join our Discord

@vercel

vercel Bot commented Jul 11, 2026

Copy link
Copy Markdown

@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.

@coderabbitai

coderabbitai Bot commented Jul 11, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 44ac1c96-aadd-4d52-a7f5-0ef39de0cc75

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant