docs: quickstart uses a hub + two spokes - #164
Merged
Merged
Conversation
A single-spoke quickstart never exercises the hub's actual job — relaying between spokes — and its "ping 10.0.0.1" step was inconsistent with a role-derived hub, which is a pure relay with no overlay address. Bring up one hub and two spokes (A=10.0.0.2, B=10.0.0.3): - Generate two per-link PSKs (KEY_A, KEY_B); the hub lists both spokes, each spoke lists the hub. The role-derived hub auto-relays between them (10.0.0.2/32->peer2, 10.0.0.3/32->peer3) with zero manual policy. - Verify by pinging spoke B from spoke A (A -> hub -> B), and watch the hub's relay_* counters; note the hub has no overlay address and point to Roles -> Reaching the hub itself for making it pingable. - --check now shows both banners (spoke peers=1 single port, hub peers=2 three ports). Site-to-Site step corrected to run on the hub for spoke B. EN + ZH kept in sync; mdbook builds and check-links pass. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Merged
jamiesun
added a commit
that referenced
this pull request
Jun 12, 2026
Bump build.zig.zon .version 0.8.3 -> 0.9.0 ahead of tagging. Highlights since v0.8.3: - feat: configurable MAX_PEERS via the `-Dmax-peers` build option, 1..128 (#165) - feat: raise the default peer cap to 32 (#166) - docs: Exit Node & Outbound guide, simplified to the proxy-outbound pattern (#162, #163) - docs: quickstart now uses a hub + two spokes (#164) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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
1 participant
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.
What
Reworks the Quick Start (EN + ZH) to bring up one hub and two spokes instead of one hub + one spoke.
Why
ping 10.0.0.1verify step was a latent inconsistency: a role-derived hub is a pure relay with no overlay address, so there is nothing at10.0.0.1to ping.Changes
KEY_A,KEY_B) — the guide now makes the "one key per link, never reuse" rule concrete.10.0.0.2), spoke B (10.0.0.3). The role-derived hub auto-relays (10.0.0.2/32 -> peer 2,10.0.0.3/32 -> peer 3) with zero manual policy.A -> hub -> B), watch the hub'srelay_*counters. Added a callout that the hub has no overlay address, linking to Roles -> Reaching the hub itself.--checknow shows both banners (spokepeers=1, single port; hubpeers=2, three ports).Verification
mdbook buildpasses for EN and ZHpython3 docs-site/check-links.py— all links and heading anchors resolve, including the new cross-page anchors#reaching-the-hub-itself/#访问-hub-自身Docs-only change; no source or behaviour changes.