Support

Documentation

siteInfo - Site restoration information

Common options

The following options apply to all kinds of CMS supported by Akeeba Backup and Akeeba Solo.

package

This option tells UNiTE where to find the backup archive it will restore. There are two cases, getting the archive from a remote backup or getting it from a local file.

There are two ways to use this, depending on the file format

JSON, JSON5 and YAML formats

If you wish to run a remote backup or download a backup archive from Amazon S3 leave this option empty or just omit it altogether. You will need to set up the packageFrom option instead.

If you want to use a local file set its value to the path of the file you want to restore, e.g. /path/to/package.jpa. The path can be either an absolute path or a path relative to the current working directory. The file must be in the JPA, JPS or ZIP file format.

If you have a multipart backup archive (.jpa, .j01, .j02 etc or .zip, .z01, .z02 etc) you MUST only specify the .jpa or .zip file. UNiTE will automatically figure out it's a multipart archive and use the rest of the backup part files without you having to specify them.

XML file format

If you wish to run a remote backup, use exactly the following syntax:

<package from="remote"></package>

This will instruct UNiTE to use the information in the <remote> section of the XML command file to take a remote backup, download the backup archive into the current working directory and use it to restore a site.

If you want to download a file from Amazon S3 use this syntax instead:

<package from="s3"></package>

This will instruct UNiTE to use the information in the <s3> section of the XML command file to download the backup archive file(s) into the current working directory and use it to restore a site. In case of a multipart backup archive you only have to specify the .jpa, .jps or .zip file; Akeeba UNiTE will automatically detect and download all part files (.j01, .j02, ... or .z01, .z02, ...).

If you want to use a local file, you have to use the following syntax:

<package>/path/to/package.jpa</package>

The /path/to/package.jpa is the path to the backup archive of the site to be restored. The path can be either an absolute path or a path relative to the current working directory. The file must be in the JPA, JPS or ZIP file format. For example, if you have stored a package named mypackage.jpa next to your XML file then the relative path is mypackage.jpa and the syntax for this option would be:

<package>mypackage.jpa</package>

If you have a multipart backup archive (.jpa, .j01, .j02 etc or .zip, .z01, .z02 etc) you MUST only specify the .jpa or .zip file. UNiTE will automatically figure out it's a multipart archive and use the rest of the backup part files without you having to specify them.

[Important]Important

It is recommended that you store your packages together with your XML files. Please remember that asking UNiTE to use packages in directories above where the XML file is being read from may not work as it is subject to PHP's open_basedir restrictions, as well as file and directory permissions / ACLs.

packageFrom

This option only applies to the JSON, JSON5 and YAML file formats. It tells UNiTE where to get the package information from:

  • inbox (or omit this option entirely).

  • remote. Take a backup of a remote site and download the resulting backup archive to restore it, using the information from the remote section of the configuration file.

  • s3. Download a backup archive from Amazon S3 using the information in the s3 section of the configuration file.

deletePackage

Should the package files be deleted after a successful installation? This works irrespectively of the global configuration setting for the XML files. Set to 1 or true to erase the package files, or 0 or false to skip erasing.

[Note]Note

When set to 1, the extrafiles and extrasql files – if any – will also be erased upon successful installation of the site. If you want the same restoration action to execute whenever UNITE runs (e.g. restoring a demo site), set this to 0.

localLog

The absolute or relative path of the log file kept for this XML file only. The log will contain each action performed by UNiTE when installing the site defined in this XML file. The path can be either absolute, or relative to UNITE's installation path.

emailSysop

When set to 1 or true, UNiTE will email the administrator (the email address defined in UNiTE's configuration) with a copy of the information email sent to the address defined in the XML file and a copy of the log file. Set to 0 or false to not send an email.

absolutepath

The absolute path to the site's root. This is a necessary setting to allow UNiTE to update the site's configuration with the correct values for directories that require an absolute path, e.g. the temporary and cache directories in Joomla!.

[Warning]Warning

This option only accepts an absolute path. Using a relative path will NOT work.

jpspassword

Optional. This is used to provide the encryption password necessary only when you are restoring encrypted (JPS) archives. Please remember to surround your password with CDATA, otherwise you will not be able to use any special characters in it (the XML processing will fail, that's how XML works).