Skip to content

docs: add custom reverse proxy setup guide for Community Edition - #305

Open
boul2gom wants to merge 2 commits into
makeplane:masterfrom
boul2gom:external-proxy
Open

docs: add custom reverse proxy setup guide for Community Edition#305
boul2gom wants to merge 2 commits into
makeplane:masterfrom
boul2gom:external-proxy

Conversation

@boul2gom

@boul2gom boul2gom commented Jul 29, 2026

Copy link
Copy Markdown

Description

📚 Document exact internal route mappings (spaces, god-mode, live, etc.) and provide ready-to-use config templates for Nginx, Caddy, and Traefik

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • Feature (non-breaking change which adds functionality)
  • Improvement (change that would cause existing functionality to not work as expected)
  • Code refactoring
  • Performance improvements
  • Documentation update

Summary by CodeRabbit

  • Documentation
    • Added Community Edition reverse proxy setup guidance.
    • Documented required path-based routing and container/port mappings.
    • Added example configurations for NGINX, Caddy, and Traefik, including WebSocket and upload routing.

@vercel

vercel Bot commented Jul 29, 2026

Copy link
Copy Markdown

@boul2gom is attempting to deploy a commit to the Marketing at Plane Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai

coderabbitai Bot commented Jul 29, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@boul2gom, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 33 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 19fbe69b-96d0-47bb-b6b6-7e7c90f99674

📥 Commits

Reviewing files that changed from the base of the PR and between e0652bb and d40f4fa.

📒 Files selected for processing (1)
  • docs/self-hosting/govern/reverse-proxy.md
📝 Walkthrough

Walkthrough

Adds Community Edition reverse proxy documentation covering proxy prerequisites, path-to-container mappings, and NGINX, Caddy, and Traefik configuration templates.

Changes

Community Edition reverse proxy

Layer / File(s) Summary
Routing prerequisites and mappings
docs/self-hosting/govern/reverse-proxy.md
Documents disabling Plane’s bundled proxy, Docker network connectivity, and path-based routing to Plane and MinIO containers.
Proxy configuration templates
docs/self-hosting/govern/reverse-proxy.md
Adds NGINX, Caddy, and Traefik examples for web, API, admin, spaces, live WebSocket, and upload routes.

Estimated code review effort: 2 (Simple) | ~10 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly describes the main documentation change: a Community Edition guide for custom reverse proxy setup.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Fix failing CI checks
🧪 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.

@boul2gom

Copy link
Copy Markdown
Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Jul 29, 2026

Copy link
Copy Markdown
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

🤖 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 `@docs/self-hosting/govern/reverse-proxy.md`:
- Line 228: Update the reverse-proxy route table entry to match the examples’
default public upload path, documenting `/uploads` as the route to plane-minio
on port 9000; if retaining the configurable bucket-name route, add the required
rewrite behavior consistently across the documented proxy configurations.
- Around line 260-268: Add proxy_http_version 1.1; to the /live/ WebSocket
location block alongside the existing proxy_pass and upgrade headers, preserving
the rest of the reverse-proxy configuration.
- Line 346: Update the Traefik router rules in the documented reverse-proxy
configuration to use exact root matches plus trailing-slash prefixes instead of
broad PathPrefix matchers. Apply this boundary-safe pattern consistently to api,
auth, static, god-mode, spaces, live, and uploads across the affected rules,
preserving the existing Host condition.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 436966b9-2bbf-462a-835d-0079c1bef760

📥 Commits

Reviewing files that changed from the base of the PR and between e5dc631 and e0652bb.

📒 Files selected for processing (1)
  • docs/self-hosting/govern/reverse-proxy.md

Comment thread docs/self-hosting/govern/reverse-proxy.md Outdated
Comment thread docs/self-hosting/govern/reverse-proxy.md
Comment thread docs/self-hosting/govern/reverse-proxy.md Outdated
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