From 001268a33eefa7dd2b14f401d6fb7bfbee04c21c Mon Sep 17 00:00:00 2001
From: kolaente <k@knt.li>
Date: Sun, 11 Feb 2024 18:31:41 +0100
Subject: [PATCH] docs: add healthcheck to docker compose examples

---
 .../doc/setup/docker-start-to-finish.md       |  6 ++++-
 docs/content/doc/setup/full-docker-example.md | 23 +++++++++++++++----
 2 files changed, 24 insertions(+), 5 deletions(-)

diff --git a/docs/content/doc/setup/docker-start-to-finish.md b/docs/content/doc/setup/docker-start-to-finish.md
index 05d70f974..954e92c83 100644
--- a/docs/content/doc/setup/docker-start-to-finish.md
+++ b/docs/content/doc/setup/docker-start-to-finish.md
@@ -47,7 +47,8 @@ services:
         volumes:
             - ./files:/app/vikunja/files
         depends_on:
-            - db
+            db:
+                condition: service_healthy
         restart: unless-stopped
     db:
         image: mariadb:10
@@ -60,6 +61,9 @@ services:
         volumes:
             - ./db:/var/lib/mysql
         restart: unless-stopped
+        healthcheck:
+            test: ["CMD", "mysqladmin", "ping", "--silent"]
+            interval: 2s
 ```
 
 This defines two services, each with their own container:
diff --git a/docs/content/doc/setup/full-docker-example.md b/docs/content/doc/setup/full-docker-example.md
index a07bd423a..71884d649 100644
--- a/docs/content/doc/setup/full-docker-example.md
+++ b/docs/content/doc/setup/full-docker-example.md
@@ -34,13 +34,16 @@ To use postgres as a database backend, change the `db` section of the examples t
 
 ```yaml
 db:
-  image: postgres:13
+  image: postgres:16
   environment:
     POSTGRES_PASSWORD: secret
     POSTGRES_USER: vikunja
   volumes:
     - ./db:/var/lib/postgresql/data
   restart: unless-stopped
+  healthcheck:
+    test: ["CMD-SHELL", "pg_isready -d $${POSTGRES_DB} -U $${POSTGRES_USER}"]
+    interval: 2s
 ```
 
 You'll also need to change the `VIKUNJA_DATABASE_TYPE` to `postgres` on the api container declaration.
@@ -111,7 +114,8 @@ services:
     volumes:
       - ./files:/app/vikunja/files
     depends_on:
-      - db
+      db:
+        condition: service_healthy
     restart: unless-stopped
   db:
     image: mariadb:10
@@ -124,6 +128,9 @@ services:
     volumes:
       - ./db:/var/lib/mysql
     restart: unless-stopped
+    healthcheck:
+      test: ["CMD", "mysqladmin", "ping", "--silent"]
+      interval: 2s
 ```
 
 ## Example with Traefik 2
@@ -156,7 +163,8 @@ services:
       - web
       - default
     depends_on:
-      - db
+      db:
+        condition: service_healthy
     restart: unless-stopped
     labels:
       - "traefik.enable=true"
@@ -175,6 +183,9 @@ services:
     volumes:
       - ./db:/var/lib/mysql
     restart: unless-stopped
+    healthcheck:
+      test: ["CMD", "mysqladmin", "ping", "--silent"]
+      interval: 2s
 
 networks:
   web:
@@ -215,7 +226,8 @@ services:
     volumes:
       - ./files:/app/vikunja/files
     depends_on:
-      - db
+      db:
+        condition: service_healthy
     restart: unless-stopped
   db:
     image: mariadb:10
@@ -228,6 +240,9 @@ services:
     volumes:
       - ./db:/var/lib/mysql
     restart: unless-stopped
+    healthcheck:
+      test: ["CMD", "mysqladmin", "ping", "--silent"]
+      interval: 2s
   caddy:
     image: caddy
     restart: unless-stopped