2005-12-07 16:41:51 +00:00
|
|
|
--------------------------------------------------------------------------------
|
|
|
|
|
ccollect.sh, Nico Schottelius, 2005-12-07
|
|
|
|
|
--------------------------------------------------------------------------------
|
|
|
|
|
|
|
|
|
|
0. Runtime options
|
|
|
|
|
1. General configuration
|
|
|
|
|
2. Source configuration
|
|
|
|
|
|
2005-12-08 10:37:31 +00:00
|
|
|
--------------------------------------------------------------------------------
|
2005-12-07 16:41:51 +00:00
|
|
|
0. Runtime options
|
|
|
|
|
|
|
|
|
|
ccollect looks for its configuration in /etc/ccollect or, if set, in
|
2005-12-13 16:27:27 +00:00
|
|
|
the directory specified by $CCOLLECT_CONF
|
|
|
|
|
(use CCOLLECT_CONF=/your/config/dir ccollect.sh on the shell).
|
|
|
|
|
|
|
|
|
|
When you start ccollect, you have either to specify which intervall
|
|
|
|
|
to backup (daily, weekly, yearly; you can specify the names yourself, see below).
|
|
|
|
|
|
|
|
|
|
The intervall is used to specify how many backups to keep.
|
2005-12-07 16:41:51 +00:00
|
|
|
|
|
|
|
|
There are also some self explaining parameters you can pass to ccollect, simply use
|
|
|
|
|
"ccollect.sh --help" for info.
|
|
|
|
|
|
|
|
|
|
|
2005-12-08 10:37:31 +00:00
|
|
|
--------------------------------------------------------------------------------
|
2005-12-07 16:41:51 +00:00
|
|
|
1. General configuration
|
|
|
|
|
|
2005-12-13 16:27:27 +00:00
|
|
|
The general configuration can be found below $CCOLLECT_CONF/defaults or
|
|
|
|
|
/etc/ccollect/defaults. All options specified here are valid for
|
|
|
|
|
all source definitions, if the values are not overwritten in the source
|
|
|
|
|
configuration.
|
|
|
|
|
|
|
|
|
|
All configuration entries are plain-text files.
|
|
|
|
|
|
2005-12-07 16:41:51 +00:00
|
|
|
|
|
|
|
|
1.2. Intervall definition
|
|
|
|
|
|
2005-12-13 16:27:27 +00:00
|
|
|
The intervall definition can be found below $CCOLLECT_CONF/defaults/intervalls/ or
|
|
|
|
|
/etc/ccollect/defaults/intervalls.
|
|
|
|
|
|
|
|
|
|
Every file below this directory specifies an intervall. The name of the file is the
|
|
|
|
|
name of the intervall:
|
2005-12-07 16:41:51 +00:00
|
|
|
|
2005-12-08 10:37:31 +00:00
|
|
|
intervalls/<intervall name>
|
2005-12-07 16:41:51 +00:00
|
|
|
|
2005-12-13 16:27:27 +00:00
|
|
|
The content of this file should be a single line containing a number.
|
|
|
|
|
This number defines how many versions of this intervall to keep.
|
|
|
|
|
|
|
|
|
|
STOPPED HERE.
|
2005-12-08 10:37:31 +00:00
|
|
|
|
|
|
|
|
--------------------------------------------------------------------------------
|
2005-12-07 16:41:51 +00:00
|
|
|
2. Source configuration
|
|
|
|
|
|
2005-12-08 10:08:15 +00:00
|
|
|
Each source configuration exists below $CCOLLECT_CONF/sources/$name.
|
|
|
|
|
The name describes the source.
|
|
|
|
|
|
|
|
|
|
Each source has at least
|
|
|
|
|
|
|
|
|
|
- source (a text file containing the path to backup)
|
|
|
|
|
- destination (a link to the directory we should backup to)
|
|
|
|
|
|
|
|
|
|
Additionally a source may have the following files:
|
|
|
|
|
|
|
|
|
|
- verbose whether to be verbose
|
|
|
|
|
- exclude excludes for rsync. One exclude specification on each line
|
2005-12-13 16:27:27 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
--------------------------------------------------------------------------------
|
|
|
|
|
$CCOLLECT_CONF/
|
|
|
|
|
-> Directories, which are so called 'backup-definitions'
|
|
|
|
|
|
|
|
|
|
$dir/
|
|
|
|
|
source -> file with the source
|
|
|
|
|
destination -> link to the destination
|
|
|
|
|
exclude -> \n seperated
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
--------------------------------------------------------------------------------
|
|
|
|
|
source - a rsync compatible source (one liner)
|
|
|
|
|
|
|
|
|
|
For instance:
|
|
|
|
|
|
|
|
|
|
backup_user@foreign_host:/home/server/video
|
|
|
|
|
|
|
|
|
|
or
|
|
|
|
|
|
|
|
|
|
rsync://[USER@]HOST[:PORT]/SRC
|
|
|
|
|
|
|
|
|
|
Have a look at rsync(1).
|
|
|
|
|
|
|
|
|
|
--------------------------------------------------------------------------------
|
|
|
|
|
verbose - should we log verbose or silent
|
|
|
|
|
|
|
|
|
|
If this file exists in the source specification -v will be passed to rsync.
|
|
|
|
|
|
|
|
|
|
--------------------------------------------------------------------------------
|
|
|
|
|
exclude - a new line seperated list of paths to exclude
|
|
|
|
|
|
|
|
|
|
--------------------------------------------------------------------------------
|
|
|
|
|
destination - a link to the destination directory
|
|
|
|
|
|
|
|
|
|
--------------------------------------------------------------------------------
|
|
|
|
|
intervalls/ - subdirectory of source or defaults
|
|
|
|
|
|
|
|
|
|
Each file below this directory describe an intervalls.
|
|
|
|
|
--------------------------------------------------------------------------------
|
|
|
|
|
log - link to file we should log to
|
|
|
|
|
|
|
|
|
|
If a backup source exists (the cconfig dir exists) all logs for this
|
|
|
|
|
source will be written to this file. General errors and errors of
|
|
|
|
|
non existent or broken configuration will be logged to stderr.
|
|
|
|
|
|
|
|
|
|
I do not think it is senseful to have one logfile for all sources, as
|
|
|
|
|
the sources can be backuped in parallel and you would not be able to
|
|
|
|
|
distinguish the different log processes very good then.
|
|
|
|
|
|
|
|
|
|
If you REALLY REALLY REALLY want to have all in one logfile, simply
|
|
|
|
|
link all "log" entries to the same file, output will be appended.
|
|
|
|
|
--------------------------------------------------------------------------------
|
|
|
|
|
|
