X-Git-Url: https://arthur.barton.de/gitweb/?a=blobdiff_plain;f=README.md;h=db48806cbbfc2979a5882c97b1253b5f2043f7e0;hb=b3f41b5e2846a3eb5d61cecb2dd2c5686c48bded;hp=d5c6f5420f445148bdf5e48e897d58d9c2263e7a;hpb=9f83e770e8ccdf43fa3b1e7c2281c4fe61252e08;p=backup-script.git diff --git a/README.md b/README.md index d5c6f54..db48806 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Backup Script A script for cloning systems using rsync. -Copyright (c)2008-2015 Alexander Barton +Copyright (c)2008-2016 Alexander Barton ## Usage @@ -14,8 +14,9 @@ Usage: `backup-script [] [ [ [...]]]` Options: -- `-p`, `--progress`: Show progress, see rsync(1). - `-n`, `--dry-run`: Test run only, don't copy any data. +- `-p`, `--progress`: Show progress, see rsync(1). +- `-t TAG`, `--tag TAG`: Only run jobs with tag TAG (see "tags" variable below). When no *system* is given, all defined systems are backed up. @@ -23,7 +24,7 @@ When no *system* is given, all defined systems are backed up. Backup all systems and mail the report to "root". -Usage: `backup-script-wrapper` +Usage: `backup-script-wrapper []` ### backup-status @@ -35,20 +36,38 @@ Options: - `-q`: *quick mode*, don't calculate backup sizes. +### backup-audit + +Show "relevant" differences in system configuration between backup generations. + +Usage: `backup-audit [-q] [-v] [ [ [...]]]` + +Options: + +- `-q`: *quiet mode*, don't show systems without "relevant" changes. +- `-v`: *verbose mode*, show all checks that are run. + ## Configuration -All default configuration variables are read from `/etc/backup-script.conf` or -from `/etc/backup-script.d/backup-script.conf` (deprecated). The individual -systems are configured using individual files in `/etc/backup-script.d/`, one -for each system to backup (files ending in `*.sh` are skipped, as well as -files named `backup-script.conf`). Please avoid spaces and other "special" -characters! +All default configuration variables are read from the first file found of this +list: `/usr/local/etc/backup-scrupt.conf`, `/etc/backup-script.conf` or +from `/etc/backup-script.d/backup-script.conf` (deprecated). + +All systems which should be backed-up are configured using individual files +in the configuration directory, which is `/usr/local/etc/backup-script.d/` or +`/etc/backup-script.d/` by default (whichever is found first), and can be +specified using the `conf_d` variable in the main configuration file. + +The must be one file for each system to backup (files ending in `*.sh` are +skipped, as well as files named `backup-script.conf`). Please avoid spaces and +other "special" characters! The filename is used as hostname for the system by +default, but this can be overwritten using the `system` configuration variable. Variables in `backup-script.conf` must be prefixed with `default_` to define default values for all systems. -All defaults can be overwritten in individual system configuration files. +All defaults can be overwritten in the individual system configuration files. For example: @@ -65,6 +84,25 @@ System host name. Default: file name. *Note:* There is no `default_system` variable! +### [default_]backup_type + +Backup type to use. Default: `rsync`. + +- `rsync`: system backup using rsync(1). + Use `source_root` to specify the root directory to save. + +- `scp`: file backup using scp(1). + Use `files` to specify the files to copy. + +- `disabled`: job is disabled and will not be run. This becomes accounted as + "success" in the summary and exit code of the backup script. + +Please note that neither `ssh_args_add`, `rsync_args_add`, `compress`, nor any +"exclude" parameters are supported when using the "scp" backup type! And There +"scp" backup type never _deletes_ files from the backup store; so if you reduce +the list of files to backup, old files will still be kept, because they were +already saved in an older generation (but no longer updated). + ### [default_]user Remote user. Default: `root`. @@ -76,6 +114,11 @@ Remote *root* directory, must end with a slash ("/") character! Default: "/". When saving the whole (remote) system ("/"), default excludes are set up automatically, which exclude standard system directories like /sys and /proc. +### [default_]files + +Space separated list of files to copy when using the "scp" `backup_type`. +Default: "running-config". + ### [default_]target Local backup directory. The backup of each system is stored in a folder named @@ -96,9 +139,16 @@ Additional parameters for `rsync`. Default: none. Additional (exclude) parameters for `rsync`. Default: none. +*Deprecated! Use "exclude_dirs_add" instead!* + +### [default_]exclude_dirs_add + +Additional directory path names to exclude from the backup. Use full path names +separated by spaces. Default: none. + ### [default_]compress -Enable (1) or disable (0) compression. Default: 1 (on). +Enable (1) or disable (0) rsync transfer compression. Default: 1 (on). ### [default_]ping @@ -131,6 +181,22 @@ Supported file systems are: The latest snapshot is always reachable using a symlink named `latest` inside the system directory. +### [default_]io_timeout + +The maximum I/O timeout in seconds. If no data is transferred for the specified +time then rsync will abort. Default: 1800 (30 minutes). + +### [default_]tags + +Comma-separated list of tags of this job. All uppercase tag names are reserved +and become set automatically on runtime: + +- NONE: Jobs with no other tags at all. +- ALL: Matches all jobs, regardless of their tags (see `-t`/`--tags` option). +- LOCAL: All jobs running on "localhost". + +Default: NONE. + ### [default_]job_pre_exec Optional script to execute before `rsync` starts. Default: none. @@ -151,3 +217,15 @@ definition files are automatically mapped to the new backup-script variables: * source -> source_root * pre_exec -> job_pre_exec * post_exec -> job_post_exec + + +## Exit codes + +- 1: Unspecific Error! +- 2: Usage information has been shown. +- 3: Can't read system definition +- 4: PID-file exists! +- 5: Pre-exec command failed! +- 6: There have been systems with errors! +- 7: Not all jobs were run! +- 9: Aborted (CTRL-C)!