From 804b69b67cf22d7117b3bd930868a2630f0eb82e Mon Sep 17 00:00:00 2001
From: Samuel Enocsson <samuel.enocsson@gmail.com>
Date: Fri, 22 May 2026 12:07:47 +0200
Subject: [PATCH] docs: docker-compose.example.yml for end-user deploy

---
 docker-compose.example.yml | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)
 create mode 100644 docker-compose.example.yml

diff --git a/docker-compose.example.yml b/docker-compose.example.yml
new file mode 100644
index 0000000..ba61110
--- /dev/null
+++ b/docker-compose.example.yml
@@ -0,0 +1,32 @@
+# Example deployment of package-updater itself.
+# Copy to /home/shcizo/self-hosted/package-updater/docker-compose.yml
+# and create a .env file alongside containing:
+#   UPDATER_API_KEY=<openssl rand -hex 32>
+
+services:
+  package-updater:
+    image: registry.example.com/package-updater:latest
+    container_name: package-updater
+    restart: unless-stopped
+    environment:
+      - UPDATER_API_KEY=${UPDATER_API_KEY}
+      - STACKS_ROOT=/home/shcizo/self-hosted
+      - LOG_LEVEL=info
+      - PORT=8080
+      - UPDATE_TIMEOUT=5m
+    volumes:
+      - /var/run/docker.sock:/var/run/docker.sock
+      - /home/shcizo/self-hosted:/home/shcizo/self-hosted:ro
+    labels:
+      - "se.shcizo.auto-update=true"
+    networks:
+      - proxy
+    healthcheck:
+      test: ["CMD", "wget", "-q", "-O-", "http://localhost:8080/healthz"]
+      interval: 30s
+      timeout: 5s
+      retries: 3
+
+networks:
+  proxy:
+    external: true