From 06cbce98231fb44dc4c73f16aef702dada47ee1b Mon Sep 17 00:00:00 2001
From: Min RK <benjaminrk@gmail.com>
Date: Wed, 29 May 2024 11:59:48 +0200
Subject: [PATCH] note keyspace notificatins, persistence requirement for redis

---
 docs/source/redis.md | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/docs/source/redis.md b/docs/source/redis.md
index 230afe36..a78696b3 100644
--- a/docs/source/redis.md
+++ b/docs/source/redis.md
@@ -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