aboutsummaryrefslogtreecommitdiff
path: root/roles/mysql_backup/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'roles/mysql_backup/README.md')
-rw-r--r--roles/mysql_backup/README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/roles/mysql_backup/README.md b/roles/mysql_backup/README.md
new file mode 100644
index 0000000..9ee05cf
--- /dev/null
+++ b/roles/mysql_backup/README.md
@@ -0,0 +1,18 @@
+# mysql_backup
+
+Archives SQL Database dumps in an encrypted BORG repo.
+
+compatible with kompetenzbolzen.stuff.mariadb configuration for databases
+
+Example config
+
+```
+---
+sql_backup:
+ borg_repo_dir: /var/backup/borg_mysql/
+ borg_repo_key: 'changeme'
+ keep_last: 3
+ keep_daily: 7
+ keep_weekly: 4
+ keep_monthly: 6
+```