Skip to content

Commit

Permalink
docs: update nats broker docs
Browse files Browse the repository at this point in the history
  • Loading branch information
palkan committed Nov 3, 2023
1 parent 66d92da commit ce7fe56
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions docs/reliable_streams.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down

0 comments on commit ce7fe56

Please sign in to comment.