docs: add How Routing Peers Work concept page#727
Merged
SunsetDrifter merged 3 commits intomainfrom May 5, 2026
Merged
Conversation
Add a feature-agnostic primer covering the routing peer mental model: traffic flow through forward vs input chains, host requirements (IP forwarding on Linux/Windows, container caps, cloud settings), HA modes (primary/failover and equal-metric latency switching), masquerade, access control, DNS routing, exit nodes, and common pitfalls. Surface it in the sidebar under Networks and cross-link from both the Networks and Network Routes concept pages.
- Clarify mental-model walkthrough describes the Linux kernel-mode path - Expand OS list to Linux/Windows/macOS/FreeBSD/Android/tvOS/Docker - Correct container IP-forwarding guidance: set sysctl on the host - Reframe Windows NB_ENABLE_LOCAL_FORWARDING as opt-in for exposing services on the routing peer's local addresses, off by default - Soften failover wording to avoid implying tunnel rebuild; scope reset claim to established TCP connections, drop "typically" - Add masquerade-off caveats: Linux only, breaks HA - Drop unfounded ACL-Groups-require-masquerade Warning - Drop misplaced internal-DNS-resolver link from DNS section intro - Rename Wildcard domains section to Routing Peer DNS Resolution - Drop container/host IP-forwarding pitfall (not a real-world failure) - Rephrase exit-node ICMP pitfall: clients can't connect at all
A concrete scenario (office subnet behind the peer + Grafana on TCP/3000 + SSH on TCP/22) showing the two policies needed: a network resource policy on the forward chain and a peer-to-peer policy on the input chain.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
/manage/networks/how-routing-peers-workcovering the routing-peer mental model: traffic flow, host requirements, HA modes, masquerade, access control, DNS routing, exit nodes, and common pitfalls.manage/networks/index.mdxandmanage/network-routes/index.mdxso readers on the existing concept pages can find the primer.Notes
netbird service reconfigure --service-env NB_ENABLE_LOCAL_FORWARDING=truecommand.