From ce7fe56c7039cafc3911914ef683ecb4ee3eae56 Mon Sep 17 00:00:00 2001 From: Vladimir Dementyev Date: Fri, 3 Nov 2023 11:42:08 -0700 Subject: [PATCH] docs: update nats broker docs --- docs/reliable_streams.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/reliable_streams.md b/docs/reliable_streams.md index 024868fd..0d8c956a 100644 --- a/docs/reliable_streams.md +++ b/docs/reliable_streams.md @@ -118,7 +118,7 @@ _🧪 This adapter is currently in the experimental stage. Please, report any is This adapter uses [NATS JetStream](https://nats.io/) as a shared distributed storage for sessions and streams cache and also keeps a local snapshot in memory (using the in-memory adapter described above). -It can be used with both external NATS and [embedded NATS](./embedded_nats.md): +Usage: ```sh $ anycable-go --broker=nats --nats_servers=nats://localhost:4222 @@ -128,7 +128,11 @@ $ anycable-go --broker=nats --nats_servers=nats://localhost:4222 ... ``` -Or with embedded NATS: +**NOTE:** You MUST have JetStream enabled in your NATS server. See [NATS JetStream documentation](https://docs.nats.io/nats-concepts/jetstream) for more information. + +### Using with embedded NATS + +[Embedded NATS](./embedded_nats.md) automatically enables JetStream if the NATS broker is being used: ```sh $ anycable-go --embed_nats --broker=nats