I'm in the process of implementing Scalix and (like lots of people here) I was disappointed with the backup and restore options, especially for single users. I've had enough problems with LVM snapshots that I don't trust them for my production backups, and the technote for ISS and SUR just made my head hurt. With that in mind I've spent the past day or so working on backup/restore scripts for my scalix install and I thought I'd post them here in the hope that someone else would be able to use them, or, better yet, improve on them. I haven't quite finished the restore script, but the backup script is in a workable state. Ive tested this multiple times on my semi-production Scalix 10.0 server, but I make no guarantees on its use.
Before using it, you'll need to edit the variable section at the top of the file to match your setup (at minimum, you'll need to specify your mailnode) . Running the script with the '-h' option should give instructions on passing command arguments.
This script will create the following folder structure for storing backups
Code: Select all
$BACKUP_DIR/
|----------------users/
| |----------------[mailnode]
| |---------userfile.gz
| |---------userfile2.gz
|
|-----------------[rsync of scalix data]
Code: Select all
#!/bin/sh
###############################################################################
# ombackup:
# a backup script for scalix mail servers
#
# This script is used to backup Scalix mail servers; it exports each
# user to a gzip compressed file using the 'omcpoutu' command, then
# duplicates the scalix data directory using rsync.
#
# Before using this program you should set the values of the variables
# below to match your server/preferences.
#
# For detailed descriptions of the available command line switches,
# execute the program with the -h flag.
#
#
# Copyright (C) 2006 Jon Allie <jon@jonallie.com>
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
#
#
###############################################################################
### useful variables
MAILNODE=""
BACKUP_DIR=/backup
SCALIX_DIR=/var/opt/scalix
SCALIX_BIN=/opt/scalix/bin
LOGFILE=/tmp/ombackup.log
USERFILE=/tmp/userfile.$$
DATE=`date +%Y%m%d`
### function declarations
function usage
{
printf $"
Usage: ombackup [-h] [-b backup dir] [-d scalix data dir] [-s scalix bin dir]
[-l logfile] [-u user file] [-m mailnode]
ombackup comes with ABSOLUTELY NO WARRANTY. This is free software, and you
are welcome to redistribute it under certain conditions. See the GNU
General Public Licence for details.
ombackup is a shell script to perform both user level and system level backups
of a Scalix mail server. User mailboxes are backed up via the 'omcpoutu' utility
and are stored in a configurable backup directory in a subdirectory named the
same as the mailnode being backed up. Systems level backups are performed by
copying the whole Scalix data dir (usually /var/opt/scalix) to a backup directory
using rysnc.
Most options can be configured by setting the values of the variables in the script
or can be passed to the script at runtime
Options:
-h : print this message and exit
-m <mailnode> : mailnode to dump users from
-b <backup dir> : backup directory. This directory will store both the user and
system level backups. User backups are stored in a subdirectory
under this directory users/<mailnode>/<userfile>.
-d <scalix dir> : scalix data dir. Defaults to /var/opt/scalix
-s <bin dir> : scalix bin dir. Contains scalix utility binaries. Defaults to
/opt/scalix/bin
-l <logfile> : path to a logfile for logging backup actions.
-u <userfile> : userfile. This file is created during the user mailbox
backup. Defaults to /tmp/userfile.[pid]
Copyright (C) 2006 by Jon Allie <jon@jonallie.com>\n\n"
exit ${1:-0}
}
function log_it
{
echo "[ `date` ]: $*" >>$LOGFILE
}
function echo_and_log
{
echo $*
log_it $*
}
function clean_up
{
echo_and_log "Cleaning up temporary files"
[ -f $USERFILE ] && rm -f $USERFILE
}
function exit_with_error
{
echo_and_log "Error: $*"
clean_up
exit 1
}
function pre_check
{
# look for scalix directories
for dir in $SCALIX_BIN $SCALIX_DIR
do
[ -d $dir ] || exit_with_error "A required Scalix directory $dir doesn't exist."
done
# make sure that the $BACKUP_DIR structure exists, try to create it if not.
for dir in $BACKUP_DIR $BACKUP_DIR/users $BACKUP_DIR/users/$MAILNODE
do
if [ ! -d $dir ]
then
echo_and_log "$dir doesn't exist: creating it"
mkdir $dir || exit_with_error "Unable to create required directory $dir"
fi
done
}
function dump_users
{
# build userfile
$SCALIX_BIN/omshowu -m $MAILNODE|cut -f1 -d'/' >$USERFILE
[ "$?" != "0" ] && exit_with_error "Unable to build userfile $USERFILE from mailnode $MAILNODE"
# loop over userfile and create backups. Use 'while read' instead of 'for' because of spaces in names
while read sc_username
do
nospaces=`echo $sc_username|sed -e 's/[ \.]//g'` # create a version of the username with spaces removed to use in the filename
backup_file="$BACKUP_DIR/users/$MAILNODE/${nospaces}-${DATE}-mail.gz"
$SCALIX_BIN/omcpoutu -n "$sc_username/$MAILNODE" -f - |gzip >$backup_file
if [ "$?" != "0" ]
then
echo_and_log "Error: unable to complete backup operation for $sc_username ot $backup_file"
else
echo_and_log "Success: backed up $sc_username to $backup_file"
fi
done < $USERFILE
}
function sync_files
{
echo_and_log "Beginning rsync of $SCALIX_DIR to $BACKUP_DIR"
rsync -av --delete $SCALIX_DIR $BACKUP_DIR/ >>$LOGFILE
if [ "$?" != "0" ]
then
exit_with_error "Rsync operation of $SCALIX_DIR to $BACKUP_DIR did not complete successfully"
else
echo_and_log "Completed rsync of $SCALIX_DIR to $BACKUP_DIR"
fi
}
# process command line arguments
# -h : show help
# -b <dir> : backup directory
# -l <file> : log file
# -u <userfile> : userfile
# -m <mailnode> : main mailnode
# -d <dir> : location of the scalix data dir
# -s <dir> : location of the scalix bin dir
while getopts hb:l:u:m:s: opt
do
case "$opt" in
h) usage ;;
b) BACKUP_DIR=$OPTARG ;;
l) LOGFILE=$OPTARG ;;
u) USERFILE=$OPTARG ;;
m) MAILNODE=$OPTARG ;;
d) SCALIX_DIR=$OPTARG ;;
s) SCALIX_BIN=$OPTARG ;;
\?) usage ;;
esac
done
# validate that all required options are set
for x in "$LOGFILE" "$BACKUP_DIR" "$MAILNODE" "$SCALIX_DIR" "$SCALIX_BIN" "$USERFILE"
do
if [ -z "$x" ]
then
echo "A required parameter is missing: please check your command arguments"
usage 1
fi
done
# initialize the logfile
>$LOGFILE
# call pre_check function to verify backup directory structure
pre_check
# shutoff remote client connections
echo_and_log "Shutting down remote client interface"
$SCALIX_BIN/omoff -d 0 rci
[ "$?" != "0" ] && exit_with_error "Unable to halt remote client interface"
# call dump_users function to make backups of user mailboxes
dump_users
echo_and_log "Stopping scalix services"
/etc/init.d/scalix stop
[ "$?" != "0" ] && exit_with_error "Unable to halt scalix services"
# call sync_files function to make a backup of the $SCALIX_DIR
sync_files
# restart scalix services
echo_and_log "Starting Scalix services"
/etc/init.d/scalix start
[ "$?" != "0" ] && exit_with_error "Error restarting scalix services"
# explicily call the clean_up function to erase leftover files
clean_up
# exit successfully
echo_and_log "All operations complete"
exit 0
