Skip to content

docs: add Masquerade configuration page#751

Open
SunsetDrifter wants to merge 13 commits into
mainfrom
docs/masquerade-persistent-routes
Open

docs: add Masquerade configuration page#751
SunsetDrifter wants to merge 13 commits into
mainfrom
docs/masquerade-persistent-routes

Conversation

@SunsetDrifter
Copy link
Copy Markdown
Contributor

Summary

  • Adds /manage/networks/masquerade with persistent return-route configuration for Netplan, systemd-networkd, NetworkManager, ifupdown, and RHEL legacy network-scripts.
  • Covers when/why to disable masquerade, the HA caveat, the return-route requirement, verification, and a security note about firewalling at the policy layer.
  • Resolves the previously dangling "Related" tile in how-routing-peers-work.mdx that pointed at a non-existent masquerade page.
  • Adds a cross-link from advanced-configuration.mdx → "Without Masquerade" to the new page.

Documents persistent return-route setup on the destination host when
masquerade is disabled on a routing peer. Covers Netplan, systemd-networkd,
NetworkManager, ifupdown, and RHEL legacy network-scripts, plus verification
and a security note. Resolves the previously dangling "Related" tile in
how-routing-peers-work.mdx.
- Netplan: show as a fragment with addresses/default route context so readers
  don't paste it as a standalone file
- systemd-networkd: note the drop-in needs a matching .network file and
  point at networkctl status to find it
- Test section: add ping/curl reachability examples
- Verify section: call out that proto/onlink/metric fields are normal
- Remove NetworkManager, ifupdown, and RHEL legacy sections
Lead with the common case (cloud-init / installer yaml already exists),
and call out the placeholders in the example. Add a fallback path for
the rare case where /etc/netplan/ is empty.
Replace the weak one-liner with a bold "pick one" callout and a
two-bullet decision criterion (ls /etc/netplan/) so readers don't
mistake the two H3 sections for sequential steps.
Mirror the section already on the site-to-vpn page so readers learn to
use their account's /16 block rather than pinning the whole /10. Same
prose and netbird status recipe; trailing line adapted to reference
100.64.0.0/10 (the placeholder used elsewhere on this page).
@SunsetDrifter SunsetDrifter force-pushed the docs/masquerade-persistent-routes branch from 502da4f to 9a44cea Compare May 13, 2026 13:37
ping would fail for ACL reasons (not routing reasons) on policies
scoped to specific TCP ports, misdirecting troubleshooting. Use curl or
nc against an allowed port instead.
@SunsetDrifter SunsetDrifter marked this pull request as ready for review May 13, 2026 13:45
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