Chapter 3. Restoring sites with UNiTE

Restoring sites with UNiTE is fairly simple.

You just need to upload the XML, JSON or YAML file for the site to be restored and the backup archive in any readable folder on your server. If you have a configuration file which uses a remotely stored file (download from Amazon S3) or takes a backup on a remote site you obviously do not need to upload a backup archive.

You then just to run UNiTE with that XML, JSON or YAML file. This step can be executed manually (e.g. from an SSH terminal), with a CRON job or through automation software (such as Ansible).


You can find examples for restoring your sites in the examples directory of the ZIP file you downloaded from our site. You can consult the examples to get the structure of the file right and this document to understand what each key in the XML, JSON or YAML file does.

File formats

UNiTE accepts configuration files in the following formats:

  • XML. This is the traditional format for UNiTE, supported since version 0.1 released back in 2008.

  • JSON. Supported since UNiTE version 5.0.

  • JSON5. This is a superset of JSON which also supports comments and more relaxed syntax. Supported since UNiTE version 5.0.

  • YAML. Supported since UNiTE version 5.0.

All formats are supported equally in UNiTE. While XML has been the “traditional” format, we recommend switching to the far more readable JSON5 or YAML formats.