4.1-Extra-backup-locations.md

@@ -0,0 +1,40 @@
+# xtraLocations.borg
+
+This is a plain-text list of additional files and directories you'd like the script to include in your backup. Entries should be listed one per line. By convention, directories should include a trailing slash but this is not required. For example, let's include the following locations in our backup:
+
+```ini
+/home/jsmith/
+/etc/program/*.conf
+/etc/foo.bar
+/opt/foo
+```
+
+The above would include:
+
+- the entire directory */home/jsmith/* and all files and subdirectories contained therein;
+- all files in */etc/program/* directory with the extension *.conf*;
+- the individual file */etc/foo.bar*; and
+- the directory */opt/foo*, notice that the lack of trailing slash doesn't matter.
+
+This file is *strictly optional* but recommended since it's often nice to include your server configuration and/or things like reverse-proxy configurations when backing up your mailcow installation. Remember, the script will backup the following regardless of this file's contents:
+
+- mailcow directory (whatever directory contains *mailcow.conf*)
+- mailcow SQL database
+- the following mailcow volumes:
+  - vmail
+  - rspamd
+  - postfix
+  - redis
+  - crypt
+
+If you want to skip processing this file, simply comment-out the related configuration key in *backup.details*:
+
+```ini
+#borgXtraListPath=...
+```
+
+If you want to use a different file to list additional locations, simply update the entry in *backup.details* to point to that file. Bear in mind that the structure of that file must still be as indicated above:
+
+```ini
+borgXtraListPath='/path/to/your/xtraLocations.list'
+```