From 55571c7c4c8f83acb8cd9b65d76effea14e016e2 Mon Sep 17 00:00:00 2001
From: TronoSfera <119615520+TronoSfera@users.noreply.github.com>
Date: Sun, 17 May 2026 20:26:14 +0300
Subject: [PATCH] docs: add docker-compose.example.yml (user-facing one-paste
 setup)

---
 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..bd48860
--- /dev/null
+++ b/docker-compose.example.yml
@@ -0,0 +1,32 @@
+# Backupy agent — paste-ready compose snippet.
+#
+# 1. Sign up at https://backupy.tronosfera.ru
+# 2. Dashboard -> Agents -> Add agent. Copy the one-time key.
+# 3. Save the key in `.env` next to this file:
+#       BACKUPY_AGENT_KEY=bk_agent_xxxxxxxxxxxxxxxxxxxx
+# 4. docker compose up -d backupy-agent
+#
+# The agent connects out to wss://backupy.tronosfera.ru — no inbound
+# ports needed.
+
+services:
+  backupy-agent:
+    image: ghcr.io/tronosfera/backupy-agent:v0.1.0
+    container_name: backupy-agent
+    restart: unless-stopped
+    environment:
+      BACKUPY_SERVER_URL: wss://backupy.tronosfera.ru/agents/connect
+      BACKUPY_AGENT_KEY: ${BACKUPY_AGENT_KEY}
+      # Set to "true" to skip Docker socket discovery (jobs still work,
+      # but no auto-detection of databases running on this host).
+      # BACKUPY_DISABLE_DISCOVERY: "false"
+    volumes:
+      # Read-only socket for Docker discovery. Drop this volume mount if
+      # you don't want the agent to enumerate sibling containers.
+      - /var/run/docker.sock:/var/run/docker.sock:ro
+      # Persistent state (BoltDB queue + last-seen offsets).
+      - backupy_agent:/var/lib/backupy
+    # The agent runs as uid 1000 by default and is otherwise unprivileged.
+
+volumes:
+  backupy_agent: