Backup and Restore
MailStore Server supports two methods to perform a full backup of the email archive including all user settings: the MailStore integrated backup feature and the use of external backup software.
Which method suits the needs of your business best depends on your preferences as well as your system environment. In smaller environments without a designated administrator, with the integrated backup feature no extensive configuration needs to be performed in order to make sure that the backup is successfully completed and that all pertinent data and directories are included. However, to be able to transfer the data (for example to off-site backup locations), it is necessary to integrate the backed up data into another backup solution.
When using external backup software a successful backup needs a few preparations. On the plus side, MailStore Server data can be integrated into existing backup strategies without having to perform a separate system backup.
Which Data Must be Backed Up?
To ensure a successful and frictionless restore at any time, the following data must be included in the backup:
- Master Database (MailStoreMaster.fdb), which contains all configuration settings, like profiles, users, etc.
- Encryption Key File for Master Database (
- If destination for audit log is set to Integrated Audit Log: Audit log files (
- Archive Stores
Each archive store in MailStore consists of three components:
- Folder information and meta data (
- Email headers and contents (
- Full text index (
Please note: As the configuration of the MailStore Server service itself (located within MailStore's program files folder), contains information specific to the current configuration of the computer where MailStore Server is installed, it it not recommended to backup and restore the service configuration data. Instead, manually reconfigure these settings after re-installing MailStore Server on a new machine. Pay special attention to the Audit Log Destination and VSS Writer settings.
Notes on Consistency
While folder information and meta data and email headers and contents are to be treated as one unit that requires consistency, full text indexes can be reconstructed if needed. In environments with higher security demands, and depending on the backup target, it may be advisable to exclude the unencrypted full text indexes from the backup for the costs have having to fully rebuild them in case of a restore.
Notes on Integrity
Irregardless of which backup method is used, only regular maintenance does ensure that the backed up data can be successfully restored. Please refer to Maintenance and Repair for further details.
Using the MailStore Integrated Backup Feature
MailStore has built-in technology to perform a full backup of the archive.
The backup contains all archived emails and all settings such as profiles, users and privileges. Restoring such a backup is sufficient to completely reinstate the original archive without having to perform any further configurations.
Important Notice: When using the integrated backup feature, MailStore only supports internal archive stores. If you are using external archive stores, you need external backup software to perform a full backup.
To create a complete database backup, proceed as follows:
- Log on to MailStore Client as MailStore administrator.
- Click on Administrative Tools > Management API > Jobs.
- Click on Storage and select Create Backup.
- Enter the target directory.
- Please note: If the target directory is a network share, make sure that the MailStore Server service has access to that share. The path to the network share has to be entered in UNC notation, e.g. \\computer\sharename. Further information is available in the Using Network Attached Storage (NAS) article.
- The search indexes can be excluded optionally.
- Please note: This option can be set so that administrators which have access to the backup files cannot access the unencrypted search index files. When restoring backups that do not include search indexes, the search indexes have to be rebuilt.
- Define the start time for the backup in the Schedule section.
- Click OK to finish the creation of the backup job.
If necessary, run the job manually in order to verify that MailStore Server is able to create a backup without errors.
When running the backup function for the first time, all files will be copied, after that only changed files will be copied. To achieve rotation of backups (e.g. daily, weekly), schedule multiple backup jobs with different target directories.
Please note: The archive cannot be accessed while a backup is in progress. Trying to access the archive will generate the error message The server is currently not available due to maintenance.
Using External Backup Software
Backup of Internal Archive Stores
When backing up internal archive stores with an external backup software, attention must be payed to the consistency of data which mainly depends on the backup method. The following sections summarize the pros and cons of the different methods.
File Based Backups
While file based backups solutions are good for backing up independent files, they are usually not suitable for creating consistent backups of a MailStore Server as its data is spread across multiple rapidly changing files.
In order to create consistent backups with file based backup tools, it is required to either freeze and thaw MailStore Server via net pause mailstoreserver and net continue mailstoreserver commands or to shutdown and restart the MailStore Server via net stop mailstoreserver and net start mailstoreserver commands.
As MailStore Server must remain shut down for the time of the backup, this typically results in downtimes during which MailStore is neither able to archive new email nor provide end user access to the archived data.
When using Volume Shadow Copy Services (VSS) or other methods of creating snapshots on storage level, it is necessary to ensure that all files are closed before the snapshot is created.
The MailStore Server service provides external backup software using Microsoft Volume Shadow Copy Service with a so-called Volume Shadow Copy Service Writer (VSS Writer). The external backup software can use it to create consistent backups of the MailStore master database and all internal archive stores. Whether this method succeeds, however, largely depends on the backup software and the storage that is used. The VSS Writer has to be activated in the MailStore Server Service Configuration.
To verify if the appropriate VSS events were initiated in MailStore during a backup, open the application protocol in the Windows event viewer and search for the following events:
- A backup session has been started.
- The archive has been frozen as a reaction on the OnPrepareSnapshot event.
- The archive has been thawn as a reaction on the OnThaw event.
- The backup session has been shut down.
If these events cannot be found in the application protocol, no consistent backup using Volume Shadow Copy Service was performed. In that case the backup software needs to prepare MailStore Server for the snapshots. This can be done with the methods detailed in the File Based Backups section.
For how to execute commands before and after performing snapshots, please consult your backup software's documentation.
Full Virtual Machine Snapshots
Some backup solutions are highly integrated into virtualization solutions and can create and backup/replicate full snapshots of virtual machines. These types of snapshots not only contain the current state of the hard disks but also of the current main memory. Thus full virtual machine snapshots can be considered as being consistent.
Other Backup or Replication Methods
For questions regarding any other type of backup solutions such as block level replication, continuous backup etc please contact the vendor's support to find out whether their software is able to create consistent backups of whole directory structures.
Backup of External Archive Stores
External archive stores allow you to store folder information and meta data in an SQL database. Email headers and contents can be stored optionally in an SQL database as well. Search index files have to be stored in the file system.
To backup external archive stores, the distributed data has to be backed up simultaneously. Stop the MailStore Server service, backup the SQL databases and the files that are stored in the file system with appropriate backup tools, then restart the MailStore Server service when done.
You can stop and start the MailStore Server service by executing the net stop mailstoreserver and net start mailstoreserver commands.
In case the unencrypted search index files are not backed up, you can rebuild them after restoring the backup.
This section describes how a database backup of the entire email archive, which was created using the integrated backup feature, can be restored.
A database backup which was created using the integrated backup feature and that includes the search index files contains all archived emails and program settings such as users and privileges. Restoring such a backup is sufficient to completely reinstate the original archive without having to perform any further configurations.
Automatic Restore of a Database Backup
MailStore creates two files in the backup destination when creating a backup which allow an automatic full restore of the archive in its original storage location. Should the backup be restored to a different storage location or if only parts (i.e. a single archive store) should be restored, the restore procedure must be performed manually (see next section).
An operative installation of MailStore Server is required to restore a database backup. Please proceed as follows:
- Stop the MailStore Server Service and delete the empty archive that has been created during installation in C:\MailArchive.
- Next execute the file restore.bat from the backup directory.
- Note: Is the file located on a network share, e.g. \\nas01\MailStoreBackup, you first have to crate a mapped drive of that share, e.g. N:, and then execute the file on that drive.
- Follow the on-screen instructions. Carefully check the output for possible error messages.
- Run the MailStore Server Service Configuration tool from the MailStore program folder in the Windows start menu.
- Click Browse... under General > Master Database and select the restore directory which contains the MailStoreMaster.fdb file. Confirm the selection by clicking OK.
- Finally start the MailStore Server Service again.
In case the backup includes the search index files, no further steps are necessary after using the automatic restore. Otherweise the search indexes have to be rebuild.
Manual Restore of a Database Backup
An operative installation of MailStore Server is required to restore a database backup. Please proceed as follows:
- Copy the database backup to a local hard drive on the computer or to a respective network share.
- Start the MailStore Server Service Configuration. It is located in the MailStore Server program folder that can be accessed through the Windows Start menu.
- Below Master Database, click on Browse... and select the backup directory containing the file MailStoreMaster.fdb.
- Click on OK to confirm.
- At the bottom of the window, click on Restart Service to save the new settings.
- When creating the backup, the folder names of the archive store may have changed. Please use the Storage Locations Management to adjust the paths to the archive stores or rename the folders in the file system accordingly. The mapping of the backup's archive store folder names to their original names can be found in the restore.csv file that has been created with the backup.
In case the backup includes the search index files, no further steps are necessary after the restore. Otherweise the search indexes have to be rebuilt.