Support

Documentation

Chapter 1. Introduction and installation

What is UNiTE?

UNiTE is an automated, unattended backup archive restoration tool. It's designed to create new sites out of backup archives taken with Akeeba Backup or Akeeba Solo without any human intervention. It can even take remote backup archives, or download archives already stored in Amazon S3. You can run it from the command line or even from a CRON script. In fact, Akeeba UNiTE is written with the power user and automation in mind.

If you are looking for something to restore your backup archives which runs in a browser and lets a human interact with it you should be looking at Akeeba Kickstart instead.

UNiTE is written in PHP and delivered as a PHAR executable (a file with a .phar extension). PHAR files can be executed through PHP. They are the preferred delivery format for numerous modern PHP applications such as Composer, PHPUnit, Phing and so on.

Typically, UNiTE is used for the following tasks:

  • Provisioning of new Joomla!, WordPress, etc websites. You only need to supply an XML file which describes how the new site will be configured and a backup archive. At the end of the UNiTE run you'll have a configured website, ready for use.

  • Demo sites. Demo sites need to be restored from a known good backup on predefined intervals. Akeeba UNiTE can easily be used for this task.

  • Dev-to-staging or staging-to-live transfer automation. Some setups require that before anything goes on the live site it should first go through a dev server (where all active development takes place) and a staging server (where user experience tests are conducted) before hitting the live site. UNiTE can be used to automatically backup the dev site and restore to the staging site, or even backup the staging site and restore it to the live site.

[Warning]Warning

UNiTE is not a CMS integrated extension, i.e. not a Joomla! component or WordPress plugin. As a result it can not be installed in Joomla!, WordPress or any other CMS. A certain degree of experience is required due to the command-line nature of the script.

UNiTE is available for download to all of our subscribers who have download access to Akeeba Backup Professional for Joomla! or WordPress; or Akeeba Solo Professional. This includes subscription packages which include either software. UNiTE is not sold separately.

[Important]Important

Akeeba UNiTE can only be used to restore backup archives taken with Akeeba Backup or Akeeba Solo when using the "Full Site Backup" type. The backup archive must include the ANGIE restoration script. We recommend not trying to restore backup archives taken more than 18 months prior to the release of the version of Akeeba UNiTE you are using.