mirror of
https://github.com/block/buzz.git
synced 2026-08-18 06:50:31 +02:00
npub122y0pqkertljmedu303rl0aqrj3w8pvu43t6jxm6875lzg6f2pwqegc3xc
bd7b275fb4
Add one strict path-or-virtual setting shared by media and Git/CAS storage. Preserve path-style MinIO defaults, validate bad values before startup, and document Railway and Helm configuration. Co-authored-by: npub122y0pqkertljmedu303rl0aqrj3w8pvu43t6jxm6875lzg6f2pwqegc3xc <5288f082d91aff2de5bc8be23fbfa01ca2e3859cac57a91b7a3fa9f12349505c@buzz.block.builderlab.xyz> Signed-off-by: npub122y0pqkertljmedu303rl0aqrj3w8pvu43t6jxm6875lzg6f2pwqegc3xc <5288f082d91aff2de5bc8be23fbfa01ca2e3859cac57a91b7a3fa9f12349505c@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.
- Bundled MinIO uses
BUZZ_S3_ADDRESSING_STYLE=path: Docker DNS resolvesminio, not<bucket>.minio. To replace bundled MinIO with an external provider, override the endpoint, bucket, region, and addressing style as a matched set; providers such as new Railway Storage Buckets requirevirtual. Invalid styles fail relay startup.
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