mirror of
https://github.com/block/buzz.git
synced 2026-08-18 06:50:31 +02:00
+1
14fba21e57
14fba21e57
Signed-off-by: tlongwell-block <109685178+tlongwell-block@users.noreply.github.com> Signed-off-by: npub1jh9wn95s0472h86ahapupaf7m6kx4v9sx2n0atj2hltcfer8k06s5n3pyf <95cae996907d7cab9f5dbf43c0f53edeac6ab0b032a6feae4abfd784e467b3f5@sprout-oss.stage.blox.sqprod.co> Signed-off-by: Tyler Longwell <tlongwell@block.xyz> Signed-off-by: npub1t2tgm7d8f995uqvmnm8h88sg3wnpp9a5xysjf6dg3tjmgt3ltulqdp8ehr <5a968df9a7494b4e019b9ecf739e088ba61097b4312124e9a88ae5b42e3f5f3e@sprout-oss.stage.blox.sqprod.co> Signed-off-by: npub17jjz49l9jjmhhk7cac63j8yt9z555n9cw8vk7v5jz4vzw4ppld5qgj57cc <f4a42a97e594b77bdbd8ee35191c8b28a94a4cb871d96f32921558275421fb68@sprout-oss.stage.blox.sqprod.co> Co-authored-by: Eva <011987e296fd5006292d2f930b574be47c7801048d1983c46c425d3c95f0cffd@sprout-oss.stage.blox.sqprod.co> Co-authored-by: Mari <95cae996907d7cab9f5dbf43c0f53edeac6ab0b032a6feae4abfd784e467b3f5@sprout-oss.stage.blox.sqprod.co> Co-authored-by: Sami <f4a42a97e594b77bdbd8ee35191c8b28a94a4cb871d96f32921558275421fb68@sprout-oss.stage.blox.sqprod.co> Co-authored-by: Max <d8473ee32b973aa31a21a65adddcc4b69cc2a8a4dee8121ecd51926e0cddbc02@sprout-oss.stage.blox.sqprod.co> Co-authored-by: Quinn <96f056ad5f2305c8ddf637dc65d048aa4c12d7daeb8867690e34fca46b0ef64c@sprout-oss.stage.blox.sqprod.co> Co-authored-by: Dawn <c6237ef84fa537c78dcee78efd2d4e59f728859c7f194da42ac51ededfa0be05@sprout-oss.stage.blox.sqprod.co> Co-authored-by: Tyler Longwell <tlongwell@block.xyz> Co-authored-by: Sami <sami@sprout-oss.stage.blox.sqprod.co> Co-authored-by: npub1t2tgm7d8f995uqvmnm8h88sg3wnpp9a5xysjf6dg3tjmgt3ltulqdp8ehr <5a968df9a7494b4e019b9ecf739e088ba61097b4312124e9a88ae5b42e3f5f3e@sprout-oss.stage.blox.sqprod.co>
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