From f3cc26f86d5542efdb357a3bd10d3577afdc6487 Mon Sep 17 00:00:00 2001
From: Chewing_Bever <roosensjef@gmail.com>
Date: Fri, 15 Jan 2021 13:28:12 +0100
Subject: [PATCH] Started explanation of config file

---
 backups.yaml         | 38 ++++++++++++++++++++++++++++++++++++++
 backups.yaml.example | 26 --------------------------
 2 files changed, 38 insertions(+), 26 deletions(-)
 create mode 100644 backups.yaml
 delete mode 100644 backups.yaml.example

diff --git a/backups.yaml b/backups.yaml
new file mode 100644
index 0000000..36a1095
--- /dev/null
+++ b/backups.yaml
@@ -0,0 +1,38 @@
+# This is an example config file for the backup tool.
+
+# Here, you can set defaults which apply to all specs
+defaults:
+    # This option applies to all categories
+    all:
+        notify:
+            title: "title"
+            events:
+                - 'random'
+
+    # These are category-specific & take precedence of the all group
+    volumes:
+        notify:
+            title: "volume"
+    directories:
+
+# This is where we define the specs
+specs:
+    # There are 3 categories: volumes, directories & containers
+    volumes:
+        # Each spec has a name, which can be used in the destination field
+        # e.g. in the default value
+        test-spec:
+            source: '/some/path'
+            destination: '/some/other/{name}'
+            limit: 7
+
+        test-2:
+            source: '/path/to'
+            destination: '/to/some/other/path'
+            limit: 2
+
+    containers:
+        nextcloud_app:
+            cmd: ''
+            extension: 'tar.gz'
+    directories:
diff --git a/backups.yaml.example b/backups.yaml.example
deleted file mode 100644
index 26f6729..0000000
--- a/backups.yaml.example
+++ /dev/null
@@ -1,26 +0,0 @@
-defaults:
-    all:
-        notify:
-            title: "title"
-            events:
-                - 'random'
-    volumes:
-    directories:
-
-specs:
-    volumes:
-        test-spec:
-            source: '/some/path'
-            destination: '/some/other/path'
-            limit: 7
-
-        test-2:
-            source: '/path/to'
-            destination: '/to/some/other/path'
-            limit: 2
-
-    containers:
-        nextcloud_app:
-            cmd: ''
-            extension: 'tar.gz'
-    directories: