Support

Documentation

Chapter 1. The Backup Restoration Script
Prev Part I. User's Guide Next

Chapter 1. The Backup Restoration Script

Table of Contents

Introduction
Common instructions for all restoration scripts
Blocked because of CLI use
The unwritable session page
The password page
The main page
The database restoration page
Off-site Directories
The “Finished” page
BRS for Joomla!
First page
Public Folder
Site setup page
BRS for Miscellaneous PHP Applications
First page
Site setup page
BRS for WordPress
First page
Site setup page
Replace data page

Introduction

When you take a backup with one of our backup software –Akeeba Backup for Joomla! or WordPress, or Akeeba Solo– the backup archive includes a backup restoration script, placed into it at backup time. This script is extracted in the installation directory when you extract the backup archive. The backup restoration script is used to restore your database and, depending on the type of installer script selected and the PHP-based application used by your site, possibly reconfigure your site.

There are three types (or "platforms") of the backup restoration script:

  • Akeeba Backup Restoration Script for Joomla. This script knows about Joomla! 1.5 and later sites. It will show you Joomla!-specific configuration actions, and update your site's configuration.php file.

  • Akeeba Backup Restoration Script for WordPress. This script knows about the WordPress versions supported by the version of Akeeba Backup for WordPress it was included with. It will show you WordPress-specific configuration actions, perform data replacement which is required when restoring WordPress sites, and update your site's wp-config.php file.

  • Akeeba Backup Restoration Script for Generic or Bespoke PHP Application. This is a generic restoration script. It will not show you any specific configuration options for your site, nor will it update your site's configuration file(s), if any.

The type of restoration script which is included in the backup is configured in the backup profile. Since the restoration script is stored in the backup archive at backup time, it is important to choose the correct script type for your site. For example, if you have a Joomla site you have to choose "Akeeba Backup Restoration Script for Joomla". Selecting the wrong installer is not the end of the world; you will still be able to restore your site's database content but you will have to modify your site's configuration file(s) manually.

All restoration script types have a common core, with platform-specific code. The documentation will point out which parts are common, and which are platform-specific.

The restoration script can be accessed by visiting the installation/index.php URL on your site after extracting the backup archive. For example, if your site is located in http://www.example.com you can access the ANGIE installer after extracting the backup archive by visiting http://www.example.com/installation/index.php.

Prev Up Next
Part I. User's Guide Home Common instructions for all restoration scripts