docs: add trusted-peer sharing and peer-onboarding guides#23
Merged
Conversation
Adds two operational guides for sharing a self-hosted context-intelligence server with trusted external peers over an overlay network (Tailscale), plus a README link section. remote-access-sharing.md (operator guide) covers: - Loopback binding to isolate the server - Exposing only the /events path via tailscale serve - Per-peer access scoping with ACL grants - The critical ACL pitfall: a default src:["*"] allow-all grant includes shared users and unions with narrow grants (so the broad rule must use autogroup:member) - Network verification gates - Cold backup with docker-stop and restore-as-root-in-a-container - Trust-model accept-or-harden table (single key, workspace spoofing, no rate cap) peer-onboarding.md is the peer-facing connect guide to hand each trusted user. Content references (does not duplicate) the existing README "Network Access and Security" section, docs/service-setup.md §10 (Caddy/TLS), and the API-key auth model. Generalized from a real deployment — no environment-specific values. Generated with [Amplifier](https://github.com/microsoft/amplifier) Co-Authored-By: Amplifier <240397093+microsoft-amplifier@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
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
Adds two operational guides for sharing a self-hosted context-intelligence server with trusted external peers over an overlay network (Tailscale), plus a README link section.
What's included
docs/remote-access-sharing.md (operator guide):
tailscale servefor HTTPSautogroup:memberfor your tailnet, explicit peer emails for shared users)src:["*"]allow-all grant includes shared/invited users and grants are additive (union), so a narrow grant is cosmetic until the broad rule is changed toautogroup:memberdocker stop(not pause) and restore-as-root-in-a-container (resolves file ownership issue)docs/peer-onboarding.md (peer-facing connect guide):
References (not duplication)
Both docs reference rather than repeat:
docs/service-setup.md§10 (Caddy/TLS patterns)Scope
Next steps
This can be merged as-is, or flagged for any wording/structure feedback.