diff --git a/docs/10_Features.md b/docs/10_Features.md index 7aa95b1215eed91359de68213a56afec47430b46..e61798465bfc236e8bed779d8fca4acfc84d7c69 100644 --- a/docs/10_Features.md +++ b/docs/10_Features.md @@ -144,7 +144,7 @@ See [Hooks](50_Hooks/_index.md) ## Restic ## -* creates one initial full backup - and then never again. Then it makes incremental backups. +* creates one initial full backup - and then never again (then it starts incremental backups only). * encrypts data * deduplicates files * delete backups by rules to keep a count of hourly, daily, weekly, mothly, yearly backups diff --git a/docs/40_Usage/10_Backup.md b/docs/40_Usage/10_Backup.md index 290950dbb39c2b5a4d3e88ef3ff0ceee23808e11..d9f8b989b26ca804cb7b34d474831dcf2a66f088 100644 --- a/docs/40_Usage/10_Backup.md +++ b/docs/40_Usage/10_Backup.md @@ -1,4 +1,20 @@ -``` +## Typical Usage + +This is the main script to start a backup. The script *backup.sh* is the one to add as a cronjob. It will start + +* the dumps of local databases +* the file transfer to an external repository + +Both of these steps can be started seperately (see next pages). + +## Typical Usage + +* on Linux: as a non root user use sudo `sudo ./backup.sh` +* on MS Windows: start it as user `./backup.sh`. Or double click it in a file manager (e.g. Explorer). The first time it asks what program should be used to open *.sh files - select the bash.exe ornavigate to it. + +## Help + +```txt # ./backup.sh -? ___ ___ ___ ___ _______ __ diff --git a/docs/40_Usage/20_Database.md b/docs/40_Usage/20_Database.md index 35ced633e166d039d1b44930780291f8228f8dca..daf43898a4235a267500ae86c84276cdea17573a 100644 --- a/docs/40_Usage/20_Database.md +++ b/docs/40_Usage/20_Database.md @@ -1,6 +1,9 @@ -## Make database dumps ## +## Make database dumps -To create backup dumps we use `./localdump.sh` +To create backup database dumps without transfer of local directory to a backup target use `sudo ./localdump.sh`. +Backup dumps will be stored as gzip files into `/var/iml-backup/[service]`. + +## Help ```text SYNTAX: @@ -20,7 +23,7 @@ ldap mysql pgsql sqlite -```text +``` If you have local Mysql daemon or Pgsql you can test it by starting @@ -43,7 +46,7 @@ To dump schemes of a specific database type add the name of a known service. sudo ./localdump.sh mysql ``` -## Structure in the backup folder ## +## Structure in the backup folder In the database dump folder is a subdir per service `/var/iml-backup/[service]`. @@ -54,7 +57,7 @@ All dumps are gzip compressed. At the end of a backup task with localdump.sh older files older than *keep-days* will be deleted from `/var/iml-backup/[service]`. -### Backup sqlite ### +### Backup sqlite Keep in mind that you need to define sqlite databases in jobs/backup-dbfiles.job first. @@ -70,10 +73,11 @@ In the folder /var/iml-backup/sqlite/ it creates 2 files per database * the gzip compressed dump (filename is full path with replacing `/` by `_`) * a .META file that contains the original full path for restore -## Restore database dumps ## +## Restore database dumps Remark: -To make a database restore its dump must be located at this directory. +To make a database restore its dump must be located at this directory: +`/var/iml-backup/[service]` The value keepdays contains number of days how long to keep dumps locally. If your dump to restore is older than this given range then you need diff --git a/docs/40_Usage/30_Filetransfer.md b/docs/40_Usage/30_Filetransfer.md index aeac6cc4a32a8091e62ea983f9b069dbfa73752b..f127b808ede2388464555388ef2db84c73898ead 100644 --- a/docs/40_Usage/30_Filetransfer.md +++ b/docs/40_Usage/30_Filetransfer.md @@ -1,4 +1,8 @@ -``` +## Transfer files ## + +To transfer local directories to a backup repository use `sudo ./transfer.sh`. + +```txt > ./transfer.sh -h ___ ___ ___ ___ _______ __