|
Duplicator
|
version: 1.2.26 » info » help |
For additional help visit the
Online Knowledge-Base
Features available only in Duplicator Pro are flagged with a pro tag.
Online Knowledge-Base
Features available only in Duplicator Pro are flagged with a pro tag.
Installer Security
The installer security screen pro will allow for basic password protection on the installer. The password is set at package creation time. The password
input on this screen must be entered before proceeding with an install. This setting is optional and can be turned on/off via the package creation screens.
If you do not recall the password then login to the site where the package was created and click the details of the package to view the original password. To validate the password just typed you can toggle the view by clicking on the lock icon.
If you do not recall the password then login to the site where the package was created and click the details of the package to view the original password. To validate the password just typed you can toggle the view by clicking on the lock icon.
Step 1 of 4: Deployment
The "Extract Archive" screen is separated into four sections:
If the archive name is ever changed then it should be renamed back to the 'Name' value in order for the installer to properly identify it as part of a complete package. Additional information such as the archive size and the package notes are mentioned in this section.
Notices are simply checks that will help you identify any possible issues that might occur. If this section shows a Good/Warn for various checks. Click on the title link and read the overview for how to solve the test.
Archive
This is the archive file the installer must use in order to extract the web site files and database. The 'Name' is a unique key that ties both the archive and installer together. The installer needs the archive file name to match the 'Name' value exactly character for character in order for this section to get a pass status.If the archive name is ever changed then it should be renamed back to the 'Name' value in order for the installer to properly identify it as part of a complete package. Additional information such as the archive size and the package notes are mentioned in this section.
Validation
This section shows the installers system requirements and notices. All requirements must pass in order to proceed to Step 2. Each requirement will show a Pass/Fail status. Notices on the other hand are not required in order to continue with the install.Notices are simply checks that will help you identify any possible issues that might occur. If this section shows a Good/Warn for various checks. Click on the title link and read the overview for how to solve the test.
MultiSite pro
The multisite option allows users with a pro Business or Gold license to perform additional multi-site tasks. All licenses can backup & migrate standalone sites and full multisite networks. Multisite Plus+ (business and above) adds the ability to install a subsite as a standalone site.Options
The options for step 1 can help better prepare your site should your server need additional settings beyond most general configuration.| Option | Details |
|---|---|
| Extraction |
Manual Archive Extraction Set the Extraction value to "Manual Archive Extraction" when the archive file has already been manually extracted on the server. This can be done through your hosts control panel such as cPanel or by your host directly. This setting can be helpful if you have a large archive files or are having issues with the installer extracting the file due to timeout issues. PHP ZipArchive This extraction method will use the PHP ZipArchive code to extract the archive zip file. Shell-Exec Unzip pro This extraction method will use the PHP shell_exec to call the system unzip command on the server. This is the default mode that is used if its avail on the server. |
| Permissions pro |
All Files: Check the 'All Files' check-box and enter in the desired chmod command
to recursively set the octal value on all the files being extracted. Typically this value is 644 on most servers and hosts.
All Directories: Check the 'All Directories' check-box and enter in the desired chmod command to recursively set octal value on all the directories being extracted. Typically this value is 755 on most servers and hosts. |
| Config Files pro |
Inside the archive.zip should be a copy of the original .htaccess (Apache) or the web.config (IIS) files that were setup with your packaged site.
When the installer runs it will backup and then reset all .htaccess, user.ini, and web.config files. It will then create blank copies of
both files. This is needed because the original files that were archived in most cases will not play well in the new environment.
There are cases where users do not want these files over-written after the installer runs. If that is the case then check the checkbox for this setting to retain the original web server configuration files you had on the original site that was archived. This is an advanced feature and requires that you know how to properly configure either the .htaccess or web.config files on your server. |
| File Times | When the archive is extracted should it show the current date-time or keep the original time it had when it was built. This setting will be applied to all files and directories. |
| Logging | The level of detail that will be sent to the log file (installer-log.txt). The recommend setting for most installs should be 'Light'. Note if you use Debug the amount of data written can be very large. Debug is only recommended for support. |
Notices
To proceed with the install users must check the checkbox labeled " I have read and accept all terms & notices". This means you accept the term of using the software and are aware of any notices.Step 2 of 4: Install Database
Basic/cPanel:
There are currently two options you can use to perform the database setup. The "Basic" option requires knowledge about the existing server and on most hosts will require that the database be setup ahead of time. The cPanel option is for hosts that support cPanel Software. This option will automatically show you the existing databases and users on your cPanel server and allow you to create new databases directly from the installer.cPanel Login pro
The cPanel connectivity option is only available for Duplicator Pro.| Option | Details |
|---|---|
| Host | This should be the primary domain account URL that is associated with your host. Most hosts will require you to register a primary domain name. This should be the URL that you place in the host field. For example if your primary domain name is "mysite.com" then you would enter in "https://mysite.com:2083". The port 2038 is the common port number that cPanel works on. If you do not know your primary domain name please contact your hosting provider or server administrator. |
| Username | The cPanel username used to login to your cPanel account. This is not the same thing as your WordPress administrator account. If your unsure of this name please contact your hosting provider or server administrator. |
| Password | The password of the cPanel user |
| Troubleshoot |
Common cPanel Connection Issues: - Your host does not use cPanel Software - Your host has disabled cPanel API access - Your host has configured cPanel to work differently (please contact your host) - View a list of valid cPanel Supported Hosts |
Setup
The database setup options allow you to connect to an existing database or in the case of cPanel connect or create a new database.| Option | Details |
|---|---|
| Action |
Create New Database: Will attempt to create a new database if it does not exist. When using the 'Basic' option this option will not work on many
hosting providers as the ability to create new databases is normally locked down. If the database does not exist then you will need to login to your
control panel and create the database. If your host supports 'cPanel' then you can use this option to create a new database after logging in via your
cPanel account.
Connect and Remove All Data: This options will DELETE all tables in the database you are connecting to. Please make sure you have backups of all your data before using an portion of the installer, as this option WILL remove all data. Connect and Backup Any Existing Data:pro This options will RENAME all tables in the database you are connecting to with a prefix of "x-bak__". Manual SQL Execution:pro This options requires that you manually run your own SQL import to an existing database before running the installer. When this action is selected the database.sql file found inside the archive.zip file will NOT be ran. The database your connecting to should already be a valid WordPress installed database. This option is viable when you need to run advanced search and replace options on the database. |
| 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 or host to valid for sure the name needed. To add a port number just append it to the host i.e. 'localhost:3306'. |
| Database | The name of the database to which this installation will connect and install the new tables and data into. Some hosts will require a prefix while others do not. Be sure to know exactly how your host requires the database name to be entered. |
| 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. |
Options
| Option | Details |
|---|---|
| Prefixpro* | By default, databases are prefixed with the cPanel account's username (for example, myusername_databasename). However you can ignore this option if your host does not use the default cPanel username prefix schema. Check the 'Ignore cPanel Prefix' and the username prefixes will be ignored. This will still require you to enter in the cPanels required setup prefix if they require one. The checkbox will be set to read-only if your host has disabled prefix settings. Please see your host full requirements when using the cPanel options. |
| Legacy | When creating a database table, the Mysql version being used may not support the collation type of the Mysql version where the table was created.
In this scenario, the installer will fallback to a legacy collation type to try and create the table. This value should only be checked if you receive an error when
testing the database.
For example, if the database was created on MySQL 5.7 and the tables collation type was 'utf8mb4_unicode_520_ci', however your trying to run the installer on an older MySQL 5.5 engine that does not support that type then an error will be thrown. If this option is checked then the legacy setting will try to use 'utf8mb4_unicode_520', then 'utf8mb4', then 'utf8' and so on until it runs out of options. For more information about this feature see the online FAQ question titled "What is Compatibility mode & ' collation' errors" |
| Spacing | 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 |
| Mode | The MySQL mode option will allow you to set the mode for this session. It is very useful when running into conversion issues. For a full overview please see the MySQL mode documentation specific to your version. |
| Charset | 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. |
| 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 collation set should be. |
Validation
Testing the database connection is important and can help isolate possible issues that may arise with database version and compatibility issues.| Option | Details |
|---|---|
| Test Database |
The 'Test Database' button will help validate if the connection parameters are correct for this server and help with details about any issues that may arise. |
| Troubleshoot |
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 - Visit the online resources 'Common FAQ page' |
Step 3 of 4: Update Data
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.Replace pro
This section will allow you to add as many custom search and replace items that you would like. For example you can search for other URLs to replace. Please use high caution when using this feature as it can have unintended consequences as it will search the entire database. It is recommended to only use highly unique items such as full URL or file paths with this option.Options
| Option | Details |
|---|---|
| New Admin Account | |
| Username | A new WordPress 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 new user. Must be at least 6 characters long. |
| Scan Options | |
| Cleanup pro | The checkbox labeled Remove schedules & storage endpoints will empty the Duplicator schedule and storage settings. This is recommended to keep enabled so that you do not have unwanted schedules and storage options enabled. |
| Old URL | The old URL of the original values that the package was created with. These values should not be changed, unless you know the underlying reasons |
| Old Path | The old path of the original values that the package was created with. These values should not be changed, unless you know the underlying reasons |
| 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. |
| 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. Use this option if you have issues with data not updating correctly. |
| 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. |
| WP-Config File | |
| Config SSL | 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. The "Enforce on Login" will turn off SSL support for WordPress Logins. |
| Config Cache | 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. The "Keep Home Path" sets WPCACHEHOME in your wp-config file to nothing if true, otherwise nothing is changed. |
Step 4 of 4: Test Site
Final Steps
Review Install ReportThe install report is designed to give you a synopsis of the possible errors and warnings that may exist after the installation is completed.
Test Site
After the install is complete run through your entire site and test all pages and posts.
Security Cleanup
When you're completed with the installation please delete all installation files. Leaving these files on your server can impose a security risk!
Troubleshooting Tips
Common Quick Fix Issues:
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 and package file and then browse to the installer 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.
- 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
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 and package file and then browse to the installer 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 additional help please visit the online resources