Knowledgebase
LifeInTheGrid.com > Support Center > Knowledgebase

Ask a question:


Solution

Duplicator - User Guide

The Duplicator plugin gives Wordpress Administrators and Developers the ability to migrate/clone a site from one location to another location. First create a package, download it and install. No need to change your settings and re-run import/export scripts. The plugin also serves as a simple backup utility. The Duplicator also supports both serialized and base64 serialized string replacement.

Wordpress Duplicator ©lifeinthegrid.com

Sections

Please see the FAQ page and changelog for more in-depth diagnostics and troubleshooting.

Installation
 

Requirements

  • PHP 5.2.17+
  • Safe Mode set to Off
  • Zlib compression enabled
  • WordPress 3.4+
Extract the zip file and just drop the contents in the /wp-content/plugins/directory of your WordPress installation and then activate the Plugin from Plugins page. Then click on Tools, duplicator from the admin left side navigation

Plugin Interface
 

» Dashboard


To create click the create button and enter a package name. After a package is created you can click on the 'Package' and 'Installer' buttons to download to your computer.

A progress bar will show when creating a Package Set. For larger sites this can take several minutes (but never hours). To diagnose any issues that may come up you can click the show create log file button in the toolbar. This will open a new window that indicates everything that is happening during the package creation process.   

Main Screen The main screen for all package sets allows you to manage multiple packages.

Packages Page Buttons
Option Description
Main Screen Create Creates both the package.zip and installer.php file used to restore/duplicate/clone your site.
Main Screen Options Opens the package options dialog which contains various settings for managing your installer and packages.
Main Screen System Opens the system check dialog which helps to identify any issues with your servers configuration and setup.
Main Screen Log File Shows important logging information about the last attempt at creating a package.
Bulk Actions Use this option to control actions across multiple packages.
SQL File Link A full export script of your database.
Download Links Use these links to share your package, sql, and installer files. Please share with caution!



» Package Options Dialog


The package options dialog is used to control settings for how packages are created and what will show up in the installer at install time. The package tab contains settings for the processing of the package. The installer tab is used to pre-fill the installer screen if you want.

Please note if you are working with a very large site (anything over 300MB) it is recommended to exclude larger files or directories to improve the speed and accuracy of the archive process and allow for the process to complete on some hosts.

If your server times out during the creation process then you may need to filter down your content to only what is needed. You can then manually copy over the filtered data as needed.

You will need to manually move any directories/files that you filter as they will not be included in the package file.
Options Dialog
Options Settings
Option Description
Email Complete Check this box if you want an e-mail when the package finishes (use semicolon for multiple emails)
Directory Filter The directories you do not want to be included in your package. Use semicolon to separate
File Extensions A list of file extensions you do not want included in your package. (example: txt;mpg;mov)



» System Checks


Systems Requirements help to validate the compatibility of your server with the plugin. See the FAQ page for a breakdown of the various requirements. This interface shows the items on your system that either Pass/Fail a given scan. These items must pass before a system check can be pre-formed.

System Check are not required, but can cause issues if they fail. It is recommended to try and get all checks green if possible.

The Pre-Zip Overview performs a scan to show the size of all the files and folders you plan to archive. This scan does not include any of the filtered items entered in the options dialog. The scan will show an error if a file is too large to be include in the zip achieve (usually files larger that 2GB).

If you run into troubles with your hosting provider we have an Approved Hosting Program that can get you duplicating your site(s) fast!

Options Dialog



» Create Package Log


The Create Package Log allows you to get a deeper rundown of all the processes that are being performed during the package creation process. This log file contains sensitive data please share this logging data only with trusted sources. Do not post this data on public forums like the ones found at Wordpress.org.

The logging interface only shows the most recent attempt at creating a package. So every time you click the create package button it will write out a new log file.

You can refresh the log by clicking the refresh button or set it up to auto refresh every 10 seconds. This is helpful when you are monitoring the results of a large package this is being created.

Options Dialog

Installer Interface
 

» Step 1: Deploy


The installer interface is found by browsing to the installer.php file which should have been downloaded to the location of your choice along with the package file.  The installer interface consists of three steps. The first step extracts all your files and creates the new database. The second step performs the new updates to your database. The third steps asks to check your site and gives a report of the process.

To validate your database connection settings just click on the 'Test Connection' button to see if the connection parameters will work. After clicking the install button the installer will begin to perform an extraction of all the WordPress files and the creation of the database. Some hosting providers will not allow for the allow database creation option to work. Therefore you will have to manually create the database yourself.

Checking the 'Allow Table Removal' will delete all tables in the database. Make sure you always have backups of all databases and files.

Options Dialog
Files & Database Options
Note: Currently only MySQL is supported.
Option Description
Log Level How much information will be logged to the install-log.txt file.
MySQL Server
Host The server name where the new database will be created. For hosted servers see your hosts documentation.
User A database user with enough permissions to create and modify tables in the database.
Password The password of the MySQL server user.
Database Name The database name on the host this installation will use to create the new database.
Database Creation Create the database if it does not exist (does not work on all servers)
Table Removal Remove all tables from the database if they exist. The installer requires an empty database.
Advanced Options
Manual Extraction This allows you to manually extract the zip archive on your own. This can be useful if your system does not have the ZipArchieve support enabled. Checking this box requires that you have already manually extracted the package on your server.
Non-breaking spaces 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 Charset These values should default to 'utf8' and 'utf_general_ci' only modify these values if your familiar with what your character set should be.
Disable SSL Admin Turn off SSL support for WordPress. This sets FORCE_SSL_ADMIN in your wp-config file to false.



» Step 2: Update


The update phase of the installer will update all the tables in your database, based on all of the 'Scan Tables' that were selected. By default all of your tables will be selected as part of the update process. The update process takes the old settings and converts them to the new settings. Searching through every cell of every selected table.

At install time users are also given the option to activate or deactivate the current plug-ins that are associated with the created package. By default all of the plug-ins will be activated that were originally activated when the package was created.

Disabling plug-ins can sometimes help you avoid or locate install errors. If you have issues with an install try to deactivate your plugins at install time.

Options Dialog
Update Data Options
Option Description
Old Settings
URL The URL this package was originally archived with. This is the 'WordPress address (URL)' found in the WordPress administrator (value is read-only). This value can be changed however it could possible cause your install to have issues.
Path The server path this package was originally archived with. This value can be changed however it could possible cause your install to have issues.
New Settings
URL This will be the new WordPress URL. This should be the same location where this installer.php file is located. Example http://myserver/path_to_wordpress_root
Path This will be the new server path. This should be the same location where this installer.php file is located on the server. Example /home/html/path_to_wordpress_root
Title This will be the new title of the Wordpress site. The value defaults to what the package was created with.
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. This feature is optional. If the username already exists the account will NOT be created or updated.
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.



» Step 3: Test


Once the installation is complete follow the final steps and your WordPress site should be ready to go. Be sure to validate all pages of your site and make changes as necessary. The duplicator tries to perform the best updates and replaces that it can however sometimes certain items can be missed.

Its very important that you remove the following files when you're done with an installation: installer.php, installer-log.txt, installer-data.sql   Leaving these files on your server could pose a potential security risk and will also cause issues if you try to re-deloy.

Click the 'Delete Installer Files' link to remove the install files (requires admin login).
Options Dialog
Table Data Options
Option Description
Old Settings
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.



Video Tutorials
 


» Video: cPanel Database Setup


Video Overview:
This video describes how to create a cPanel database and use the Duplicator to connect to it. We will see how to create the database and user account.

If your interested in using the hosting providers seen in this video please check out either of the following links or check out our approved hosting provider page.



» Video: Windows to Linux & Permission Modifications


Video Overview:
This video covers moving a WordPress site from Windows to Linux. The video covers how to adjust permission on Linux so that the files can be read and processed correctly.

This video was made with a much older version of the Duplicator. The screens won't be in sync with newer versions but the process of modifying permissions may come in handy.
   


» Video: Other Online Videos



1. From MAMP to Hosted Server by: Paal Joachim on YouTube

2. Quick Duplicator Guide by: Daniel Archer Mocial Sedia

3. Duplicator Walkthrough by: Mike Simmons


Commercial WordPress Plugins and Widgets...
Code Canyon Scripts


Article details
Article ID: 3
Category: WordPress Duplicator
Date added: 2011-04-22 18:02
Views: 35176

 
« Go back

 
Powered by Help Desk Software HESK - brought to you by Help Desk Software SysAid