From 84746ec3774f121a8373e31c45753bd6fea002de Mon Sep 17 00:00:00 2001
From: "Hahn Axel (hahn)" <axel.hahn@iml.unibe.ch>
Date: Mon, 31 May 2021 11:20:33 +0200
Subject: [PATCH] added readme in plugn dirs

---
 plugins/localdump/readme.md | 26 ++++++++++++++++++++++++++
 plugins/transfer/readme.md  | 17 +++++++++++++++++
 2 files changed, 43 insertions(+)
 create mode 100644 plugins/localdump/readme.md
 create mode 100644 plugins/transfer/readme.md

diff --git a/plugins/localdump/readme.md b/plugins/localdump/readme.md
new file mode 100644
index 0000000..45a6512
--- /dev/null
+++ b/plugins/localdump/readme.md
@@ -0,0 +1,26 @@
+# Help plugins/localdump/
+
+Here are database plugins that can dump and restore types of databases.
+They will be sourced by [APPDIR]/localdump.sh and cannot started directly.
+
+* couchdb2.sh - couchdb 2+3 - using cloudant
+* couchdb.sh - couchdb1 - using a bash script
+* ldap.sh (*) - openLdap - experimantal
+* mysql.sh (*) - Mysql/ Mariadb
+* pgsql.sh (*) - PostgreSql - using pg_dump
+* sqlite.sh - Sqlite sqlite3
+
+(*) If ever possible we use a zero config method. This plugin detects locally installed binaries
+and running processes of a given name to run a database backup or not.
+
+See settings in `[APPDIR]/jobs/dirs.job`:
+
+```text
+dir-localdumps = /var/iml-backup
+keep-days = 7
+```
+
+dir-localdumps configures the target base directory for dumps. Below are subdirectories for the database type.
+In those are the dumps containing name of database scheme and a timestamp. All dumps are gzip compressed.
+
+keep-days contains an integer for the days to keep database dumps locally. Older dumps will be removed.
diff --git a/plugins/transfer/readme.md b/plugins/transfer/readme.md
new file mode 100644
index 0000000..73e015c
--- /dev/null
+++ b/plugins/transfer/readme.md
@@ -0,0 +1,17 @@
+# Help plugins/transfer/
+
+Here are plugins for backup tools that can backup and restore files and directories.
+
+* duplicity.sh - Duplicity
+* restic.sh - Restic
+
+See `[APPDIR]/jobs/transfer.job` to configure them.
+
+## Duplicity
+
+Website: <http://duplicity.nongnu.org>
+
+## Restic
+
+Website: <https://restic.net/>
+Docs: <https://restic.readthedocs.io/en/stable/>
-- 
GitLab