2 # backupninja handler to do incremental backups using
3 # rsync and hardlinks, based on
5 # http://www.mikerubel.org/computers/rsync_snapshots/
7 # feedback: rhatto at riseup.net | gpl
8 # lot of enhancements grabbed from "rsnap" handler by paulv at bikkel.org
14 # log = rsync log file
15 # partition = partition where the backup lives
16 # fscheck = set to 1 if fsck should run on $partition after the backup is made
17 # read_only = set to 1 if $partition is mounted read-only
18 # mountpoint = backup partition mountpoint or backup main folder
19 # backupdir = folder relative do $mountpoint where the backup should be stored
20 # days = number of backup increments (min = 5)
21 # lockfile = lockfile to be kept during backup execution
22 # nicelevel = rsync command nice level
23 # enable_mv_timestamp_bug = set to "yes" if your system isnt handling timestamps correctly
27 # from = local or remote
28 # host = source hostname or ip, if remote backup
29 # testconnect = when "yes", test the connection for a remote source before backup
30 # include = include folder on backup
31 # exclude = exclude folder on backup
32 # ssh = ssh command line (remote only)
33 # rsync = rsync program
34 # rsync_options = rsync command options
35 # exclude_vserver = vserver-name (valid only if vservers = yes on backupninja.conf)
36 # numericids = when set to 1, use numeric ids instead of user/group mappings on rsync
37 # compress = if set to 1, compress data on rsync (remote source only)
38 # bandwidthlimit = set a badnwidth limit in kbps (remote source only)
39 # remote_rsync = remote rsync program (remote source only)
42 # initscripts = absolute path where scripts are located
43 # service = script name to be stoped at the begining of the backup and started at its end
45 # You can also specify some system comands if you don't want the default system values:
50 # touch = touch command
54 # You dont need to manually specify vservers using "include = /vservers".
55 # They are automatically backuped if vserver is set to "yes" on you backupninja.conf.
58 # config file evaluation
68 getconf log /var/log/backup/rsync.log
78 getconf enable_mv_timestamp_bug no
83 getconf testconnect no
85 getconf rsync_options "-av --delete"
91 getconf exclude_vserver
94 getconf bandwidthlimit
95 getconf remote_rsync rsync
101 # function definitions
105 if [[ "$2" < 4 ]]; then
106 error "Rotate: minimum of 4 rotations"
110 if [ -d $1.$2 ]; then
111 $nice $mv /$1.$2 /$1.tmp
114 for ((n=`echo "$2 - 1" | bc`; n >= 0; n--)); do
115 if [ -d $1.$n ]; then
116 dest=`echo "$n + 1" | bc`
117 $nice $mv /$1.$n /$1.$dest
122 if [ -d $1.tmp ]; then
123 $nice $mv /$1.tmp /$1.0
127 $nice $cp -alf /$1.1/. /$1.0
132 function move_files {
134 ref=$tmp/makesnapshot-mymv-$$;
142 backupdir="$mountpoint/$backupdir"
144 # does $backupdir exists?
146 if [ ! -d "$backupdir" ]; then
147 error "Backupdir $backupdir does not exist"
151 # setup number of increments
153 if [ -z "$days" ]; then
156 keep="`echo $days - 1 | bc -l`"
161 if [ ! -z "$lockfile" ]; then
162 $touch $lockfile || warning "Could not create lockfile $lockfile"
167 if [ ! -z "$nicelevel" ]; then
168 nice="nice -n $nicelevel"
175 if [ "$from" == "remote" ] && [ "$testconnect" == "yes" ]; then
176 debug "$ssh -o PasswordAuthentication=no $user@$host 'echo -n 1'"
177 result=`ssh -o PasswordAuthentication=no $user@$host 'echo -n 1'`
178 if [ "$result" != "1" ]; then
179 fatal "Can't connect to $host as $user."
181 debug "Connected to $srchost successfully"
185 # rsync options for local sources
187 if [ "$from" == "local" ]; then
189 rsync_local_options="$rsync_options"
191 if [ ! -z "$numericids" ]; then
192 rsync_local_options="$rsync_local_options --numeric-ids "
197 # rsync options for remote sources
199 if [ "$from" == "remote" ]; then
201 rsync_remote_options="$rsync_options --rsync-path=$remote_rsync"
203 if [ "$compress" == "1" ]; then
204 rsync_remote_options="$rsync_remote_options --compress"
207 if [ ! -z "$bandwidthlimit" ]; then
208 rsync_remote_options="$rsync_remote_options --bwlimit=$bandwidthlimit"
211 if [ ! -z "$numericids" ]; then
212 rsync_remote_options="$rsync_remote_options --numeric-ids"
219 if [ $enable_mv_timestamp_bug == "yes" ]; then
225 for path in $exclude; do
226 EXCLUDES="$EXCLUDES --exclude=$path"
231 if [ ! -z "$service" ]; then
232 for daemon in $service; do
233 info "Stopping service $daemon..."
234 $initscripts/$daemon stop
238 echo "Starting backup at `date`" >> $log
240 # mount backup destination folder as read-write
242 if [ "$read_only" == "1" ] || [ "$read_only" == "yes" ]; then
243 if [ -d "$mountpoint" ]; then
244 mount -o remount,rw $mountpoint
246 error "Could not mount $mountpoint"
252 # add vservers to included folders
254 if [ "$vservers_are_available" == "yes" ]; then
256 # sane permission on backup
257 mkdir -p $backupdir/$VROOTDIR
258 chmod 000 $backupdir/$VROOTDIR
260 for candidate in $found_vservers; do
261 candidate="`basename $candidate`"
262 found_excluded_vserver="0"
263 for excluded_vserver in $exclude_vserver; do
264 if [ "$excluded_vserver" == "$candidate" ]; then
265 found_excluded_vserver="1"
269 if [ "$found_excluded_vserver" == "0" ]; then
270 include="$include $VROOTDIR/$candidate"
275 # the backup procedure
277 for SECTION in $include; do
279 section="`basename $SECTION`"
281 if [ ! -d "$backupdir/$SECTION/$section.0" ]; then
282 mkdir -p $backupdir/$SECTION/$section.0
285 info "Rotating $backupdir/$SECTION/$section..."
286 echo "Rotating $backupdir/$SECTION/$section..." >> $log
287 rotate $backupdir/$SECTION/$section $keep
288 info "Syncing $SECTION on $backupdir/$SECTION/$section.0..."
290 if [ "$from" == "local" ]; then
291 debug $rsync $rsync_local_options $EXCLUDES /$SECTION/ $backupdir/$SECTION/$section.0/
292 $nice $rsync $rsync_local_options $EXCLUDES /$SECTION/ $backupdir/$SECTION/$section.0/ >> $log
293 if [ "$?" != "0" ]; then
294 warning "Rsync error when trying to transfer $SECTION"
296 elif [ "$from" == "remote" ]; then
297 if [ -z "$user" ] || [ -z "$host" ]; then
298 error "Config file error: either user or host was not specified"
301 debug $nice $rsync $rsync_remote_options $EXCLUDES -e "$ssh" $user@$host:/$SECTION/ $backupdir/$SECTION/$section.0
302 $nice $rsync $rsync_remote_options $EXCLUDES -e "$ssh" $user@$host:/$SECTION/ $backupdir/$SECTION/$section.0 >> $log
303 if [ "$?" != "0" ]; then
304 warning "Rsync error when trying to transfer $SECTION"
308 error "Invalid source $from"
312 $touch $backupdir/$SECTION/$section.0
316 # remount backup destination as read-only
318 if [ "$read_only" == "1" ] || [ "$read_only" == "yes" ]; then
319 mount -o remount,ro $mountpoint
322 # check partition for errors
324 if [ "$fscheck" == "1" ] || [ "$fscheck" == "yes" ]; then
327 warning "Could not umount $mountpoint to run fsck"
329 $nice $fsck -v -y $partition >> $log
336 if [ ! -z "$service" ]; then
337 for daemon in $service; do
338 info "Starting service $daemon..."
339 $initscripts/$daemon start
343 # removes the lockfile
345 if [ ! -z "$lockfile" ]; then
346 $rm $lockfile || warning "Could not remove lockfile $lockfile"
349 echo "Finnishing backup at `date`" >> $log