23f75dac90
Fill all 31 stub pages scaffolded in Phase 1 with content migrated and verified from the root docs, crate READMEs, and source code: - getting-started/ (3): installation, quickstart, local relay (TESTING.md) - architecture/ (8): ARCHITECTURE.md §1–§8, one page per section - guides/ (9): development, testing, agents, workflows, self-hosting, nostr-clients (operational half of NOSTR.md), adding-event-kinds, adding-api-endpoints, releasing - reference/ (5): CLI reference verified against buzz --help and crates/buzz-cli/src (18 groups / 87 subcommands; README drift noted), configuration, known-limitations (ARCHITECTURE §9 + conformance LIMITS.md + doc-debt list), NIPs index (13, NIP-CW canonical), design-docs index - vision/ (6): VISION.md + 5 VISION_*.md migrated with aspirational banners and rewritten links Root originals (ARCHITECTURE, NOSTR, TESTING, RELEASING, VISION*) get pointer notes marking docs/ as canonical; deletion is a follow-up. All relative links in the new tree verified to resolve. Known limitations are documented honestly, never papered over: rate limiting unenforced, WF-07/WF-08 workflow stubs, buzz-cli README drift, one-line GOVERNANCE.md. Note: pre-commit sadscan findings reviewed as false positives (dev-default postgres URI and NIP-OA test vectors, both already on origin/main). Co-authored-by: npub1pejagjwzjh7y36gq97hxf62ry75u3s6c6grr0rumx2p4c5qsms9s7jdtgl <0e65d449c295fc48e9002fae64e94327a9c8c358d206378f9b32835c5010dc0b@sprout-oss.stage.blox.sqprod.co> Signed-off-by: npub1pejagjwzjh7y36gq97hxf62ry75u3s6c6grr0rumx2p4c5qsms9s7jdtgl <0e65d449c295fc48e9002fae64e94327a9c8c358d206378f9b32835c5010dc0b@sprout-oss.stage.blox.sqprod.co>
2.8 KiB
Installation
How to get each Buzz component onto your machine. Buzz ships three independently versioned artifacts — the desktop app, the relay, and the mobile app — plus source-built CLI tools.
Supported platforms
| Component | Platforms | Distribution |
|---|---|---|
| Desktop app | macOS (Apple Silicon + Intel), Linux (.deb, .AppImage) |
GitHub releases on block/buzz |
| Relay | Any Docker host / Linux | ghcr.io/block/buzz container image |
CLI (buzz) |
Anywhere Rust builds | cargo install from source |
| Mobile | iOS + Android (Flutter) | 🚧 being wired up — internal builds only |
On Windows, the agent shell tool needs a bash: install
Git for Windows (ships Git Bash), or point
BUZZ_SHELL at another bash-compatible shell.
Desktop app
Download the latest v<version> release from
GitHub releases:
- macOS Apple Silicon — the
.dmginstaller - macOS Intel — the
_x64.dmginstaller - Linux —
.debor.AppImage
Both macOS DMGs are codesigned and notarized. The app auto-updates via the
buzz-desktop-latest rolling release (currently darwin-aarch64 only; Intel
and Linux users download new versions manually — see
RELEASING.md troubleshooting).
Relay
The relay is published as a container image:
docker pull ghcr.io/block/buzz:main # tip of main
docker pull ghcr.io/block/buzz:<version> # tagged release
For a full single-node deployment (relay + Postgres + Redis + MinIO + TLS),
use the Docker Compose bundle in deploy/compose/ —
see Self-Hosting. For Kubernetes, use the
Helm chart.
To build the relay from source instead:
git clone https://github.com/block/buzz.git && cd buzz
. ./bin/activate-hermit
cargo build --release -p buzz-relay
CLI
The buzz CLI is built from source:
cargo install --path crates/buzz-cli # from a checkout
# or, inside a checkout:
cargo build --release -p buzz-cli -p buzz-admin
export PATH="$PWD/target/release:$PATH"
See the CLI Reference for commands and configuration.
From source (everything)
For hacking on Buzz itself, follow the Development guide:
git clone https://github.com/block/buzz.git && cd buzz
. ./bin/activate-hermit # pinned toolchain (Rust 1.88+, Node 24+, pnpm 10+, just)
just setup && just build
Verifying the install
buzz-relay & # or: just relay
curl -s http://localhost:3000/health # → ok
buzz --help # CLI prints usage
Next: the Quickstart.