You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 8636898
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: deploy/charts/buzz/README.md
+26-22Lines changed: 26 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,13 +1,13 @@
1
1
# Buzz Helm Chart
2
2
3
-
[Buzz](https://github.com/block/buzz) is a Nostr-based messaging platform for human–agent collaboration: a single relay binary serving WebSocket + REST + web UI, backed by PostgreSQL, Redis, Typesense, and S3-compatible object storage.
3
+
[Buzz](https://github.com/block/buzz) is a Nostr-based messaging platform for human–agent collaboration: a single relay binary serving WebSocket + REST + web UI, backed by PostgreSQL, Redis, and S3-compatible object storage. NIP-50 search defaults to Postgres full-text search, with Typesense available as a fallback backend.
4
4
5
5
This chart has two operating profiles selected by values:
This brings up **everything in-cluster** — Postgres, Redis, MinIO (with its
27
-
bucket created by a post-install Job), and Typesense — and composes the relay's
28
-
`BUZZ_S3_ENDPOINT` / `TYPESENSE_URL` plus autogenerated credentials
29
-
automatically. No external services required. The `quickstart=true` flag is an
30
-
intent marker surfaced in NOTES.txt; the bundled services are opted in via the
31
-
four `*.enabled` flags above (see `ci/quickstart-values.yaml` for the exact set
32
-
CI installs). Eval-only: every bundled service is a single replica with no HA.
25
+
This brings up the required quickstart dependencies in-cluster — Postgres,
26
+
Redis, and MinIO (with its bucket created by a post-install Job) — and composes
27
+
the relay's `BUZZ_S3_ENDPOINT` plus autogenerated credentials automatically.
28
+
Search defaults to Postgres FTS (`search.backend=postgres`), so no Typesense
29
+
service is required. The `quickstart=true` flag is an intent marker surfaced in
30
+
NOTES.txt; the bundled services are opted in via the per-service `*.enabled`
31
+
flags (see `ci/quickstart-values.yaml` for the exact set CI installs).
32
+
Eval-only: every bundled service is a single replica with no HA.
33
33
34
34
## Production (GitOps)
35
35
@@ -50,7 +50,7 @@ See:
50
50
|`relayUrl`| Public `wss://` URL clients connect to | Always |
51
51
|`ownerPubkey`| 64-char lowercase hex Nostr pubkey of the relay operator | When `relay.requireRelayMembership=true` (default) |
52
52
|`secrets.existingSecret`| Name of pre-created Secret | Production / GitOps |
53
-
|`externalPostgresql.url` / `externalRedis.url` / `typesense.url` / `s3.endpoint`| External service URLs | Production — when the matching bundled service is disabled (the default) |
53
+
|`externalPostgresql.url` / `externalRedis.url` / `s3.endpoint`| External service URLs | Production — when the matching bundled service is disabled (the default) |
54
54
55
55
The chart fails at `helm install` / `helm template` time with a clear message if any of these are missing or malformed (see `templates/_validate.tpl`).
56
56
@@ -81,17 +81,21 @@ Save these. Losing any of them is data loss. See NOTES.txt printed by `helm inst
81
81
82
82
## Honest limitations (v1)
83
83
84
-
-**Bundled MinIO + Typesense are eval-only.** The quickstart profile runs an
85
-
in-cluster MinIO and Typesense (single replica, no HA, `lookup`-autogenerated
86
-
credentials) so the relay starts with zero external services. Production
87
-
leaves `minio.enabled` / `typesense.enabled` off and points `s3.endpoint` +
88
-
`typesense.url` (or `BUZZ_S3_*` / `TYPESENSE_URL` in `existingSecret`) at
89
-
managed S3-compatible storage and Typesense. The bundled Deployments are not
90
-
GitOps-safe and are not intended for production traffic.
84
+
-**Bundled MinIO is eval-only.** The quickstart profile runs an in-cluster MinIO
85
+
(single replica, no HA, `lookup`-autogenerated credentials) so the relay starts
86
+
with zero external object-storage dependencies. Production leaves
87
+
`minio.enabled` off and points `s3.endpoint` (or `BUZZ_S3_*` in
88
+
`existingSecret`) at managed S3-compatible storage. The bundled Deployment is
89
+
not GitOps-safe and is not intended for production traffic.
90
+
-**Typesense is a fallback search backend.** Default search is Postgres FTS
91
+
(`search.backend=postgres`). To use Typesense instead, set
92
+
`search.backend=typesense` and provide either `typesense.url`/`apiKey`,
93
+
`TYPESENSE_URL`/`TYPESENSE_API_KEY` in `secrets.existingSecret`, or
94
+
`typesense.enabled=true` for eval-only in-cluster Typesense.
91
95
-**Minimal-mode is not yet supported.** The relay's `BUZZ_PUBSUB=local` /
92
-
`BUZZ_SEARCH=pg` / filesystem media paths are upstream work in progress —
93
-
even quickstart currently stands up real Redis, Typesense, and S3 rather than
94
-
the relay's single-node fallbacks.
96
+
filesystem media paths are upstream work in progress — even quickstart
97
+
currently stands up real Redisand S3 rather than the relay's single-node
98
+
fallbacks.
95
99
-**OCI publish to GHCR + cosign signing** is a follow-up PR. For now, install the chart from source: `helm install buzz ./deploy/charts/buzz` after cloning the repo.
0 commit comments