Skip to content

docs: surface exit nodes under Routes and document broad-access mitigations - #941

Open
SunsetDrifter wants to merge 1 commit into
mainfrom
docs/exit-nodes-routes-nav
Open

docs: surface exit nodes under Routes and document broad-access mitigations#941
SunsetDrifter wants to merge 1 commit into
mainfrom
docs/exit-nodes-routes-nav

Conversation

@SunsetDrifter

@SunsetDrifter SunsetDrifter commented Aug 20, 2026

Copy link
Copy Markdown
Contributor

Summary

Exit nodes previously lived only under Use Cases → Remote Access, even though they are the one remaining use case for (legacy) Routes. This PR surfaces them from the Routes section and documents the broad-access risk of a default route.

  • Sidebar: add an Exit Nodes entry to the Routes group (page stays at /use-cases/remote-access/exit-nodes; the nav already has precedent for the same href in two groups).
  • Routes overview (/manage/network-routes): mention in the intro that Routes power exit nodes, that a default route grants access to any network the routing peer can reach, and link to the mitigation guidance.
  • Exit nodes guide: new warning under the Routing Peer concept — a 0.0.0.0/0 route matches all traffic, so peers can reach anything the routing peer can reach, including its local LAN — plus two mitigations (Block LAN access on the routing peer, or placing the exit node on an isolated internet-only segment) and the best practice of keeping the exit node dedicated, serving LAN resources through a separate routing peer with a Network and scoped policies.
  • How Routing Peers Work: exit node mode now notes the broad-access behavior and links back to the exit nodes guide for setup and mitigations (the reference was previously one-way).

Summary by CodeRabbit

  • New Features

    • Added an Exit Nodes link under the Routes navigation section.
    • Documented how to configure default routes to forward internet traffic through an exit node.
  • Documentation

    • Clarified that exit-node routes may expose networks reachable by the routing peer, including local LANs.
    • Added guidance on restricting LAN access and isolating exit nodes.
    • Documented limitations and recommended separation of exit-node and site-resource routing.

…ations

Exit nodes previously lived only under Use Cases. Add them to the Routes
sidebar group and mention them on the Routes overview. Document that a
default route grants access to everything the routing peer can reach,
with Block LAN access and network isolation as mitigations, and link
How Routing Peers Work back to the exit nodes guide.
@vercel

vercel Bot commented Aug 20, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview Aug 20, 2026 9:52am

Request Review

@coderabbitai

coderabbitai Bot commented Aug 20, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 864279f7-969c-476a-bea3-eddf0a6a1196

📥 Commits

Reviewing files that changed from the base of the PR and between d810fdc and 5615545.

📒 Files selected for processing (4)
  • src/components/NavigationDocs.jsx
  • src/pages/manage/network-routes/index.mdx
  • src/pages/manage/networks/how-routing-peers-work.mdx
  • src/pages/use-cases/remote-access/exit-nodes.mdx

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The documentation now explains exit-node routing, reachable networks, LAN restrictions, and isolation options. The documentation navigation includes an Exit Nodes link.

Changes

Exit node routing guidance

Layer / File(s) Summary
Exit-node routing and discoverability
src/pages/manage/network-routes/index.mdx, src/pages/manage/networks/how-routing-peers-work.mdx, src/pages/use-cases/remote-access/exit-nodes.mdx, src/components/NavigationDocs.jsx
The documentation describes default-route forwarding, reachable LAN networks, LAN blocking, network isolation, and separate routing peers. The navigation links to the exit-node page.

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

Merge Risk: ⚪ Minimal · up to 56155

This change only updates documentation and navigation to clarify exit-node routing behavior and mitigations; no actionable merge-blocking risk remains beyond normal checks and review.

Possibly related PRs

Suggested reviewers: techhuttv

Poem

I’m a rabbit routing through the night,
With exit nodes set just right.
LAN paths marked and limits clear,
New docs guide each hop and peer.
Navigation now points the way—
Hop, hop, read, and route today!

🚥 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 and concisely summarizes the main documentation changes: exposing exit nodes under Routes and documenting mitigations for broad access.
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
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/exit-nodes-routes-nav

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

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

src/components/NavigationDocs.jsx

typescript-eslint does not support TS 7.0.
Please see https://devblogs.microsoft.com/typescript/announcing-typescript-7-0/#running-side-by-side-with-typescript-6.0 to run typescript-eslint using the TS 6 API.
See also typescript-eslint/typescript-eslint#10940 for tracking typescript-eslint's support for TS >=7.1

Oops! Something went wrong! :(

ESLint: 9.39.5

Error: typescript-eslint does not support TS 7.0.
at Object. (/node_modules/typescript-eslint/dist/index.js:52:11)
at Module._compile (node:internal/modules/cjs/loader:1830:14)
at Object..js (node:internal/modules/cjs/loader:1961:10)
at Module.load (node:internal/modules/cjs/loader:1553:32)
at Module._load (node:internal/modules/cjs/loader:1355:12)
at wrapModuleLoad (node:internal/modules/cjs/loader:255:19)
at Module.require (node:internal/modules/cjs/loader:1576:12)
at require (node:internal/modules/helpers:153:16)
at Object. (/node_modules/eslint-config-next/dist/index.js:5:64)
at Module._compile (node:internal/modules/cjs/loader:1830:14)

src/pages/manage/network-routes/index.mdx

ESLint skipped: the matched ESLint configuration already failed (config-incompatibility).

src/pages/manage/networks/how-routing-peers-work.mdx

ESLint skipped: the matched ESLint configuration already failed (config-incompatibility).

  • 1 others

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