Support

Documentation

Using Akeeba eXtract Wizard

[Tip]Tip

You can download Akeeba eXtract Wizard from our site's download page. The latest release is always at the top of the list. Older versions are available for use with older versions of our backup software (Akeeba Backup and Akeeba Solo). There are versions of this tool for Windows, Mac OS X and Linux.

If you are a developer you can find its source code in our GitHub repository. The application is written in FreePascal Lazarus, an open source Delphi-like language.

Sometimes Akeeba Kickstart cannot be used on live servers. For example if you are low on disk space you can't use Kickstart as you would need enough disk space to hold both the backup archive and the extracted files at the same time. Or maybe you want to skip a few folders which were backed up. In this case you can extract the backup archive locally using Akeeba eXtract Wizard.

Akeeba eXtract Wizard - Main screen

Launching Akeeba eXtract Wizard presents you with it interface. You have the following options:

Archive file

Click on the button to the right of the text box to open a file picker dialog. Use it to locate the archive file you want to extract and double click on it.

Extract to folder

Use the button to the right of the text box to open a directory selection dialog. Use it to locate the folder you want to extract the backup archive to and double click on it.

Ignore most errors

Sometimes there are files which cannot be extracted because their file names are not compatible with your operating system. This is especially true if you backed up from a Linux machine (e.g. a live server) and trying to extract the archive on Windows (e.g. a local server). Some temporary files may contain characters such as ampersands and question marks which are valid file name characters in Linux but not on Windows. These would normally cause the extraction to fail. By checking this option these files will simply be ignored.

Please be careful! Akeeba eXtract Wizard will NOT warn you if an otherwise perfectly backed up file cannot be extracted because of file / folder permissions!

Dry run

By checking this box Akeeba eXtract Wizard will not write anything to disk. Use this to quickly test a backup archive for corruption. If the dry run reports a successful "extraction" your archive is good.

When you are ready just click on Extract and the extraction takes place. You will see the Extraction Progress bar fill up as each file is being extracted. eXtract Wizard will let you know when the extraction is complete.

After the archive is extracted you end up with a bunch of files and folders. In order to proceed with your site's restoration you need to place them to your server's web root.

  • If you are using a local server (WAMPServer, XAMPP, MAMP, Zend Server, etc) just move those files in the subdirectory of the web root of your local server where you want your local copy of the site to exist using Windows Explorer (Windows), Finder (Mac OS X), Nautilus (Ubuntu Linux) and so on. Access the restoration script from your browser as http://localhost/your_directory/installation/index.php where your_directory is the name of the subdirectory of the web root where you copied the files. On some local servers you may want to replace localhost with something like localhost:8888 (default MAMP settings) or localhost:10088 (default Zend Server settings).

  • If you are using a live server, upload all files and folders via FTP or SFTP to your server's web root. Usually it's a directory called www, public_html, httpdocs, htdocs or something similar visible when you connect to your site by FTP/SFTP. If unsure, please ask your host. Afterwards access the restoration script as http://www.example.com/installation/index.php where www.example.com is the domain name of your site. Please note that temporary URLs in the form http://www.example.com/~something or http://1.2.3.4/~something are likely to cause restoration errors or, at the very least, cause your SEF URLs to fail on the restored site.

Cookies Notification - Action required

This website uses cookies to provide user authentication and improve your user experience. Please indicate whether you consent to our site placing these cookies on your device. You can change your preference later, from the controls which will be made available to you at the bottom of every page of our site.