Repository navigation
docs(readme): tailscale setup tutorial - #5
Merged
Merged
Conversation
Walks through the real-world flow after actually doing it end-to-end
today:
1. Install via brew cask on macOS (other platforms linked).
2. Approve the macOS Network Extension — without this the app hangs
forever and the admin panel sits on 'waiting for your first
device'. This is the step most people miss.
3. Sign in; confirm the MagicDNS hostname.
4. Peer side: run hearsay normally.
5. Consumer side: accept a node share from the sender. Each side's
own tailnet, bridged by Tailscale's sharing feature — no
shared-tailnet membership required.
6. curl /health to sanity-check reachability before 'hearsay pair'.
Also tightens the Prerequisites bullet so the 'both machines join a
shared tailnet' framing isn't misleading — in practice each person
keeps their own tailnet and sharing is what connects them.
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.
Summary
New
## Tailscale setupsection in the README, walking through the real-world sequence:hearsay inviteauto-picks up your tailscale hostname.curl .../healthbefore callinghearsay pair.Also tightens the existing Prerequisites bullet — the previous wording "both machines join a shared tailnet" was misleading in practice, since users typically run separate personal tailnets and rely on node sharing.
Why
I hit every one of these steps live today onboarding to a peer's invite, including the Network Extension pitfall. Documenting the actual path so the next person doesn't have to re-discover it.
Test plan