Support

Documentation

The XML command file format

The XML format is the oldest of the supported formats and a bit cumbersome to use. Below, we provide a sample skeleton file and explain each of its areas.

<?xml version="1.0" encoding="UTF-8"?>
<unite>
	<remote>
		<host>http://www.example.com</host>
		<secret>test</secret>
		<component>com_akeeba</component>
		<profile>1</profile>
		<downloadmode>http</downloadmode>
		<dlurl>ftp://user:[email protected]/administrator/components/com_akeeba/backups</dlurl>
		<delete>1</delete>
	</remote>

	<s3>
		<accesskey>ABCDEF</accesskey>
		<secretkey>123456</secretkey>
		<signature>v4</signature>
		<bucket>mybucket</bucket>
		<region>us-east-1</region>
		<ssl>1</ssl>
		<endpoint>api.myservice.com</endpoint>
		<filename>path/to/site-backup.jpa</filename>
	</s3>
	
	<siteInfo>
		<package from="remote"></package>
		<deletePackage>0</deletePackage>
		<localLog>test.log</localLog>
		<emailSysop>0</emailSysop>
		<name>My Shiny Restored Site</name>
		<email>[email protected]</email>
		<absolutepath>/Users/nicholas/Sites/restored</absolutepath>
		<homeurl>http://www.example.net</homeurl>
		<livesite>http://www.example.net</livesite>
		
		<jpspassword><![CDATA[yourpassword]]></jpspassword>
		
		<adminID>123</adminID>
		<adminEmail><![CDATA[[email protected]]]></adminEmail>
		<adminPassword><![CDATA[yourPassword]]></adminPassword>
	</siteInfo>

	<databaseInfo>
		<database name="site">
			<changecollation>0</changecollation>
			<dbdriver>mysqli</dbdriver>
			<dbhost>127.0.0.1</dbhost>
			<dbuser>mydbuser</dbuser>
			<dbpass>password</dbpass>
			<dbname>example</dbname>
			<dbprefix>exmp_</dbprefix>
		</database>
	</databaseInfo>
	
	<extrafiles>
		<extract to="">extras.zip</extract>
	</extrafiles>
	
	<extrasql>
		<execute db="joomla">test.sql</execute>
	</extrasql>

	<postrun>
		<emailto>[email protected]</emailto>
		<emailsubject>Restoration complete</emailsubject>
		<emailbody><![CDATA[
			Email body
		]]></emailbody>
	</postrun>

<handlers>
  <handler>/path/to/my_handler.php</handler>
</handlers>

</unite>

Please note that if you are NOT using one of the optional sections (such as <remote> or <s3>) you should NOT include it in your XML file.

The unite root element

Required: Yes. The root element of your XML file MUST be <unite>.

Scope: Document container.

[Note]Note

Unlike previous versions of UNiTE, you do not need to set the scripting attribute.

UNiTE only supports backups taken with Akeeba Backup for Joomla! 4.6.0 or later, Akeeba Backup for WordPress 1.7.0 or later or Akeeba Solo 1.7.0 or later. The backup type must be “Full site backup”. Backups taken with a different backup type or an older version of our backup software are NOT supported.