Duplicator - Installer
Help Overview
version: 1.1.34 » help  
For in-depth help please see the online resources

Step 1 - Deploy

MySQL Server Action:
'Create New' will attempt to create a new database if it does not exist. This option will not work on many hosting providers. If the database does not exist then you will need to login to your control panel and create the database. If 'Connect and Remove All Data' is checked this will DELETE all tables in the database you are connecting to as the Duplicator requires a blank database. Please make sure you have backups of all your data before using an portion of the installer, as this option WILL remove all data. Please contact your server administrator for more details.

Host:
The name of the host server that the database resides on. Many times this will be localhost, however each hosting provider will have it's own naming convention please check with your server administrator. To add a port number just append it to the host i.e. 'localhost:3306'.

User:
The name of a MySQL database server user. This is special account that has privileges to access a database and can read from or write to that database. This is not the same thing as your WordPress administrator account

Password:
The password of the MySQL database server user.

Test Connection:
The test connection button will help validate if the connection parameters are correct for this server. There are three separate validation parameters:
  • Host: Returns a status to indicate if the server host name is a valid host name

  • Database: Returns a status to indicate if the database name is a valid

  • Version: Shows the difference in database engine version numbers. If the package was created on a newer database version than where its trying to be installed then you can run into issues. Its best to make sure the server where the installer is running has the same or higher version number than where it was built.

Name:
The name of the database to which this installation will connect and install the new tables onto.

Common Database Connection Issues:
- Double check case sensitive values 'User', 'Password' & the 'Database Name'
- Validate the database and database user exist on this server
- Check if the database user has the correct permission levels to this database
- The host 'localhost' may not work on all hosting providers
- Contact your hosting provider for the exact required parameters
- See the 'Database Setup Help' section on step 1 for more details
- Visit the online resources 'Common FAQ page'
Advanced Options Manual Package Extraction:
This allows you to manually extract the zip archive on your own. This can be useful if your system does not have the ZipArchive support enabled.

File Timestamp:
Choose 'Current' to set each file and directory to the current date-time on the server where it is being extracted. Choose 'Original' to retain the file date-time in the archive file. This option will not be applied if the 'Manual package extraction' option is checked.

Enforce SSL on Admin:
Turn off SSL support for WordPress. This sets FORCE_SSL_ADMIN in your wp-config file to false if true, otherwise it will create the setting if not set.

Enforce SSL on Login:
Turn off SSL support for WordPress Logins. This sets FORCE_SSL_LOGIN in your wp-config file to false if true, otherwise it will create the setting if not set.

Keep Cache Enabled:
Turn off Cache support for WordPress. This sets WP_CACHE in your wp-config file to false if true, otherwise it will create the setting if not set.

Keep Cache Home Path:
This sets WPCACHEHOME in your wp-config file to nothing if true, otherwise nothing is changed.

Fix non-breaking space characters:
The process will remove utf8 characters represented as 'xC2' 'xA0' and replace with a uniform space. Use this option if you find strange question marks in you posts

Mysql Mode:
The sql_mode option controls additional options you can pass to the MySQL server during the database import process. This option is only set per session (during the Duplicator step 1 install process) and the modes here will return to their original state after step one runs. The sql_mode options will vary based on each version of mysql. Below is a list list of links to the most recent MySQL versions.
This option creates a SET SESSION query such as SET SESSION sql_mode = 'NO_ENGINE_SUBSTITUTION,NO_ZERO_IN_DATE' and passes it to the MySQL server before any tables or data are created. The following options are available:
  • Default: This option will not do anything and uses the default setting specified by the my.ini sql_mode value or the server's default sql_mode setting. The installer-log.txt SQL_MODE value will show as NOT_SET if the my.ini sql_mode is not present or is set to empty.

  • Disable: This sets the sql_mode to an empty string which results in SET SESSION sql_mode = ''. The installer-log.txt SQL_MODE value will show as NOT_SET

  • Custom: This setting allows you to pass in a custom set of sql_mode options such as SET SESSION sql_mode = 'NO_ENGINE_SUBSTITUTION,NO_ZERO_IN_DATE'. In the custom field input box enter in the sql_mode optionsthat you need for your particular server setup.

    Enter the sql mode as comma-separated values with no spaces, and do not include the 'SET SESSION' instruction. Be sure to pay attention to the MySQL server version and ensure it supports the specified options. The installer-log.txt file will record any errors that may occur while using this advanced option.
Please note that if the SQL_MODE in the installer-log.txt is not showing correctly that you may need to check your database users privileges. Also be sure that your MySQL server version supports all the the sql_mode options you're trying to pass.

MySQL Charset & MySQL Collation:
When the database is populated from the SQL script it will use this value as part of its connection. Only change this value if you know what your databases character set should be.

Step 2 - Update

Settings Old Settings:
The URL and Path settings are the original values that the package was created with. These values should not be changed.

New Settings:
These are the new values (URL, Path and Title) you can update for the new location at which your site will be installed at.
New Admin Account Username:
The new username to create. This will create a new WordPress administrator account. Please note that usernames are not changeable from the within the UI.

Password:
The new password for the user.
Advanced Options Site URL:
For details see WordPress Site URL & Alternate Directory. If you're not sure about this value then leave it the same as the new settings URL.

Scan Tables:
Select the tables to be updated. This process will update all of the 'Old Settings' with the 'New Settings'. Hold down the 'ctrl key' to select/deselect multiple.

Activate Plugins:
These plug-ins are the plug-ins that were activated when the package was created and represent the plug-ins that will be activated after the install.

Post GUID:
If your moving a site keep this value checked. For more details see the notes on GUIDS. Changing values in the posts table GUID column can change RSS readers to evaluate that the posts are new and may show them in feeds again.

Full Search:
Full search forces a scan of every single cell in the database. If it is not checked then only text based columns are searched which makes the update process much faster.

Step 3 - Test

Final Steps Resave Permalinks
Re-saving your perma-links will reconfigure your .htaccess file to match the correct path on your server. This step requires logging back into the WordPress administrator.

Delete Installer Files
When you're completed with the installation please delete all installer files. Leaving these files on your server can impose a security risk!

Test Entire Site
After the install is complete run through your entire site and test all pages and posts.

View Install Report
The install report is designed to give you a synopsis of the possible errors and warnings that may exist after the installation is completed.

Troubleshooting Tips

Quick Overview
Common Quick Fix Issues:
  • Use an approved hosting provider
  • Validate directory and file permissions (see below)
  • Validate web server configuration file (see below)
  • Clear your browsers cache
  • Deactivate and reactivate all plugins
  • Resave a plugins settings if it reports errors
  • Make sure your root directory is empty
Permissions:
Not all operating systems are alike. Therefore, when you move a package (zip file) from one location to another the file and directory permissions may not always stick. If this is the case then check your WordPress directories and make sure it's permissions are set to 755. For files make sure the permissions are set to 644 (this does not apply to windows servers). Also pay attention to the owner/group attributes. For a full overview of the correct file changes see the WordPress permissions codex

Web server configuration files:
For Apache web server the root .htaccess file was copied to .htaccess.orig. A new stripped down .htaccess file was created to help simplify access issues. For IIS web server the web.config file was copied to web.config.orig, however no new web.config file was created. If you have not altered this file manually then resaving your permalinks and resaving your plugins should resolve most all changes that were made to the root web configuration file. If your still experiencing issues then open the .orig file and do a compare to see what changes need to be made.

Plugin Notes:
It's impossible to know how all 3rd party plugins function. The Duplicator attempts to fix the new install URL for settings stored in the WordPress options table. Please validate that all plugins retained there settings after installing. If you experience issues try to bulk deactivate all plugins then bulk reactivate them on your new duplicated site. If you run into issues were a plugin does not retain its data then try to resave the plugins settings.

Cache Systems:
Any type of cache system such as Super Cache, W3 Cache, etc. should be emptied before you create a package. Another alternative is to include the cache directory in the directory exclusion path list found in the options dialog. Including a directory such as \pathtowordpress\wp-content\w3tc\ (the w3 Total Cache directory) will exclude this directory from being packaged. In is highly recommended to always perform a cache empty when you first fire up your new site even if you excluded your cache directory.

Trying Again:
If you need to retry and reinstall this package you can easily run the process again by deleting all files except the installer.php and package file and then browse to the installer.php again.

Additional Notes:
If you have made changes to your PHP files directly this might have an impact on your duplicated site. Be sure all changes made will correspond to the sites new location. Only the package (zip file) and the installer.php file should be in the directory where you are installing the site. Please read through our knowledge base before submitting any issues. If you have a large log file that needs evaluated please email the file, or attach it to a help ticket.

For in-depth help please see the online resources