Skip to content

Commit

Permalink
Merge pull request #246 from minrk/doc-keyspace-notifications
Browse files Browse the repository at this point in the history
[doc] note keyspace notifications, persistence requirement for redis
  • Loading branch information
consideRatio authored May 29, 2024
2 parents fa5f6fa + 06cbce9 commit 8a1fe25
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions docs/source/redis.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,23 @@ c.JupyterHub.proxy_class = "traefik_redis"

**TraefikRedisProxy does not manage the Redis cluster** and assumes it is up and running before the proxy itself starts.

In order for traefik to reliably receive notifications of changes from redis, redis must enable [keyspace notifications](https://redis.io/docs/latest/develop/use/keyspace-notifications/),
e.g. with

```
--notify-keyspace-events KEA
```

To avoid losing configuration upon redis restart, the redis server should also enable persistence, e.g. with

```
--appendonly yes
```

:::

:::{note}

Based on how Redis is configured and started, TraefikRedisProxy needs to be told about some Redis configuration details, such as:

- Redis **address** where it accepts client requests
Expand Down

0 comments on commit 8a1fe25

Please sign in to comment.