diff --git a/doc/INSTALL b/doc/INSTALL deleted file mode 100644 index 82d4808..0000000 --- a/doc/INSTALL +++ /dev/null @@ -1,5 +0,0 @@ --------------------------------------------------------------------------------- -ccollect.sh, Nico Schottelius, 2005-12-08 --------------------------------------------------------------------------------- - -Simply copy it to a directory in your $PATH. diff --git a/doc/REQUIREMENTS b/doc/REQUIREMENTS deleted file mode 100644 index c622283..0000000 --- a/doc/REQUIREMENTS +++ /dev/null @@ -1,12 +0,0 @@ --------------------------------------------------------------------------------- -ccollect.sh, Nico Schottelius, 2005-12-06 (updated: 2005-12-07) -Requirements --------------------------------------------------------------------------------- - -ccollect needs the following packages: - - - a bourne shell (/bin/sh) compatible shell - - bc - - cp with support for hard links (cp -al is used) - - rsync - - ssh if you want to use rsync over ssh diff --git a/doc/configuration b/doc/configuration deleted file mode 100644 index 626a366..0000000 --- a/doc/configuration +++ /dev/null @@ -1,187 +0,0 @@ --------------------------------------------------------------------------------- -Configuration of ccollect.sh -Nico Schottelius, 2005-12-07 --------------------------------------------------------------------------------- - - -0. Runtime options -1. General configuration -1.2. Intervall definition -2. Source configuration -2.1. Detailled description of "source" -2.2. Detailled description of "verbose" -2.3. Detailled description of "exclude" -2.4. Detailled description of "destination" -2.5. Detailled description of "intervalls/" - - --------------------------------------------------------------------------------- -0. Runtime options - -ccollect looks for its configuration in /etc/ccollect or, if set, in -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. - -There are also some self explaining parameters you can pass to ccollect, simply use -"ccollect.sh --help" for info. - - --------------------------------------------------------------------------------- -1. General configuration - -The general configuration can be found below $CCOLLECT_CONF/defaults or -/etc/ccollect/defaults. All options specified here are generally valid for -all source definitions. Though the values can be overwritten in the source -configuration. - -All configuration entries are plain-text (use UTF-8 if you use -non ASCII characters) files. - - -1.2. Intervall definition - -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: - - intervalls/ - -The content of this file should be a single line containing a number. -This number defines how many versions of this intervall to keep. - -Example: - - [10:23] zaphodbeeblebrox:ccollect-0.2% ls -l conf/defaults/intervalls/ - insgesamt 12 - -rw-r--r-- 1 nico users 3 2005-12-08 10:24 daily - -rw-r--r-- 1 nico users 3 2005-12-08 11:36 monthly - -rw-r--r-- 1 nico users 2 2005-12-08 11:36 weekly - [10:23] zaphodbeeblebrox:ccollect-0.2% cat conf/defaults/intervalls/* - 28 - 12 - 4 - - This means to keep 28 daily backups, 12 monthly backups and 4 weekly. - --------------------------------------------------------------------------------- -2. Source configuration - -Each source configuration exists below $CCOLLECT_CONF/sources/$name or -/etc/ccollect/sources/$name. - -The name you choose for the subdirectory describes the source. - -Each source has at least the following files: - - - source (a text file containing the rsync compatible 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 (passes -v to rsync) - - exclude exclude list for rsync. One exclude specification on each line. - -Example: - [10:47] zaphodbeeblebrox:ccollect-0.2% ls -l conf/sources/testsource2 - insgesamt 12 - lrwxrwxrwx 1 nico users 20 2005-11-17 16:44 destination -> /home/nico/backupdir - -rw-r--r-- 1 nico users 62 2005-12-07 17:43 exclude - drwxr-xr-x 2 nico users 4096 2005-12-07 17:38 intervalls - -rw-r--r-- 1 nico users 15 2005-11-17 16:44 source - [10:47] zaphodbeeblebrox:ccollect-0.2% cat conf/sources/testsource2/exclude - openvpn-2.0.1.tar.gz - nicht_reinnehmen - etwas mit leerzeichenli - [10:47] zaphodbeeblebrox:ccollect-0.2% ls -l conf/sources/testsource2/intervalls - insgesamt 4 - -rw-r--r-- 1 nico users 2 2005-12-07 17:38 daily - [10:48] zaphodbeeblebrox:ccollect-0.2% cat conf/sources/testsource2/intervalls/daily - 5 - [10:48] zaphodbeeblebrox:ccollect-0.2% cat conf/sources/testsource2/source - /home/nico/vpn - - -2.1. Detailled description of "source" - - 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). - -2.2. Detailled description of "verbose" - - verbose - should we log verbose or silent - - If this file exists in the source specification -v will be passed to rsync. - -Example: - [11:35] zaphodbeeblebrox:ccollect-0.2% touch conf/sources/testsource1/verbose - - -2.3. Detailled description of "exclude" - - exclude - a new line seperated list of paths to exclude - -Example: - - [11:35] zaphodbeeblebrox:ccollect-0.2% cat conf/sources/testsource2/exclude - openvpn-2.0.1.tar.gz - nicht_reinnehmen - etwas mit leerzeichenli - - -2.4. Detailled description of "destination" - - destination - a link to the destination directory - -Example: - [11:36] zaphodbeeblebrox:ccollect-0.2% ls -l conf/sources/testsource2/destination - lrwxrwxrwx 1 nico users 20 2005-11-17 16:44 conf/sources/testsource2/destination -> /home/nico/backupdir - -2.5. Detailled description of "intervalls/" - - intervalls/ - subdirectory of source or defaults - - Each file below this directory describe an intervalls. - -Example: - [11:37] zaphodbeeblebrox:ccollect-0.2% ls -l conf/sources/testsource2/intervalls/ - insgesamt 8 - -rw-r--r-- 1 nico users 2 2005-12-07 17:38 daily - -rw-r--r-- 1 nico users 3 2005-12-14 11:33 yearly - [11:37] zaphodbeeblebrox:ccollect-0.2% cat conf/sources/testsource2/intervalls/* - 5 - 20 - --------------------------------------------------------------------------------- -NOT IMPLEMENTED BELOW THE FOLLIWNG LINE --------------------------------------------------------------------------------- - -2.6. Detailled description of "log" - - 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. diff --git a/doc/configuration.example b/doc/configuration.example deleted file mode 100644 index 7f694ea..0000000 --- a/doc/configuration.example +++ /dev/null @@ -1,53 +0,0 @@ -This is how I setup a backup host: - -srwali01:~# mkdir /etc/ccollect -srwali01:~# mkdir -p /etc/ccollect/defaults/intervalls/ -srwali01:~# echo 28 > /etc/ccollect/defaults/intervalls/taeglich -srwali01:~# echo 52 > /etc/ccollect/defaults/intervalls/woechentlich -srwali01:~# cd /etc/ccollect/ -srwali01:/etc/ccollect# mkdir sources -srwali01:/etc/ccollect# cd sources/ -srwali01:/etc/ccollect/sources# ls -srwali01:/etc/ccollect/sources# mkdir local-root -srwali01:/etc/ccollect/sources# cd local-root/ -srwali01:/etc/ccollect/sources/local-root# echo / > source -srwali01:/etc/ccollect/sources/local-root# cat > exclude << EOF -> /proc -> /sys -> /mnt -> EOF -srwali01:/etc/ccollect/sources/local-root# ln -s /mnt/hdbackup/local-root destination -srwali01:/etc/ccollect/sources/local-root# mkdir /mnt/hdbackup/local-root -srwali01:/etc/ccollect/sources/local-root# ccollect.sh taeglich local-root -/o> ccollect.sh: Beginning backup using intervall taeglich -/=> Beginning to backup "local-root" ... -|-> 0 backup(s) already exist, keeping 28 backup(s). - - -# After that, add some more sources -srwali01:~# cd /etc/ccollect/sources -srwali01:/etc/ccollect/sources# mkdir windos-wl6 -srwali01:/etc/ccollect/sources# cd windos-wl6/ -srwali01:/etc/ccollect/sources/windos-wl6# echo /mnt/win/SYS/WL6 > source -srwali01:/etc/ccollect/sources/windos-wl6# ln -s /mnt/hdbackup/wl6 destination -srwali01:/etc/ccollect/sources/windos-wl6# mkdir /mnt/hdbackup/wl6 -srwali01:/etc/ccollect/sources/windos-wl6# cd .. -srwali01:/etc/ccollect/sources# mkdir windos-daten -srwali01:/etc/ccollect/sources/windos-daten# echo /mnt/win/Daten > source -srwali01:/etc/ccollect/sources/windos-daten# ln -s /mnt/hdbackup/windos-daten destination -srwali01:/etc/ccollect/sources/windos-daten# mkdir /mnt/hdbackup/windos-daten - -# Now add some remote source -srwali01:/etc/ccollect/sources/windos-daten# cd .. -srwali01:/etc/ccollect/sources# mkdir srwali03 -srwali01:/etc/ccollect/sources# cd srwali03/ -srwali01:/etc/ccollect/sources/srwali03# cat > exclude << EOF -> /proc -> /sys -> /mnt -> /home -> EOF -srwali01:/etc/ccollect/sources/srwali03# echo 'root@10.103.2.3:/' > source -srwali01:/etc/ccollect/sources/srwali03# ln -s /mnt/hdbackup/srwali03 destination -srwali01:/etc/ccollect/sources/srwali03# mkdir /mnt/hdbackup/srwali03 - diff --git a/doc/saving.space b/doc/saving.space deleted file mode 100644 index 8cb141a..0000000 --- a/doc/saving.space +++ /dev/null @@ -1,17 +0,0 @@ -Hard links are such a nice thing ;-) - -[10:53] srsyg01:sources% du -sh ~/backupdir -4.6M /home/nico/backupdir -[10:53] srsyg01:sources% du -sh ~/backupdir/* -4.1M /home/nico/backupdir/daily.2005-12-08-10:52.28456 -4.1M /home/nico/backupdir/daily.2005-12-08-10:53.28484 -4.1M /home/nico/backupdir/daily.2005-12-08-10:53.28507 -4.1M /home/nico/backupdir/daily.2005-12-08-10:53.28531 -4.1M /home/nico/backupdir/daily.2005-12-08-10:53.28554 -4.1M /home/nico/backupdir/daily.2005-12-08-10:53.28577 - -srwali01:/etc/ccollect/sources# du -sh /mnt/hdbackup/wl6/ -186M /mnt/hdbackup/wl6/ -srwali01:/etc/ccollect/sources# du -sh /mnt/hdbackup/wl6/* -147M /mnt/hdbackup/wl6/taeglich.2005-12-08-14:42.312 -147M /mnt/hdbackup/wl6/taeglich.2005-12-08-14:45.588