Support

Documentation

BRS for WordPress

These are the specific instructions for the Akeeba Backup Restoration Script for WordPress. This is meant to be used when restoring sites based on the WordPress content management system. Only the pages specific to this script are described here. For the common instructions among all BRS installers please consult the relevant section.

First page

When BRS finishes collecting information about your server –usually within a few seconds– it will display a page similar to the above. Let's look at its main content area from top to bottom.

Toolbar

The Start Over button clears the session storage, and restarts the restoration. Use it if you you came back to this page clicking the Back button and you feel a bit lost as to which settings you have applied. Please note that since the session storage is cleared, you will have to re-enter the password to the restoration script if one was set up.

The Check Again button will re-run the checks and reload the page, without clearing the session storage.

The Next button is the same as Proceed with the restoration described below.

Top pane

The topmost pane of this page shows you at a glance whether you are ready to continue with the restoration. A message in a green background means that you can go on clicking on Proceed with the restoration to proceed to the database setup page. Otherwise, you are told why you cannot proceed with the restoration.

If the message in the green background also reads "Please read the notes below" it means that some of the recommended settings are not met. This is not the end of the world; your site will probably work just fine, but you should be aware of these potential issues.

Required settings

All settings listed here must be at their recommended value.

PHP Version

Your server must meet the minimum PHP version noted in the setting's name.

Please note that it is possible that your server has more than one PHP versions installed at the same time. The PHP version your site is being run under may not be the latest PHP version available, and it may also not be the PHP version in your hosting control panel. Especially regarding the latter, please keep in mind that what is reported is the PHP version the hosting control panel runs under, NOT the PHP version your site runs under – in fact, the latter is not something that can be reported as it is technically possible to have a different PHP version handling different PHP scripts or directories on your site.

If you receive an error here it can never be a bug. It is PHP checking its own version, hardcoded into the PHP executable itself when it was compiled and installed on your server, against the version number printed in the message. You need to contact your host and ask them how you can select the PHP version for your site.

[Important]Important

In many cases your host will tell you to modify your site's .htaccess file, or use a tool in the hosting control panel which does the same. Since the .htaccess file may be overwritten later during the restoration process you may have to apply the PHP version again after the Site Setup step of the restoration.

You can avoid this rigmarole by choosing the PHP version before extracting the backup archive. BRS will see the relevant lines in the .htaccess and propose to transcribe them for you.

Database support

The PHP version currently used to run your site must have the mysqli extension installed and enabled. Moreover, the various mysqli_* functions must NOT be disabled in PHP's configuration.

Kindly note that an error here can never be a bug. BRS simply asks PHP to tell it if the functions used to connect to a MySQL database using PHP's mysqli extension are available. An error means that PHP itself reports it will not be able to connect to the database.

If you get an error here, please ask your host how to enable the mysqli extension. If you are unsure which PHP version is being used, scroll down to the Site Information section of the page and look at the PHP version line. The version currently used on your server is shown under the Current column.

[Important]Important

PHP offers two ways to connect to PHP databases: the mysqli extension, and the MySQL PDO driver (the pdo_mysql extension). WordPress only supports the mysqli extension.

JSON Support

The PHP version currently used to run your site must have the json extension installed and enabled. Moreover, the various json_* functions must NOT be disabled in PHP's configuration.

Just like with database support, an error here can never be a bug for similar reasons. If you get an error here, contact your host.

Zlib Support

The PHP version currently used to run your site must have the zlib extension installed and enabled. Moreover, the gzcompress function and the other related Zlib functions must NOT be disabled in PHP's configuration.

Just like with database support, an error here can never be a bug for similar reasons. If you get an error here, contact your host.

Recommended settings

The settings listed here are not mandatory to have their recommended values, and your site will probably still work just fine. The recommended values will ensure that the site works properly, without displaying error, warning, or notice messages.

PHP version

Different WordPress versions have a different PHP maximum version supported. If you use a PHP version which is "too new" for your WordPress version you may end up with PHP notices, or warnings. The presence of these messages might leak security-sensitive information, or may break your site e.g. make it impossible to log in, or use some core WordPress and/or plugin features. This is especially problematic if Display Errors below is shown as not being in the recommended value.

Display Errors

The display_errors setting in PHP's configuration must be set to 0, preventing the output of PHP notices, warnings, and errors to the browser. The presence of these messages might leak security-sensitive information, or may break your site e.g. make it impossible to log in, or use some core WordPress and/or plugin features.

File Uploads

Your PHP version must be configured to support file uploads for some features to work such as managing media files, or installing plugins outside of the WordPress Plugins Directory. If you see an error here it's best to contact your host.

Site information

This is a purely informative section, showing you various configuration settings at backup time, and at restoration time.

WordPress version

The version of WordPress, as detected by BRS.

Host name

The domain name of the backed up site, and the one you are restoring to. If the domain name or subdomain is different you will have to go through the Replace Data page for your site to work properly.

Date

Then the backup was taken on, and when it's being restored. It is a good idea to always check the date of the backup you are restoring, and make sure it is indeed the backup you meant to restore.

Backup software version.

The value shown "At Backup Time" is the version of Akeeba Backup for WordPress or Akeeba Solo you used to take the backup. The "Current" version is the version of BRS which is different than the version number of the backup software.

PHP version

The PHP version used when backing up the site, and the PHP version being used during the restoration.

Root directory

The absolute filesystem path of the site's root folder. If it is different at restoration time you will have to go through the Replace Data page for your site to work properly.

You can also click the View README.html file to view this file which is generated at backup time. It includes the backup description, backup comment, and the name and version of the backup software which generated the backup archive.