Full Server Backup and Restore of “open source version”

[zakai]

Does anyone know the answer to the question here, which is: How does one backup/restore a single user?

[phoenix]

Originally Posted by zakai

Does anyone know the answer to the question here, which is: How does one backup/restore a single user?

One method: restore your backup, find the user account then inject them into the server with zmlmtpinject?

[mauibay]

Originally Posted by mmarodin

This is a per-user full backup script (based on mubley's code, 2005), for Zimbra 5.x. Zimbra DB and LDAP are also included.
I've tested it on 5.0.12 version.

I don't want to use ...

/opt/zimbra/bin/zmmailbox -z -m user@domain.com getRestURL “//?fmt=tgz” > /tmp/account.tgz

... because with this backup job I could not restore single messages, but only full mailbox.

I hope it could be usefull for you!

#!/bin/sh
#--------

# Backup Zimbra Open Source 5.x
# by mm@rodin - 20090206

# Modify the following variables to suit your installation
export time=`date +%y%m%d`
export backup_dir=/opt/backup
export zimbra_dir=/opt/zimbra
export index_dir=$zimbra_dir/index
export store_dir=$zimbra_dir/store

# We need mysqldump.  If it doesn't exist,
# copy mysql and modify it to call mysqldump.
if [ ! -e $zimbra_dir/bin/mysqldump ]; then
   cp $zimbra_dir/bin/mysql $zimbra_dir/bin/mysqldump
   sed -i 's|/bin/mysql |/bin/mysqldump |g' $zimbra_dir/bin/mysqldump
fi

# Create the backup directory
mkdir -p $backup_dir

# Get a list of all accounts and execute
# the contents of the for-loop for each account.
for i in `$zimbra_dir/bin/zmprov gaa` ; do

# Beginning of for-loop

#  Use email address to get zimbra_id
   zimbraId=`$zimbra_dir/bin/zmprov ga $i |grep zimbraId |sed 's|zimbraId: ||g'`
   set $zimbraId

#  Use mysql to get number id
   zimbra_nr=`$zimbra_dir/bin/mysql -e "use zimbra; select id from mailbox where account_id = '$1'"`
   zimbra_nr=`echo $zimbra_nr | sed 's|id ||g'`

#  Check to make sure we got a valid number id
   if [ "$zimbra_nr" = "" ]; then
      echo $i has no mailbox.
   else

#     Set zimbraAccountStatus to "maintenance"
      $zimbra_dir/bin/zmprov ma $i zimbraAccountStatus maintenance

#     Marking user backup
      if [ ! -e $backup_dir/info-$zimbra_nr.txt ]; then
         echo "Zimbra ID:	$1" > $backup_dir/info-$zimbra_nr.txt
         echo "Mail address:	$i" >> $backup_dir/info-$zimbra_nr.txt
      fi

#     Backup index and store files
      tar -czf $backup_dir/$time-$zimbra_nr-data.tgz $zimbra_dir/index/0/$zimbra_nr $zimbra_dir/store/0/$zimbra_nr

#     Backup Mysql db
      $zimbra_dir/bin/mysqldump mboxgroup$zimbra_nr > $backup_dir/$time-$zimbra_nr.dump
      tar -czf $backup_dir/$time-$zimbra_nr.dump.tgz $backup_dir/$time-$zimbra_nr.dump
      rm -f $backup_dir/$time-$zimbra_nr.dump

#     Set zimbraAccountStatus to "active"
      $zimbra_dir/bin/zmprov ma $i zimbraAccountStatus active

#  End of if statement
   fi

# End of for-loop
done

# Backup Zimbra master database and LDAP accounts database
# First, set all accounts to maintenance.
for i in `$zimbra_dir/bin/zmprov gaa` ; do
   $zimbra_dir/bin/zmprov ma $i zimbraAccountStatus maintenance
done

$zimbra_dir/bin/mysqldump zimbra  > $backup_dir/$time-zimbra.dump
tar -czf $backup_dir/$time-zimbra.dump.tgz $backup_dir/$time-zimbra.dump
rm -f $backup_dir/$time-zimbra.dump

$zimbra_dir/bin/zmslapcat > $backup_dir/$time-zimbra.ldap
tar -czf $backup_dir/$time-zimbra.ldap.tgz $backup_dir/$time-zimbra.ldap
rm -f $backup_dir/$time-zimbra.ldap

# Setting all accounts to active mode.
for i in `$zimbra_dir/bin/zmprov gaa` ; do
   $zimbra_dir/bin/zmprov ma $i zimbraAccountStatus active
done

# Backup complete

This looks promising for my needs, but can you describe with some detail the restore procedure? It's fairly clear to me on the conceptual level what this script is doing, but I'd appreciate an example of the steps needed to to a full restore from the backup files this script produces.

[tiger2000]

Here's my steps and scripts for per-user backup/restore :

(please correct me if there's anything not correct)

Backup:
Run this script by : backup.sh filename
and you can put the user account into such filename.

backup.sh:

#!/bin/bash

if [ $# -ne 1 ]; then
   echo "Usage: $0 filename"
   exit 1
fi

domain="@my.domain"
backupdir="/root/backup/users"

echo "Start to backup => `date`"

if [ ! -d $backupdir ]; then
   echo "$backupdir not existing, create it now automatically"
   mkdir -p $backupdir
fi

cat $1 |
while read line; do
  echo -n "backup user : $line..."
  sudo -u zimbra /opt/zimbra/bin/zmmailbox -z -m $line$domain getRestURL "//?fmt=tgz" > $backupdir/$line.tgz
  if [ $? -eq 0 ]; then
     echo "OK [`du -h $backupdir/$line.tgz | awk '{print $1}'`]"
  else
     echo "Fail"
  fi

done

echo "Backup finish => `date`"

Restore:
Run this script by : restore.sh username {reset,skip}
e.g. restore.sh superman skip


restore.sh

#!/bin/bash

domain="@my.domain"
backupdir="/root/backup/users"

if [ $# -ne 2 ]; then
   echo "Usage: $0 account [reset, skip]"
   exit 1
fi

case "$2" in
        reset)
                OPTION="reset"
                ;;
        skip)
                OPTION="skip"
                ;;
        *)
                echo "Usage: $0 account [reset, skip]"
                exit 3
esac

echo "Start to restore => `date`"

echo -n "Check account [$1] ==> "
sudo -u zimbra /opt/zimbra/bin/zmprov ga $1$domain > /dev/null 2>&1
if [ $? -ne 0 ]; then
   echo "NO, [$1] not exist"
   exit 2
else
   echo "Yes, we have [$1]"
fi

echo -n "Check backup data for [$1] ==> "
if [ ! -e $backupdir/$1.tgz ]; then
   echo "No, no backup data for [$1]"
   exit 3
else
   echo "Yes, backup data for [$1] exists"
fi

echo -n "Start to restore user [$1] ==> "
sudo -u zimbra /opt/zimbra/bin/zmmailbox -z -m $1$domain postRestURL "//?fmt=tgz&resolve=$OPTION" $backupdir/$1.tgz

if [ $? -eq 0 ]; then
   echo "OK"
else
   echo "Fail"
fi

echo "Restore finish => `date`"

If you're going to backup ALL users in your system, then you can use this backupall.sh ;

#!/bin/bash

domain="@my.domain"
backupdir="/root/backup/users"

echo "Start to backup => `date`"

if [ ! -d $backupdir ]; then
   echo "$backupdir not existing, create it now automatically"
   mkdir -p $backupdir
fi

index=1
sudo -u zimbra /opt/zimbra/bin/zmprov gaa |
while read line; do
  echo -n "[$index]backup user : $line..."
  username=`echo $line | cut -d@ -f1`
  sudo -u zimbra /opt/zimbra/bin/zmmailbox -z -m $line getRestURL "//?fmt=tgz" > $backupdir/$username.tgz
  if [ $? -eq 0 ]; then
     echo "OK [`du -h $backupdir/$username.tgz | awk '{print $1}'`]"
  else
     echo "Fail"
  fi

  index=`expr $index + 1`
done

echo "Backup finish => `date`"

[phpasp]

Thank you very much!

[edelvall]

Does this script still requires to turn off Zimbra in order to run the backup/restore job?
Has somebody else done testing?

Thanks,

Ed

[marcos.gw]

I ran backup.sh ok
but I ran restore.sh and not ok

Start to restore => Seg Jun 1 04:23:42 BRT 2009
Check account [marcos] ==> Yes, we have [marcos]
Check backup data for [marcos] ==> Yes, backup data for [marcos] exists
Start to restore user [marcos] ==> ERROR: zclient.CLIENT_ERROR (file not found: /root/backup/users/marcos.tgz) (cause:java.io.FileNotFoundException
/root/backup/users/marcos.tgz (Permission denied)) Fail

[marcos.gw]

I changed my permissions and worked.

I have one more question.

Can I change backup.sh ( full to incremental ) ?

[tiger2000]

>Does this script still requires to turn off Zimbra in order to run the >backup/restore job?

No, you don't need to turn off Zimbra during backup, because it's a online dump for user's folders.

[tiger2000]

> Can I change backup.sh ( full to incremental ) ?

i'm not sure, because I don't whether there's any parameter for 'getResturl' access. did you see that 'postResturl' (the restore script) did have several parameters which can be used for reset or skip.. *maybe* 'getResturl' also does, but i'm not sure.

perhaps someone who's more familiar with "zmmailbox with getRestUrl" can help here ?