Backup for Carbonio

Backup for Carbonio

This chapter discusses Carbonio Backup, the component in charge of backing up all data. The chapter is organised into many sections: first, an overview of the most typical task is provided, followed by links to more technical literature.

Following that, the architecture of Carbonio Backup is outlined, which contains crucial ideas to be aware of ahead of time; the concepts will be discussed in further detail later in the chapter.

Finally, the backup options for items and accounts are described in full, along with the related CLI scripts. Tasks that can be completed using the GUI may be found in the Backup area of the Admin Panel, while those that can be completed using both the CLI and the GUI are cross-referenced between the two sections, allowing you to pick your preferred method of execution.
The Backup documentation is therefore divided into four major sections:
  1. Backup (of an AppServer) is the current page, which includes: the architecture of the backup modules and a glossary of the most important words; the most common backup operations and how to perform them through the CLI 
  2. Backup Restore Strategies: How to Restore Items, Accounts, or Whole AppServers from the CLI
  3. Advanced Backup Techniques, including Disaster Recovery, a set of last-resort recovery options following hardware or software failures (unrelated to Carbonio
  4. Backup of the Admin Panel, which comprises all tasks that can only be completed through the GUI.
Common Carbonio Backup Tasks
This section offers guidance for the most typical tasks encountered by users, as well as access to technical information.
How to Enable Carbonio Backup
After you’ve done configuring your server, you’ll need to take a few more steps to configure the Backup component and have all of your data automatically backed up.
  • Install a storage device at the desired place. Throughout this part, we will use the default path  /opt/zextras/backup/zextras remember to change it with the location you choose.


The size of the device should be at least 80% of primary + secondary volume size.

  • Set the right backup path permissions: chown zextras:zextras /opt/zextras/backup/zextras


To avoid a flood of notifications about running operations, it is suggested to lower the default Notification level from Information to one of WarningError, or Critical using the command line:

zextras$ carbonio config set global ZxCore_LogLevel 0

to increase the log verbosity, or

zextras$ carbonio config set global ZxCore_LogLevel 1

to restore the normal log verbosity. you can also check the current log level as follows.

zextras$ carbonio config dump global|grep LogLevel

 Basic Customisation of Backup

You can optionally customise some of the Carbonio Backup options, including:

  • The full path for backups, which can be achieved also with the following command.

    zextras$ carbonio config set server $(zmhostname) ZxBackup_DestPath /opt/carbonio-backup

    After defining the Backup Path, it must be initialised: simply simply start SmartScan, either from the admin console or the command line.

  • Enable the SmartScan and its scheduling

  • Change the Retention Policy