From 8b026ea1de5a26ede6beb5ce48274462453fce85 Mon Sep 17 00:00:00 2001
From: Thomas Kaul <4159106+dtslvr@users.noreply.github.com>
Date: Sun, 4 Oct 2026 10:21:17 +0200
Subject: [PATCH] Update documentation

---
 README.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index aa4a55e86d..59c7c5d2c6 100644
--- a/README.md
+++ b/README.md
@@ -193,7 +193,7 @@ You can get the _Bearer Token_ via `POST http://localhost:3333/api/v1/auth/anony
 
 ### Health Check (experimental)
 
-The endpoint checks the connection to the database and to _Redis_. It is suitable as the readiness probe of an orchestrator (e.g. `readinessProbe` in _Kubernetes_) and as the `healthcheck` in _Docker Compose_.
+The endpoint checks the connection to the database and to _Redis_. It is suitable as the readiness probe of an orchestrator (e.g. `readinessProbe` in _Kubernetes_) and as the `healthcheck` in _Docker Compose_. The check of _Redis_ can take up to 5 seconds. Thus, set the timeout of the probe to at least 5 seconds (e.g. `timeoutSeconds: 5` in _Kubernetes_).
 
 #### Request
 
@@ -215,7 +215,7 @@ The endpoint checks the connection to the database and to _Redis_. It is suitabl
 
 ### Liveness Probe (experimental)
 
-The endpoint answers without a check of the database or _Redis_. It is suitable as the liveness probe of an orchestrator (e.g. `livenessProbe` in _Kubernetes_), so that an outage of a dependency does not restart the container.
+The endpoint answers without a check of the database or _Redis_. It is suitable as the liveness probe of an orchestrator (e.g. `livenessProbe` in _Kubernetes_), so that an outage of a dependency after the start does not restart the container. The database migrations run before the server starts. Thus, also use the endpoint as the startup probe (e.g. `startupProbe` in _Kubernetes_), so that a long migration does not restart the container.
 
 #### Request