Quickstart

Install every Hermes service plus bundled PostgreSQL, NATS, Redis and Centrifugo into a namespace, with the schema migration and stream provisioning applied automatically.

Requirements

Kubernetes 1.26+

Any conformant cluster

Helm 3.12+

OCI registry support

A domain

Ingress and TLS termination

1 · Install the chart

helm install hermes oci://ghcr.io/hermesnotifications/charts/hermes \
  --namespace hermes --create-namespace \
  --set global.domain=hermes.example.com \
  --set hermes.jwt.secret="$(openssl rand -base64 32)" \
  --set hermes.apiKey.hmacSecret="$(openssl rand -base64 32)"

2 · Verify the rollout

$ kubectl get pods -n hermes
hermes-send-…        1/1   Running
hermes-dispatch-…    1/1   Running
hermes-event-writer- 1/1   Running

3 · Send your first notification

curl -X POST https://hermes.example.com/v1/send \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "to": {"organization_id": "<uuid>", "user_id": "user123"},
    "template": "welcome",
    "data": {"name": "Alice"}
  }'

Next steps

Embed the inbox →

Drop the custom element into your frontend with an origin, a token and a socket URL.

Harden for production →

External datastores over TLS, secret rotation, and the reference Terraform deployment.