0.-Overview.md

@@ -0,0 +1,18 @@
+# mailcow backup using borgbackup
+
+This script automates backing up your Mailcow installation using borgbackup and a remote ssh-capable storage system.  I suggest using rsync.net since they have great speeds and a special pricing structure for borgbackup/attic users ([details here](https://www.rsync.net/products/attic.html)).
+
+This script automates the following tasks:
+
+- Optionally copies a 503 error page to your webserver so users know when your server is unavailable due to backups being performed. The 503 file is removed when the backup is completed so users can login again
+  - implementation of this feature is dependant on your particular webserver, this script only copies the file for your webserver to find
+- Dumps the Mailcow mySQL database and adds it to the backup
+- Handles stopping and re-starting mail-flow containers (postfix and dovecot) so everything is in a consistent state during the backup
+- Allows you to specify additional files you want backed up
+- Allows you to specify files/directories to exclude from your backups
+- Runs 'borg prune' to make sure you are trimming old backups on your schedule
+- Creates a clear, easy to parse log file so you can keep an eye on your backups and any errors/warnings
+
+I've tried to explain all features as clearly as I can in this wiki but, if you have any questions or suggestions for improvements, please file an issue!
+
+Hope this script helps you manage your backups a little easier :-)