Backup and Restore
Backup
Preliminary Considerations
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 Digital Linear Tape), it is necessary to integrate the backed up data into another system backup.
When using external backup software (e.g. Veeam, Windows Server Backup or Acronis True Image,) 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?
Each archive store in MailStore consists of three components:
- Folder information and meta data
- Email headers and contents
- Full text index
While folder information and meta data as well as email headers and contents are a 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.
In addition to the archive stores, the MailStore master database (MailStoreMaster.fdb) must be backed up as well because it contains all configuration settings such as users and profiles.
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 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.
Important Notice: When using the integrated backup feature, MailStore only supports standard archive stores. If you are using advanced archive stores, you need external backup software to perform a full backup .
Procedure
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.
- 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.
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 Standard Archive Stores
When backing up standard archived 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.
Storage Snapshots
When using Volume Shadow 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 Service with a so-called Volume Shadow Service Writer (VSS Writer). The external backup software can use it to create consistent backups of the MailStore master database and all standard 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 system 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 system protocol, no consistent backup using Volume Shadow 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 Advanced Archive Stores
Advanced archive stores allow you to store individual components of the archive store data in different locations. For example, folder information and meta data can be stored in an SQL database while saving email headers and contents in the file system. Depending on the storage locations, backup order can be crucial for a consistent backup.
Single Storage Location
If all data of an advanced archive store such as folder information and meta data as well as email headers and contents are stored in the same location (file system or SQL database), the consistency of this location must be kept in mind. This can be done using the Volume Shadow Service or appropriate database backup software, for example.
Multiple Storage Locations
If different storage locations are used for folder information and meta data as well as email headers and contents, backup order is crucial for the consistency of the archive store backup. Please adhere to the following order:
- Backup of the folder information and meta data
- Backup of email headers and contents
This ensures that upon recovery the related email headers and contents for all folder information and metadata exist and that data integrity is maintained.
Restoring Backups
This section describes how a database backup of the entire email archive, which was created using the integrated backup feature, can be restored.
Background
A database backup which was created using the integrated backup feature 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.
No further steps are necessary after using the automatic restore.
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.
The backup is completely restored to the application and the archive can be used as usual.
