Skip to content

Update BYOP documentation to reflect "Clusters" terminology#762

Merged
mlsmaycon merged 2 commits into
mainfrom
update-bring-your-own-proxy
May 20, 2026
Merged

Update BYOP documentation to reflect "Clusters" terminology#762
mlsmaycon merged 2 commits into
mainfrom
update-bring-your-own-proxy

Conversation

@mlsmaycon
Copy link
Copy Markdown
Contributor

@mlsmaycon mlsmaycon commented May 20, 2026

Update BYOP documentation to reflect "Clusters" terminology and add shared vs account cluster details.

docs netbird io_manage_reverse-proxy_bring-your-own-proxy

Summary by CodeRabbit

  • Documentation
    • Updated BYOP reverse-proxy documentation to reflect the current dashboard flow, terminology, and interface structure
    • Added section clarifying the distinction between shared and account clusters
    • Updated setup wizard step names and revised API verification approach for identifying account clusters
    • Refreshed troubleshooting section to match current UI control names and required permissions

Review Change Stack

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 20, 2026

Warning

Rate limit exceeded

@mlsmaycon has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 39 minutes and 34 seconds before requesting another review.

You’ve run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 077325c3-20f2-4752-9583-feef3dacb2b4

📥 Commits

Reviewing files that changed from the base of the PR and between c5c6061 and 8d3093e.

⛔ Files ignored due to path filters (3)
  • public/docs-static/img/manage/reverse-proxy/byop/byop-setup-modal-dns.png is excluded by !**/*.png
  • public/docs-static/img/manage/reverse-proxy/byop/byop-setup-modal-domain.png is excluded by !**/*.png
  • public/docs-static/img/manage/reverse-proxy/byop/byop-setup-modal-install.png is excluded by !**/*.png
📒 Files selected for processing (1)
  • src/pages/manage/reverse-proxy/bring-your-own-proxy.mdx
📝 Walkthrough

Walkthrough

This PR updates the BYOP reverse-proxy documentation to align with current dashboard UI and API terminology. BYOP proxies are now documented as appearing under Reverse Proxy > Clusters as account clusters, with a new section distinguishing shared and account cluster behaviors. Setup instructions, prerequisites, wizard navigation, screenshot alt texts, and API verification steps are all updated accordingly.

Changes

BYOP Proxy Documentation Terminology and Navigation

Layer / File(s) Summary
Terminology and cluster types introduction
src/pages/manage/reverse-proxy/bring-your-own-proxy.mdx
Introduction now states BYOP proxies appear under Reverse Proxy > Clusters as account clusters. New "Shared and account clusters" section defines behavior differences including who runs/uses clusters, apex domain handling, TLS ownership, token types, geographic placement, and delete behavior.
Setup walkthrough and prerequisites
src/pages/manage/reverse-proxy/bring-your-own-proxy.mdx
Prerequisites updated to reference Services permission for managing account clusters. Setup wizard steps rewritten for Clusters page with Setup Self-Hosted Cluster button terminology. Screenshot alt texts updated to reference Clusters page tabs, DNS Records tab, Run the Proxy tab, and Online badge for connected account clusters.
API verification and cluster management
src/pages/manage/reverse-proxy/bring-your-own-proxy.mdx
API verification now instructs checking GET /api/reverse-proxies/clusters for "type": "account" vs "type": "shared". New Manage clusters subsection documents Clusters page behavior, Delete button presence for account clusters, deletion endpoint, and consequences. Troubleshooting table updated from Setup Proxy to Setup Self-Hosted Cluster terminology.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 A proxy by any other name would run as true,
From self-hosted to clusters, the docs are renewed,
Shared and account now shine, each with their role,
The dashboard dances with clarity—now review is whole! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title directly reflects the main change in the PR: updating documentation to use 'Clusters' terminology instead of previous terms.
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.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch update-bring-your-own-proxy

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 and usage tips.

@mlsmaycon mlsmaycon changed the title Update BYOP documentation to reflect "Clusters" terminology and add s… Update BYOP documentation to reflect "Clusters" terminology May 20, 2026
@mlsmaycon mlsmaycon merged commit 30cb1bf into main May 20, 2026
3 checks passed
@mlsmaycon mlsmaycon deleted the update-bring-your-own-proxy branch May 20, 2026 10:07
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.

2 participants