diff --git a/README.md b/README.md index 3cfa11b4432f8fe4b678cea860fe91a59f962338..852edd888bb9958e000b8bae20ca50fce1c1c02b 100644 --- a/README.md +++ b/README.md @@ -74,7 +74,7 @@ then use the **root** user and follow these steps: ### database backup: set local backup target ### -Create a jobs/dirs.jon (copy the deliverers *.dist file) +Create a **jobs/dirs.job** (copy the deliverers *.dist file) cd jobs cp dirs.job.dist dirs.job @@ -86,7 +86,9 @@ There are 2 defaults: keep-days = 7 **dir-localdumps** -{string} + +{string} + The target directory for local dumps. It is used by * the database dump scripts @@ -98,7 +100,9 @@ Below that one a directory for the service will be generated; inside that one th /var/iml-backup/mysql/mydatabase__20190827-2300.sql.gz **keep-days** + {integer} + The number of days how long to keep dumps locally. Remark: @@ -111,3 +115,56 @@ If you have local Mysql daemon or Pgsql you can test it by starting # show written files find /var/iml-backup + +### Define local directories to backup ### + +Edit **jobs/dirs.job** again. + +There are a few include definitions: + + # ---------------------------------------------------------------------- + # directory list to transfer + # without ending "/" + # missing directories on a system will be ignored + # ---------------------------------------------------------------------- + include = /etc + include = /var/log + include = /home + +... and excludes + + # ---------------------------------------------------------------------- + # excludes + # see duplicity ... added as -exclude-regex parameter + # ---------------------------------------------------------------------- + + # exclude = .*\.(swp|tmp) + + # mac file + # exclude = \.DS_Store + + # all subdirs containing "cache/", i.e. any/path/zend-cache/[file] + # exclude = cache/.* + + +**include** + +{string} + +Multiple entries are allowed. Each defines a starting directory that is backed up recursive. + +Do not use a trailing slash "/". + +Each include line creates ist own backup volume on the backup target: One duplicity backup command will be started per include. + +An include for the database dumps is not needed - it will be added automatically. + +Missing directories on a system will be ignored and does NOT throw an error. So you can write a "general" single config and deploy all servers. + +**exclude** + +{string} + +Multiple entries are allowed. Each defines a regex that is applied to all include items. This could have an negative impact. I suggest not to define an exclude - only if it is needed because of huge wasted space. + +TODO: advanced stuff ... There is a possibility for directory based include and exclude rules.