docs: add "Private Proxy Without Public Inbound Ports" use case#803
docs: add "Private Proxy Without Public Inbound Ports" use case#803SunsetDrifter wants to merge 1 commit into
Conversation
Document running a BYOP proxy in private mode with no public inbound ports by disabling proxy ACME, issuing the wildcard TLS certificate externally over DNS-01, and serving it as a static certificate that the proxy hot-reloads on renewal. Adds the page under reverse-proxy/use-cases with a new Use Cases nav group, plus cross-links from the Bring Your Own Proxy page (port-443 prerequisite + TLS table) and the Reverse Proxy overview (static cert mode).
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (4)
📝 WalkthroughWalkthroughAdds a new MDX documentation page for running a BYOP reverse proxy with no public inbound ports using DNS-01 certificate issuance and static certificate mode. Existing reverse proxy index and BYOP pages gain cross-reference sentences and table rows linking to the new page. The sidebar navigation gains a nested Use Cases group with the new entry. ChangesPrivate No-Inbound Proxy Documentation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
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 docstrings
🧪 Generate unit tests (beta)
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 ESLint
src/components/NavigationDocs.jsxOops! Something went wrong! :( ESLint: 9.39.4 TypeError: Converting circular structure to JSON src/pages/manage/reverse-proxy/bring-your-own-proxy.mdxOops! Something went wrong! :( ESLint: 9.39.4 TypeError: Converting circular structure to JSON src/pages/manage/reverse-proxy/index.mdxOops! Something went wrong! :( ESLint: 9.39.4 TypeError: Converting circular structure to JSON
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 |
Adds a Reverse Proxy use-case page documenting how to run a Bring Your Own Proxy (BYOP) instance in private mode with no public inbound ports.
Why
The proxy's built-in ACME challenges (
tls-alpn-01,http-01) both require a publicly reachable inbound port, which conflicts with a fully private deployment. The supported alternative was not documented as a use case.What
Documents the pattern: disable the proxy's ACME, issue the wildcard certificate externally over the DNS-01 challenge, and serve it as a static certificate that the proxy hot-reloads on renewal. Inbound web ports stay closed; issuance proves domain ownership via a DNS TXT record.
Changes
manage/reverse-proxy/use-cases/private-no-inbound.mdx— "Private Proxy Without Public Inbound Ports"Summary by CodeRabbit