basalt / realtime/src / RedisBackplaneOptions

Interface: RedisBackplaneOptions

Defined in: realtime/src/drivers/redis.ts:15

Properties

channel?

> optional channel?: string

Defined in: realtime/src/drivers/redis.ts:24

Redis pub/sub channel the instances share. Default 'basalt:realtime'. Every app and environment on the same Redis that keeps the default shares one channel — and therefore each other's tenant ids. Give each deployment its own (e.g. 'myapp:prod:realtime').

---

publisher

> publisher: RedisRealtimeClient

Defined in: realtime/src/drivers/redis.ts:16

---

secret?

> optional secret?: string | readonly string[]

Defined in: realtime/src/drivers/redis.ts:35

HMAC-SHA256 key(s) for signing backplane messages. When set, every message is published as a signed envelope and anything arriving unsigned, tampered or signed with another key is dropped — so a client that can merely PUBLISH on the Redis cannot push forged events to your tenants.

Pass an array to rotate: the FIRST key signs, ALL keys verify. Every instance must share the key(s); a node without one drops signed messages as malformed (and vice versa). Default: unsigned plain JSON.

---

subscriber

> subscriber: RedisRealtimeClient

Defined in: realtime/src/drivers/redis.ts:17