mirror of
https://github.com/block/buzz.git
synced 2026-08-18 06:50:31 +02:00
1e307e178a
Search migrated to Postgres FTS (commit f8bbe6efc).
The Typesense container was removed from compose.yml and the Helm chart,
but the cleanup missed two template/config files:
- `deploy/compose/.env.example`: `TYPESENSE_API_KEY` and
`TYPESENSE_PORT` are dead — no typesense service exists in compose.yml
and the relay binary no longer reads `TYPESENSE_API_KEY`. The
`CHANGE_ME_RANDOM_API_KEY` placeholder was never consumed, so removing
it also unbreaks the sed loop in the blog draft (one fewer no-op secret
to generate).
- `benchmarks/harbor-buzz-orchestra/scripts/benchmark.py`: generates a
typesense_api_key in state and writes `TYPESENSE_API_KEY` to the .env
file it creates.
- *Editing this file caused the
https://github.com/block/buzz/blob/main/.github/workflows/benchmark-harbor.yml
linter ci checks to run, which seemingly haven't run before, so I needed
fix the lint issues to pass this.*
---------
Signed-off-by: Kalvin Chau <kalvin@block.xyz>
Co-authored-by: npub1c4alndp82zyt9veaklm5d965quss79vlhk9awv7qu5erwhmf42qqlvc25c <c57bf9b4275088b2b33db7f746975407210f159fbd8bd733c0e532375f69aa80@buzz.block.builderlab.xyz>
Buzz Docker Compose deployment
This is the single-node/VPS deployment bundle. It is intentionally separate from
the root docker-compose.yml, which remains local development infrastructure.
Quick start
cd deploy/compose
cp .env.example .env
$EDITOR .env # replace every CHANGE_ME value
./run.sh start
For a public VPS with automatic Let's Encrypt certificates:
cd deploy/compose
BUZZ_COMPOSE_TLS=true ./run.sh start
The bootstrap script should eventually replace manual .env editing for normal
users. It is responsible for generating stable secrets and, optionally, an owner
keypair.
Production notes
- Requires Docker Compose v2.24.4 or newer; the TLS override uses Compose's
!resettag to remove the direct relay port when Caddy terminates HTTPS. - Default
BUZZ_IMAGEtracksghcr.io/block/buzz:mainfor early testing. Pin it toghcr.io/block/buzz:sha-<7>or a semver release tag for production once available. - Keep
BUZZ_RELAY_PRIVATE_KEY,BUZZ_GIT_HOOK_HMAC_SECRET, database/Redis, and S3 secrets stable across restarts. RELAY_OWNER_PUBKEYis intentionally not prefixed withBUZZ_; it must be a 64-character hex Nostr pubkey when closed relay mode is enabled.BUZZ_AUTO_MIGRATEis opt-in. SetBUZZ_AUTO_MIGRATE=trueor runbuzz-admin migratebefore starting the relay when bootstrapping a fresh database. Auto-migration requires an image that includes embedded SQLx migrations.- The stack uses Postgres, Redis, MinIO, and a git data volume because those are real Buzz dependencies today. Minimal mode can simplify this later.
Run ./run.sh backup-hint for the backup checklist.
Validation
Before sharing an install link publicly, verify a fresh install with:
cd deploy/compose
cp .env.example .env
$EDITOR .env
./run.sh config
./run.sh start
curl -fsS "http://127.0.0.1:$(grep -E '^BUZZ_HTTP_PORT=' .env | cut -d= -f2-)/_liveness"
./run.sh status