IRedMail/FAQ/Backup

From iRedMail
(Difference between revisions)
Jump to: navigation, search
(= How to restore SQL databases)

Revision as of 19:49, 9 January 2014

Contents


Backup MySQL Databases

Backup with shell script

iRedMail ships a shell script to help backup MySQL databases: iRedMail-x.y.z/tools/backup_mysql.sh. You can always get the latest version from source code repo here: https://bitbucket.org/zhb/iredmail/src

Please read header of this file carefully before you execute it:

# Purpose:  Backup specified mysql databases with command 'mysqldump'.

###########################
# REQUIREMENTS
###########################
#
#   * Required commands:
#       + mysqldump
#       + du
#       + bzip2 or gzip     # If bzip2 is not available, change 'CMD_COMPRESS'
#                           # to use 'gzip'.
#

###########################
# USAGE
###########################
#
#   * It stores all backup copies in directory '/backup' by default, you can
#     change it in variable $BACKUP_ROOTDIR below.
#
#   * Set correct values for below variables:
#
#       BACKUP_ROOTDIR
#       MYSQL_USER
#       MYSQL_PASSWD
#       DATABASES
#       DB_CHARACTER_SET
#       COMPRESS
#       DELETE_PLAIN_SQL_FILE
#
#   * Add crontab job for root user (or whatever user you want):
#
#       # crontab -e -u root
#       1   4   *   *   *   bash /path/to/backup_mysql.sh
#   
#   * Make sure 'crond' service is running, and will start automatically when
#     system startup:
#
#       # ---- On RHEL/CentOS ----
#       # chkconfig --level 345 crond on
#       # /etc/init.d/crond status
#
#       # ---- On Debian/Ubuntu ----
#       # update-rc.d cron defaults
#       # /etc/init.d/cron status
#

###########################
# DIRECTORY STRUCTURE
###########################
#
#   $BACKUP_ROOTDIR             # Default is /backup
#       |- mysql/               # Used to store all backed up databases.
#           |- YEAR.MONTH/
#               |- YEAR.MONTH.DAY/
#                   |- DB.YEAR.MONTH.DAY.MIN.HOUR.SECOND.sql
#                               # Backup copy, plain SQL file.
#                               # Note: it will be removed immediately after
#                               # it was compressed with success and 
#                               # DELETE_PLAIN_SQL_FILE='YES'
#
#                   |- DB.YEAR.MONTH.DAY.HOUR.MINUTE.SECOND.sql.bz2
#                               # Backup copy, compressed SQL file.
#
#       |- logs/
#           |- YEAR.MONTH/
#               |- mysql-YEAR.MONTH.DAY.MIN.HOUR.SECOND.log     # Log file
#

How to restore SQL databases

You can simply restore SQL files dumped by above script.

WARNING: If you're restoring on a NEW iRedMail server, please do not restore database "mysql" exported from old server, it contains SQL usernames/passwords for Roundcube/Amavisd/Policyd/Cluebringer used on old server. New iRedMail server has the same SQL usernames, but different passwords. So please do not restore it.

Backup OpenLDAP Data

Backup with shell script

iRedMail ships a shell script to help backup OpenLDAP data: iRedMail-x.y.z/tools/backup_openldap.sh. You can always get the latest version from source code repo here: https://bitbucket.org/zhb/iredmail/src

Please read header of this file carefully before you execute it:

# Purpose:  Dump whole LDAP tree with command 'slapcat'.

###########################
# REQUIREMENTS
###########################
#
#   * Required commands:
#       + slapcat
#       + du
#       + bzip2 or gzip     # If bzip2 is not available, change 'CMD_COMPRESS'
#                           # to use 'gzip'.
#

###########################
# USAGE
###########################
#
#   * It stores all backup copies in directory '/backup' by default, you can
#     change it in variable $BACKUP_ROOTDIR below.
#
#   * Set correct values for below variables:
#
#       BACKUP_ROOTDIR
#       COMPRESS
#       DELETE_PLAIN_SQL_FILE
#
#   * Add crontab job for root user (or whatever user you want):
#
#       # crontab -e -u root
#       1   4   *   *   *   bash /path/to/backup_openldap.sh
#   
#   * Make sure 'crond' service is running, and will start automatically when
#     system startup:
#
#       # ---- On RHEL/CentOS ----
#       # chkconfig --level 345 crond on
#       # /etc/init.d/crond status
#
#       # ---- On Debian/Ubuntu ----
#       # update-rc.d cron defaults
#       # /etc/init.d/cron status
#

###########################
# DIRECTORY STRUCTURE
###########################
#
#   $BACKUP_ROOTDIR             # Default is /backup
#       |- ldap/                # Used to store all backed up copies.
#           |- YEAR.MONTH/
#               |- YEAR.MONTH.DAY/
#                   |- YEAR.MONTH.DAY.MIN.HOUR.SECOND.ldif
#                               # Backup copy, plain LDIF file.
#                               # Note: it will be removed immediately after
#                               # it was compressed with success and 
#                               # DELETE_PLAIN_SQL_FILE='YES'
#
#                   |- YEAR.MONTH.DAY.HOUR.MINUTE.SECOND.ldif.bz2
#                               # Backup copy, compressed LDIF file.
#
#       |- logs/
#           |- YEAR.MONTH/
#               |- ldap-YEAR.MONTH.DAY.MIN.HOUR.SECOND.log     # Log file
#

How to restore from LDIF file

Command "slapcat" will dump whole LDAP tree, so you can restore the whole tree with another command "slapadd".

Below example shows how to restore the whole LDAP tree on RHEL/CentOS 5.x.

  • Stop OpenLDAP server:
Terminal:
# /etc/init.d/ldap stop
  • Remove whole data in OpenLDAP data directory defined in LDAP config file "slapd.conf". For example:
File: /etc/openldap/slapd.conf
...
database    bdb
suffix      dc=iredmail,dc=org
directory   /var/lib/ldap/iredmail.org
...

So you should remove all files under directory "/var/lib/ldap/iredmail.org" except /var/lib/ldap/iredmail.org/DB_CONFIG.

  • Make sure OpenLDAP server is NOT running, then restore backup LDIF file with command "slapadd".
Terminal:
# slapadd -f /etc/openldap/slapd.conf -l /path/to/backup/backup.ldif
  • It's OK to start OpenLDAP server now, but it will report several errors like below:
Terminal:
# /etc/init.d/ldap start
Stopping slapd:                                            [  OK  ]
/var/lib/ldap/iredmail.org/mailMessageStore.bdb is not owned[WARNING]"
/var/lib/ldap/iredmail.org/objectClass.bdb is not owned by "[WARNING]
/var/lib/ldap/iredmail.org/mtaTransport.bdb is not owned by [WARNING]
/var/lib/ldap/iredmail.org/cn.bdb is not owned by "ldap"    [WARNING]
/var/lib/ldap/iredmail.org/domainName.bdb is not owned by "l[WARNING]
/var/lib/ldap/iredmail.org/ou.bdb is not owned by "ldap"    [WARNING]
/var/lib/ldap/iredmail.org/uid.bdb is not owned by "ldap"   [WARNING]
/var/lib/ldap/iredmail.org/enabledService.bdb is not owned b[WARNING]
/var/lib/ldap/iredmail.org/homeDirectory.bdb is not owned by[WARNING]
/var/lib/ldap/iredmail.org/domainGlobalAdmin.bdb is not owne[WARNING]p"
/var/lib/ldap/iredmail.org/sn.bdb is not owned by "ldap"    [WARNING]
/var/lib/ldap/iredmail.org/mail.bdb is not owned by "ldap"  [WARNING]
/var/lib/ldap/iredmail.org/accountStatus.bdb is not owned by[WARNING]
/var/lib/ldap/iredmail.org/givenName.bdb is not owned by "ld[WARNING]
Checking configuration files for slapd:  config file testing succeeded
                                                           [  OK  ]
Starting slapd:                                            [  OK  ]

You must set correct file permission on newly created bdb files immediately, then restart OpenLDAP service. It won't complain incorrect file permission any more:

Terminal:
# chown ldap:ldap /var/lib/ldap/iredmail.org/*.bdb
# /etc/init.d/ldap restart

IMPORTANT NOTE: If you're restoring LDIF data (exported on an old iRedMail server) to a new iRedMail server, you MUST login to phpLDAPadmin on new iRedMail server and reset passwords of below two DNs. Because they're hard-coded in many config files. For example, /etc/postfix/ldap/*.cf, /etc/dovecot/dovecot-ldap.conf.

  • cn=vmail,dc=xxx,dc=xxx
  • cn=vmailadmin,dc=xxx,dc=xxx

The new passwords you should use can be found in the root directory of iRedMail installation directory on NEW iRedMail server. for example, /root/iRedMail-0.8.1/iRedMail.tips. Below is the sample of the passwords in file iRedMail.tips:

File: iRedMail.tips
OpenLDAP:
    ...
    * LDAP bind dn (read-only): cn=vmail,dc=example,dc=com, password: py2BQwM0zoRM5nciK68AlP8dyu2Mq6               
    * LDAP admin dn (used for iRedAdmin): cn=vmailadmin,dc=example,dc=com, password: 9wr0mHeVYz2uaxSAGBLucVkOgYPSBB

Please login to phpLDAPadmin with cn=Manager,dc=xx,dc=xx on NEW iRedMail server to reset passwords of above two DNs. Of course you can find full LDAP dn and password of 'cn=Manager,dc=xx' in iRedMail.tips.

That's all.

Personal tools