Compare revisions

lib/easydialog

lib/parseini

lib/tools

lib/vserver

man/Makefile

src/Makefile

src/backupninja

 - console-based wizard (ninjahelper) makes it easy to create

   backup action configuration files

 - passwords are never sent via the command line to helper programs

 - works with [Linux-Vservers](http://linux-vserver.org/)

The following backup types are supported:

           }

3. Look at the existing helpers to see how they are written. Try to re-use

   functions, such as the dialog functions that are defined in `easydialog.sh`,

   or the vserver functions defined in `lib/vserver`.

   functions, such as the dialog functions that are defined in `easydialog.sh`.

4. Test, re-test, and test again. Try to break the helper by going backwards,

   try to think like someone who has no idea how to configure your handler

operation therefore reducing the costs. The boto Python interface to Amazon

Web Services is needed to use duplicity with S3 (Debian package: `python-boto`).

Vservers

--------

If you are using [Linux-Vservers](http://linux-vserver.org/) there are some

special capabilities that different handlers have to make vserver

backups easier.

Set the variable `vservers` to be `yes` in `/etc/backupninja.conf` and see the

example configuration files for each handler to configure the vserver specific

variables.

Additional vserver variables that can be configured in `/etc/backupninja.conf`,

but they probably don't need to be changed:

 - `VSERVERINFO` (default: `/usr/sbin/vserver-info`)

 - `VSERVER` (default: `/usr/sbin/vserver`)

 - `VROOTDIR` (default: `$VSERVERINFO info SYSINFO |grep vserver-Rootdir | awk '{print $2}'`)

.sh configuration files

-----------------------

# default value for 'when'

when = everyday at 01:00

# if running vservers, set to yes

vservers = no

# programs paths

# SLAPCAT=/usr/sbin/slapcat

# LDAPSEARCH=/usr/bin/ldapsearch

# GZIP=/bin/gzip

# GZIP_OPTS='--rsyncable'

# RSYNC=/usr/bin/rsync

# VSERVERINFO=/usr/sbin/vserver-info

# VSERVER=/usr/sbin/vserver

# VROOTDIR=/var/lib/vservers

include = /var/lib/dpkg/status

include = /var/lib/dpkg/status-old

## If vservers = yes in /etc/backupninja.conf then the following variables can

## be used:

## vsnames = all | <vserver1> <vserver2> ... (default = all)

## vsinclude = <path>

## vsinclude = <path>

## ...

## Any path specified in vsinclude is added to the include list for each vserver

## listed in vsnames (or all if vsnames = all, which is the default).

##

## For example, vsinclude = /home will backup the /home directory in every

## vserver listed in vsnames. If you have 'vsnames = foo bar baz', this

## vsinclude will add to the include list /vservers/foo/home, /vservers/bar/home

## and /vservers/baz/home.

## Vservers paths are derived from $VROOTDIR.

# files to exclude from the backup

exclude = /home/*/.gnupg

exclude = /var/cache/backupninja/duplicity

#

# compress = < yes | no > (default = yes)

# if yes, compress the sqldump output. 

#

# vsname = <vserver> (no default)

# what vserver to operate on (only used if vserver = yes 

# in /etc/backupninja.conf), if you do not specify a vsname the 

# host will be operated on

# 

# NB: databases = all doesn't seem to work with hotcopy = yes 

# when vsname is specified, I would like to know how to fix this.

### backupninja PostgreSQL config file ###

# vsname = <vserver> (no default)

# what vserver to operate on, only used if vserver = yes in /etc/backupninja.conf

# if you do not specify a vsname the host will be operated on

# Note: if operating on a vserver, $VROOTDIR will be prepended to backupdir.

# backupdir = <dir> (default: /var/backups/postgres)

# where to dump the backups

# keep = 60

## A few notes about includes and excludes:

## 1. include, exclude and vsinclude statements support globbing with '*'

## 1. include and exclude statements support globbing with '*'

## 2. Symlinks are not dereferenced. Moreover, an include line whose path

##    contains, at any level, a symlink to a directory, will only have the

##    symlink backed-up, not the target directory's content. Yes, you have to

include = /var/lib/dpkg/status

include = /var/lib/dpkg/status-old

## If vservers = yes in /etc/backupninja.conf then the following variables can

## be used:

## vsnames = all | <vserver1> <vserver2> ... (default = all)

## vsinclude = <path>

## vsinclude = <path>

## ...

## Any path specified in vsinclude is added to the include list for each vserver

## listed in vsnames (or all if vsnames = all, which is the default).

##

## For example, vsinclude = /home will backup the /home directory in every

## vserver listed in vsnames. If you have 'vsnames = foo bar baz', this

## vsinclude will add to the include list /vservers/foo/home, /vservers/bar/home

## and /vservers/baz/home.

## Vservers paths are derived from $VROOTDIR.

## files to exclude from the backup

exclude = /home/*/.gnupg

exclude = /var/cache/backupninja/duplicity

# Mandatory options are uncommented with sugested values

# Other options are commented out with their default values

#

# Note: You dont need to manually specify vservers using "include = /vservers".

#       They're automatically backuped if vserver is set to "yes" on you backupninja.conf.

[general]

exclude = exclude_folder1

exclude = exclude_folder2

# exlude some vserver from backup

# this is used only if vservers = yes on backupninja.conf

exclude_vserver = excluded_vserver1

exclude_vserver = excluded_vserver2

# ssh command line (remote only)

#ssh = ssh

## in /usr/share/doc/subversion/examples now if you wish to use

## it instead

# HOTBACKUP = /usr/lib/subversion/hot-backup.py

## the name of the vserver containing svn, if using vservers

# vsname =

# note: to backup your BIOS, you need the program 'flashrom' installed, and your

# mainboard needs to be supported, see http://flashrom.org/Supported_hardware#Supported_mainboards

# bios = no

# If vservers = yes in /etc/backupninja.conf then the following variables can

# be used:

# vsnames = all | <vserver1> <vserver2> ... (default = all)

   set +o noglob

}

do_dup_vserver() {

   # choose the vservers to backup (into $selected_vservers)

   choose_one_or_more_vservers "$dup_title"

   [ $? = 0 ] || return 1

   set -o noglob

   # choose the files to backup

   REPLY=

   while [ -z "$REPLY" ]; do

      formBegin "$dup_title - vservers: vsincludes (backup these directories from every selected vserver)"

         [ -z "$dup_vsincludes" ] && dup_vsincludes="$dup_default_includes"

         for i in $dup_vsincludes; do

            formItem include "$i"

         done

         formItem include ""

         formItem include ""

         formItem include ""

         formItem include ""

         formItem include ""

         formItem include ""

         formItem include ""

         formItem include ""

      formDisplay

      [ $? = 0 ] || return 1

      dup_vsincludes="$REPLY"

   done

   set +o noglob

}

do_dup_excludes() {

   set -o noglob

   formBegin "$dup_title: excludes"

   set +o noglob

}

do_dup_src() {

   choose_host_or_vservers_or_both "$dup_title"

   [ $? = 0 ] || return 1

   case $host_or_vservers in

      'host')

         do_dup_host_includes

         [ $? = 0 ] || return 1

         ;;

      'vservers')

         do_dup_vserver

         [ $? = 0 ] || return 1

         ;;

      'both')

         do_dup_host_includes

         [ $? = 0 ] || return 1

         do_dup_vserver

         [ $? = 0 ] || return 1

         ;;

      *)

         return 1

         ;;

   esac

   do_dup_excludes

   [ $? = 0 ] || return 1

   _src_done="(DONE)"

   setDefault dest

}

do_dup_dest() {

   local replyconverted

[source]

# A few notes about includes and excludes:

# 1. include, exclude and vsinclude statements support globbing with '*'

# 1. include and exclude statements support globbing with '*'

# 2. Symlinks are not dereferenced. Moreover, an include line whose path

#    contains, at any level, a symlink to a directory, will only have the

#    symlink backed-up, not the target directory's content. Yes, you have to

# files to include in the backup

EOF

   if [ "$host_or_vservers" == host -o "$host_or_vservers" == both ]; then

   set -o noglob

   for i in $dup_includes; do

      echo "include = $i" >> $next_filename

   done

   set +o noglob

   fi

   cat >> $next_filename <<EOF

# If vservers = yes in /etc/backupninja.conf then the following variables can

# be used:

# vsnames = all | <vserver1> <vserver2> ... (default = all)

# vsinclude = <path>

# vsinclude = <path>

# ...

# Any path specified in vsinclude is added to the include list for each vserver

# listed in vsnames (or all if vsnames = all, which is the default).

#

# For example, vsinclude = /home will backup the /home directory in every

# vserver listed in vsnames. If you have 'vsnames = foo bar baz', this

# vsinclude will add to the include list /vservers/foo/home, /vservers/bar/home

# and /vservers/baz/home.

# Vservers paths are derived from $VROOTDIR.

EOF

   if [ "$host_or_vservers" == vservers -o "$host_or_vservers" == both ]; then

      set -o noglob

      echo -e "vsnames = $selected_vservers\n" >> $next_filename

      for i in $dup_vsincludes; do

         echo "vsinclude = $i" >> $next_filename

      done

      set +o noglob

   fi

   # excludes

   cat >> $next_filename <<EOF

# files to exclude from the backup

   _adv_done=

   dup_includes=

   dup_excludes=

   dup_vsincludes=

   dup_incremental=yes

   dup_increments=30

   dup_keep=60

setsection source

getconf include

getconf vsnames all

getconf vsinclude

getconf exclude

setsection dest

### SANITY CHECKS ##############################################################

[ -n "$desturl" -o -n "$destdir" ]  || fatal "The destination directory (destdir) must be set when desturl is not used."

[ -n "$include" -o -n "$vsinclude" ]  || fatal "No source includes specified"

[ -n "$include" ]  || fatal "No source includes specified"

[ -n "$password" ] || fatal "The password option must be set."

if [ -n "$signkey" -a -n "$encryptkey" -a "$signkey" != "$encryptkey" ]; then

   [ -n "$signpassword" ] || fatal "The signpassword option must be set because signkey is different from encryptkey."

   fi

fi

### VServers

# If vservers are configured, check that the ones listed in $vsnames do exist.

usevserver=no

if [ $vservers_are_available = yes ]; then

   if [ "$vsnames" = all ]; then

      vsnames="$found_vservers"

   else

      if ! vservers_exist "$vsnames" ; then

            fatal "At least one of the vservers listed in vsnames ($vsnames) does not exist."

      fi

   fi

   if [ -n "$vsinclude" ]; then

      info "Using vservers '$vsnames'"

      usevserver=yes

   fi

else

   [ -z "$vsinclude" ] || warning 'vservers support disabled in backupninja.conf, vsincludes configuration lines will be ignored'

fi

### See if we can login on $desthost

if [ "$testconnect" == "yes" ]; then

   if [ -n "$desturl" ]; then

done

IFS=$SAVEIFS

# vsincludes

if [ $usevserver = yes ]; then

   for vserver in $vsnames; do

      SAVEIFS=$IFS

      IFS=$(echo -en "\n\b")

      for vi in $vsinclude; do

         str="${vi//__star__/*}"

         str="$VROOTDIR/$vserver$str"

         execstr_source="${execstr_source} --include '$str'"

      done

      IFS=$SAVEIFS

   done

fi

set +o noglob

### EXECUTE ####################################################################

HELPERS="$HELPERS mysql:mysql_database_backup"

do_mysql_vserver() {

   choose_one_vserver "$mysql_title"

   [ $? = 0 ] || return 1

   mysql_vsname="vsname = $REPLY"

}

do_mysql_databases() {

   REPLY=

   while [ -z "$REPLY" ]; do

EOF

if [ $host_or_vservers == vservers ]

   then

      cat >> $next_filename <<EOF

#

# vsname = <vserver> (no default)

# vsname indicates which vserver to operate on, this is only used if

# vserver is set to yes in /etc/backupninja.conf

# NOTE: if you do not specify a vsname the host will be operated on

# alsoNOTE: if operating on a vserver, $VROOTDIR will be

# prepended to backupdir.

EOF

   echo -e "$mysql_vsname\n" >> $next_filename

fi

   echo -e $@ >> $next_filename

   chmod 600 $next_filename

   # Global variables

   mysql_title="MySQL action wizard"

   # backup the host system or a Vserver?

   choose_host_or_one_vserver "$mysql_title"

   [ $? = 0 ] || return 1

   if [ $host_or_vservers == vservers ]

   then

      do_mysql_vserver

      [ $? = 0 ] || return 1

   fi

   # backupdir

   if [ $host_or_vservers == vservers ]

   then

      inputBox "$mysql_title" "Directory where to store the backups:`echo \"\n(Relative to chosen vserver's root directory)\"`" "/var/backups/mysql"

   else

   inputBox "$mysql_title" "Directory where to store the backups" "/var/backups/mysql"

   fi

   [ $? = 1 ] && return

   mysql_backupdir="backupdir = $REPLY"