From e7fcbd70ad5298caad8b5872c7dbc6e74a96bfb2 Mon Sep 17 00:00:00 2001
From: Matthieu Talbot <neogaldr@gmail.com>
Date: Mon, 22 Nov 2021 23:06:55 +0100
Subject: [PATCH] Add a docker-compose hook example (#170)

Co-authored-by: Fernandez Ludovic <ldez@users.noreply.github.com>
---
 readme.md | 34 ++++++++++++++++++++++++++++++++++
 1 file changed, 34 insertions(+)

diff --git a/readme.md b/readme.md
index 4da8aeb..27b9aee 100644
--- a/readme.md
+++ b/readme.md
@@ -131,6 +131,40 @@ dump
    └──letsencrypt.key
 ```
 
+## Hook
+
+Hook can be a one liner passed as a string, or a file for more complex post-hook scenarios.
+For the former, create a file (ex: `hook.sh`) and mount it, then pass `sh hooksh` as a parameter to `--post-hook`.
+
+Here is a docker-compose example:
+
+```yml
+version: '3.7'
+
+services:
+# ...
+
+  traefik-certs-dumper:
+    image: ldez/traefik-certs-dumper:v2.7.4
+    container_name: traefik-certs-dumper
+    entrypoint: sh -c '
+      apk add jq
+      ; while ! [ -e /data/acme.json ]
+      || ! [ `jq ".[] | .Certificates | length" /data/acme.json` != 0 ]; do
+      sleep 1
+      ; done
+      && traefik-certs-dumper file --version v2 --watch
+        --source /data/acme.json --dest /data/certs
+        --post-hook "sh /hook.sh"'
+    labels:
+      traefik.enable: false
+    volumes:
+      - ./letsencrypt:/data
+      - ./hook.sh:/hook.sh
+
+# ...
+```
+
 ### KV store
 
 #### Consul