jerry/buzz
1
0
Fork 0
mirror of https://github.com/block/buzz.git synced 2026-11-02 15:31:27 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
cfd16deb77ca0496827765e4c2e73bf8f003b0b4
buzz/docs/guides/self-hosting.md
npub19zza5yyr075j4vvlg2drsh2xe0xy3dqxhfchlgtw8vryglrry3gq8q7tzk cfd16deb77 docs: scaffold documentation information architecture (Phase 1) 
Add the docs/ skeleton for the full docs implementation: getting-started,
architecture, guides, reference, and vision sections, with a nav/TOC home
page. Every page is a stub carrying its heading outline and pointers to the
source material to be migrated in Phase 2 (content).

docs/nips/, docs/spec/, and the loose design docs stay at their current
paths (55 references from code, tests, and migrations outside docs/);
reference/nips.md and reference/design-docs.md index them instead.

Root GitHub-convention files are untouched. ARCHITECTURE/NOSTR/TESTING/
RELEASING/VISION* remain in place this phase and will become pointer files
in Phase 2.

Co-authored-by: npub19zza5yyr075j4vvlg2drsh2xe0xy3dqxhfchlgtw8vryglrry3gq8q7tzk <2885da10837fa92ab19f429a385d46cbcc48b406ba717fa16e3b06447c632450@sprout-oss.stage.blox.sqprod.co>
Signed-off-by: npub19zza5yyr075j4vvlg2drsh2xe0xy3dqxhfchlgtw8vryglrry3gq8q7tzk <2885da10837fa92ab19f429a385d46cbcc48b406ba717fa16e3b06447c632450@sprout-oss.stage.blox.sqprod.co>
2026-07-07 11:48:10 -07:00

780 B
Raw Blame History

Self-Hosting Buzz

Status: stub — Phase 1 (structure). Content to be written in Phase 2.

Scope: Deploying and operating your own relay: Docker Compose VPS bundle, Helm chart, TLS, membership administration, multi-tenancy.

Outline

  • Deployment options overview
  • Docker Compose bundle (run.sh, Caddy TLS)
  • Kubernetes (Helm chart)
  • Relay configuration (env vars)
  • Membership + admin (buzz-admin, NIP-43 allowlist)
  • Multi-tenant operation (links to design docs/specs)
  • Upgrades and backups

Source material

  • deploy/compose/README.md, deploy/charts/buzz/README.md
  • Dockerfile, docker-compose.yml
  • NOSTR.md (allowlist/admin operational half)
  • docs/multi-tenant-relay.md, docs/multi-tenant-conformance.md (linked)
  • crates/buzz-admin