From 780bcc91d9faf021f164124ffc81285262a924ab Mon Sep 17 00:00:00 2001
From: 3wc <3wc@doesthisthing.work>
Date: Mon, 25 Oct 2021 13:56:49 +0200
Subject: [PATCH] Add basic README

---
 README.md | 44 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 44 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..28717f1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,44 @@
+# Backupbot II: This Time It's Easily Configurable
+
+Automatically backup files from running Docker Swarm services based on labels.
+
+## TODO
+
+- [ ] Make a Docker image of this
+- [ ] Rip out or improve Restic stuff
+- [ ] Add secret handling for database backups
+
+## Label format
+
+(Haven't done secrets yet, here are two options)
+
+v1:
+```
+    deploy:
+      labels:
+        backupbot.backup: "true"
+        backupbot.backup.repos: "$some_thing"
+        backupbot.backup.at: "* * * * *"
+        backupbot.backup.pre-hook: 'mysqldump -u root -p"$(cat /run/secrets/db_root_password)" -f /tmp/dump/dump.db'
+        backupbot.backup.post-hook: "rm -rf /tmp/dump/dump.db"
+        backupbot.backup.path: "/tmp/dump/"
+```
+v2:
+```
+    deploy:
+      labels:
+        backupbot.backup: "true"
+        backupbot.backup.repos: "$some_thing"
+        backupbot.backup.at: "* * * * *"
+        backupbot.backup.post-hook: "rm -rf /tmp/dump/dump.db"
+        backupbot.backup.secrets": "db_root_password",
+        backupbot.backup.pre-hook: 'mysqldump -u root -p"$DB_ROOT_PASSWORD" -f /tmp/dump/dump.db'
+```
+
+## Questions:
+
+- Should frequency be configurable per service, centrally, or both?
+
+```
+- "backupbot.backup.at: "* * * * *"
+```