1-888-77-Kerio
Home » Categories » Kerio Connect » Server configuration » Archiving and backup
Icon Printer Icon Email      Icon Twitter Icon Digg Icon Stumbleupon Icon de.icio.us Icon FaceBook

Data recovery in Kerio Connect

Recovering data from backup

To recover the backup data, use a special tool, Kerio Connect Recover. The tool extracts the backed-up data and saves the data in their original locations.

To launch Kerio Connect Recover:

  1. Stop Kerio Connect.

  2. Go to the Kerio Connect installation directory.

  3. Run the following command from the directory:

    kmsrecover [advanced options] <directory_name>|<file_name>
    

    For Mac OS X and Linux, use ./kmsrecover [advanced options] <directory_name>|<file_name> if the path to the Kerio Connect installation directory is included in the path variable.

    If you don't specify any advanced options, , all items in the Kerio Connect's data store are overwritten.

  4. To see details and example of individual options, run:

    kmsrecover -h or kmsrecover --help

Advanced options of Kerio Connect Recover

Abbreviation Full option Mask Description
-d --domain Recovers (or lists with parameter -l) all backed-up data for the specified domain..
-u --user Recovers (or lists with parameter -l) data of the specified user.
-f --folder Recovers the specified folder of the user (requires setting of the -d and -u options).
-s --store Sets where SpamAssassin databases, mailing lists and emails (including events, notes, contacts, and so on) are unpacked and stored. By default, the store folder in the Kerio Connect installation directory is used.
-c --cfgdir Sets a directory for configuration files, SSL certificates and licenses. By default, the installation directory is used.
-m --mask Specifies which parts of the backup will be recovered. You must set the value of the mask with -m <value> or --mask=<value>. Example: -m cfg,license,sslca,sslcert. See the table below for values.
cfg This argument recovers only configuration files mailserver.cfg and users.cfg.

Abbreviation Full option Mask Description
mail Recovers only the \store\mail directory.
lists Recovers only the configuration of mailing lists, the \store\lists directory.
spamassassin Recovers only the SpamAssassin database.
license Recovers the Kerio Connect license.
sslca Recovers SSL certificates issued by certification authorities.
sslcert Recovers the Kerio Connect certificates.
public Recovers public folders.
-b --backup Performs an additional back-up before the recovery stars. The original directory will have the BAK extension. If such file already exists, it is replaced by the new version. Verify that you have enough free disk space available, as this backup doubles the store size.
-g --noprogress Hides information about the recovery progress. (Recommended if the recovery is recorded in the log.)
-l --listing Lists the backup store content. You can also use additional parameters, such as -d and -u, which list only specific content.
-q --quiet Hides the recovery progress information in the command line.
-v --verbose Displays the recovery progress information in the command line.
-h --help Prints out the help file.

Backup files

File names

Each backup archive (ZIP) file name consists of the backup type abbreviation and the date when it was created:

Full backup (F)

F20120118T220007Z.zip

F — full backup

2012 — year

01 — month

18 — day

T220007Z — GMT timestamp (22:00:07); always starts with T and ends with Z.

Differential backup (D)

D20120106T220006Z.zip

D — differential backup

2012 — year

01 — month

06 — day

T220006Z — GMT timestamp (22:00:06); always starts with T and ends with Z.

Backup copy/Manual backup (C)

C20120117T084217Z.zip

2012 — year

01 — month

17 — day

T084217Z — GMT timestamp (08:42:17); always starts with T and ends with Z.

File content

Each backup archive (ZIP) file includes the following files and directories:

  • .version.txt is created at the start of the backup process and includes the following information:

    • started — Time the backup started (YYYY-MM-DD hh:mm:ss).

    • version — Version of the backup tool.

    • hostname — DNS name of the Kerio Connect host for which the backup was created.

  • @backup is the main directory of the backup and includes the following items:

    • license — License backup.

    • sslca — Backup of certificates of certification authorities.

    • sslcert — Backup of Kerio Connect's SSL certificates.

    • store — Backup of the data store

  • mailserver.cfg is a file with the Kerio Connect and configuration contains all settings done in the administration interface.

  • users.cfg is a file with user configuration and contains all users and their parameters set in the Kerio Connect's administration interface.

  • .summary.txt is created at the end of the backup creation process and includes the following information:

    • started — Time the backup started (YYYY-MM-DD hh:mm:ss).

    • finished — Time the backup ended YYYY-MM-DD hh:mm:ss.

    • count_files — Number of backed-up files.

    • total_size — Total size of the files (in bytes) which are backed-up between the creation of files .version.txt and .summary.txt.

    • duration — Total time of the backup creation process (hh:mm:ss:msms).

Data recovery examples

To read through some examples of data recovery, see this article.

Troubleshooting

If any problem with backups occurs, consult the Debug log (Right-click the Debug log area, click Messages, and select the Store Backup option).


comments powered by Disqus