Sebastian Vendt (Manaslu) 1 год назад
Родитель
Сommit
78e7076d13
1 измененных файлов с 5 добавлено и 3 удалено
  1. 5 3
      Readme.md

+ 5 - 3
Readme.md

@@ -1,8 +1,10 @@
 # Remote Backup Manager
-This script uses rsync to backup files from any source (e.g. Remote) to any target (usually the host, the script runs on). On completion (either successful or on error), the scripts sends a mail with the output of rsync to a specified mail address. 
+This script uses rsync to backup files from any source (e.g. Remote) to any target (usually the host, the script runs on). 
+On completion (either successful or on error), the scripts sends a mail with the output of rsync to a specified mail address. 
 
 ## Dependencies
 sendmail needs to be installed and configured for sending backup notifications.
+rsync needs to be installed on all remote sources/targets and on the host which runs the script.
 
 ## Installation
 Pull the repository to a location of your choice on the host.
@@ -19,7 +21,7 @@ Host sebastianvendt.de
 ```
 
 Create a configuration file, which holds the source and destination paths for the backup jobs as well as several configuration variables. 
-An example configuration file with all *required* variables is given in the following. 
+An example configuration file with all **required** variables is given in the following. 
 ```
 #Backup directories
 declare -A backup_folders 
@@ -45,7 +47,7 @@ The script requires as argument the path to the configuration file
 ```
 
 ## Automate the backup job
-To automate your backup, add the script with the path to your configuration file to your crontab-file. I suggest to run it in a detached screen session. 
+To automate your backup, add the script with the path to your configuration  to your crontab-file. I suggest to run it in a detached screen session. 
 You can then always reattach to the screen and check the current status for long backup jobs. 
 ```
 10 2 * * * sebastian screen -d -m /home/sebastian/scripts/backup/getRemoteBackup.sh /home/sebastian/scripts/backup/backupFolders.conf