WordPress Duplicator - User Guide

Overview

Step-By-Step

1. Download Duplicator Pro Plugin zip file to your desktop.
   - After purchase you will receive an email with a download link
   - You can also login to your SnapCreek Dashboard and download that latest version.
2. Login to your WordPress Administrator and click "Plugins".
3. Click the "Add New" button.
4. Click the "Upload Plugin" button.
5. Click the "Choose File" and select the Duplicator Pro zip file and click "Install Now".
6. Click Activate to activate it.

Walk-through

1. Install and Activate the plugin
2. Go to Duplicator Pro ❯ Settings ❯ Licensing ❯ Enter Your License Key
   - Your license key will be sent to you via email after you purchase OR login to your dashboard to view your keys
   

Overview

Overview

Hooks

Setup

//Before build starts function callback
function __duplicator_pro_build_before_start_test_function() {
$var  = "\n------------------------------------------------\n";
$var .= "Testing: duplicator_pro_build_before_start hook\n";
$var .= "------------------------------------------------\n";
error_log(print_r($var, true));
}

//Build completes function callback
function __duplicator_pro_build_completed_test_function() {
$var  = "\n------------------------------------------------\n";
$var .= "Testing: duplicator_pro_build_before_start hook\n";
$var .= "------------------------------------------------\n";
error_log(print_r($var, true));
}

//Add Actions
add_action( 'duplicator_pro_build_before_start', '__duplicator_pro_build_before_start_test_function');
add_action( 'duplicator_pro_build_completed', '__duplicator_pro_build_completed_test_function');

function deleteAllTransientsOnPackageCreation() {
global $wpdb;

$sql = 'DELETE FROM ' . $wpdb->options . ' WHERE option_name LIKE "_transient_%"';
$wpdb->query($sql);
}

add_action( 'duplicator_pro_build_before_start', 'deleteAllTransientsOnPackageCreation');

function sendSlackMessage($msg) {
// SEE SLACK WEBHOOK API (https://api.slack.com/messaging/webhooks)
$slackWebhook = 'https://hooks.slack.com/services/[XXX]/[YYY]/[ZZZ]';
$postfields = array('payload' => json_encode(array('text' => $msg)));

$ch = curl_init($slackWebhook);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $postfields);
curl_exec($ch);
curl_close($ch);
}

function sendSlackStartMessage(DUP_PRO_Package $package) {
sendSlackMessage(
	"DUPLICATOR BUILD START [" . date("Y-m-d H:i:s") . "]\n" .
	"Package name: " . $package->Name
);
}

function sendSlackFailMessage(DUP_PRO_Package $package) {
sendSlackMessage(
	"DUPLICATOR BUILD FAIL\n" .
	"Package name: " . $package->Name
);
}

function sendSlackCompleteMessage(DUP_PRO_Package $package) {
sendSlackMessage(
	"DUPLICATOR BUILD COMPLETE [" . date("Y-m-d H:i:s") . "]\n" .
	"Package name: " . $package->Name
);
}

add_action( 'duplicator_pro_build_before_start', 'sendSlackStartMessage');
add_action( 'duplicator_pro_build_fail', 'sendSlackFailMessage');
add_action( 'duplicator_pro_build_completed', 'sendSlackCompleteMessage');

Overview

Details

Overview

Details

Storage

Archive

Installer

Overview

Details

Overview

Details

Overview

1. Give the package a name
   Click the Notes button to add notes (optional).
2. Open the 'Storage' section and choose a storage location
3. Edit how the archive file will be created and its contents (optional).
   Optional: Open the 'Archive' section and check the 'Enable File Filters' checkbox
   • Add to the 'File Extensions' input the value log this will exclude all log files with a log extention
   • Add to the 'Files' input the value error_log this will exclude all files named error_log
   • Add any additional files to exclude and be sure to enter the full path of the file such as //public_html/mysite.com/myfile.zip
4. Edit the installer inputs. These values will be shown at install time in the installer inputs (optional).
5. Click the Next Button & let the scanner run.

Walk-throughs

Overview

1. Start: Goto Duplicator Pro ❯ Packages ❯ click the 'Details Button' ❯ 'Transfer'
2. Choose Location (Step 1):
   • Choose the location(s) where you would like to copy the package files (archive.zip/daf installer.php) to.
   • If the location does not exist then click the 'Create New Storage' link.
3. Transfer Files (Step 2):
   
   • Once you have chosen your transfer location click the 'Start Transfer' button.
   • Once the transfer is complete you will see the data in the transfer log.

Overview:

Use Cases:

• Staging: Drag-n-Drop imports are perfect for staging sites where you quickly want to overwrite an existing site.
• Beginners: If you are new to WordPress or have a limited IT background the Drag-n-Drop import will be very helpful in the migration process. With the import feature you don't have to worry about setting up a database or learning FTP. You can simply use the existing settings from a WordPress site that already exists.

Details:

• Upload Area: The top half controls the options and actions around the upload of the archive.zip/daf file.
• Archive Area: The bottom half shows the archives that have been successfully uploaded.

Details:

• Recovery Point: This section explains how to set a recovery point.
• System Overview: The section give a high level overview of your site and some of its meta-data.

Recovery Point

Details:

1. Build Package: Build a package on the source site. It’s important to not filter any tables or core WordPress directories (these are required for Drag and Drop to work with the package)
2. Save Package: Click the Download button on the row associated with the package you built in step 1 and click the “Archive” option to save the installer.php and archive to your local PC.
3. Install Plugin: Install the Duplicator Pro plugin just like you did on the source site (Plugins ❯ Add New ❯ Upload then Activate)
4. Upload Archive: Go to Duplicator Pro ❯ Import ❯ Drag the archive you downloaded on step 2 to the import area of the destination site to start the upload process and review archive details.
5. Recovery Point: Set an optional (see above) if needed.
6. Launch Installer: Launch the installer and continue through the wizard screens.

Overview:

Details:

Details:

1. Start: Goto Duplicator Pro ❯ Schedules ❯ click the 'Add New' button in the upper right corner.
   • Name: Give the schedule a descriptive name for example see Add/Edit section above.
   • Copy From: Optionally copy from an existing schedule see "Copy From" in upper left.
2. Template: Select existing template, choose default or add a new template.
   • Existing Template: If you have already created a template and know the settings of that template and would like to re-use it then select from the templates in the drop-down.
   • Default Template: The default template is an editable template, however when the plugin is first installed the default template does not have any filters and includes all the data from an existing WordPress site.
   • Add Template: A Template simply stores the layout for how you want to create a package. The Template allows users to exclude files/directories/extensions and database tables from being backed up. The process is almost identical to creating a package. For a complete overview on how to add/remove file and table filters visit the Archive section in the Packages » New - Step 1: Setup user guide.
3. Storage: Choose at least one storage location where the package and installer will be stored at.
4. Repeats: Choose the frequency and duration for how often the schedule should run.
5. Start Time: Choose the time of day you want the schedule to start on. Values are 00:00 (12am) to 23:00 (11pm).
6. Activated: Choose if the schedule is active to run. Finally save the schedule and wait for the schedule timed.

Overview:

Settings:

Step-By-Step:

1. Create New Storage Provider: Duplicator > Storage > Add New
2. Add Name and Notes and select Type: Local Server
3. Provide the full path on your local server to where the package will be stored
4. Leave the Filter Protection check-box checked
5. Enter the number of packages you want to persist for this storage location

Overview:

Settings:

Overview:

Settings:

Overview:

Settings:

Step-By-Step:

1. Create New Storage Provider: Duplicator > Storage > Add New
2. Add Name and Notes and select Type: Dropbox
3. Under Authorization: Click "Connect to Dropbox"
   • Step 1 Click Authorize Dropbox
   • This will open a new browser window/tab to dropbox.com
   • Click the "Allow" Button and wait for Success Message
   • Close the dropbox.com site window/tab and go back to Duplicators interface
   • Under Authorization Step 2: Click the Finalize button
   • Duplicator is now authorized to access the following Dropbox account
4. Click the 'Test Dropbox Connection' button to validate data can be moved between systems.
5. Finally Click the "Save Provider" button to save this Dropbox storage endpoint

Overview:

Settings:

Step-By-Step:

1. Create New Storage Provider: Duplicator > Storage > Add New
2. Add Name and Notes and select Type: Google Drive
3. Under Authorization: Click "Connect to Google Drive"
   • Step 1: Click Authorize Google Drive
   • This will open a new browser window/tab to accounts.google.com
   • If you have multiple Google accounts then choose the account you would like to use
   • Click the 'Allow' button and copy the long code generated.
   • Step 2: Go back to Duplicators interface and paste the code into the input titled Step 2
   • Step 3: Click the 'Finalize Setup' button
   • Duplicator is now authorized to access the following Google Drive account
4. Click the 'Test Google Drive Connection' button to validate data can be moved between systems.
5. Finally Click the "Save Provider" button to save this Google Drive storage endpoint

Overview:

Settings:

Step-By-Step:

1. Create New Storage Provider: Duplicator > Storage > Add New
2. Add Name and Notes and select Type: OneDrive
3. Under Authorization: Click "Connect to OneDrive"
   • Step 1 Click Authorize OneDrive
   • This will open a new browser window/tab to OneDrive.com to login.
     - OR -
     If your are logged in this step will be skipped.
   • A unique code will be generated at snapcreek.com from onedrive.com. Copy this code.
   • Under Authorization Step 2: Paste the unique code.
   • Under Authorization Step 3: Click the "Finalize Setup" button
   • Duplicator is now authorized to access the following OneDrive account
4. Click the 'Test OneDrive Connection' button to validate data can be moved between systems.
5. Finally Click the "Save Provider" button to save this OneDrive storage endpoint

Overview:

Settings:

Step-By-Step:

1. Create New Storage Provider: Duplicator > Storage > Add New
2. Add Name and Notes and select Type: FTP
3. Under Credentials: Enter in all the required FTP credentials
4. Click the 'Test FTP Connection' button to validate data can be moved between systems.
5. Finally Click the "Save Provider" button to save this FTP storage endpoint
6. For connections issues see the FTP troubleshooting FAQ.

Overview:

Settings:

Step-By-Step:

1. Create New Storage Provider: Duplicator > Storage > Add New
2. Add Name and Notes and select Type: SFTP
3. Under Credentials: Enter in all the required SFTP credentials
4. Click the 'Test SFTP Connection' button to validate data can be moved between systems.
5. Finally Click the "Save Provider" button to save this SFTP storage endpoint
6. For connections issues see the SFTP troubleshooting FAQ.

Resources:

• SFTP Setup - Filezilla - Siteground.
• How to connect to SFTP in Filezilla using private key

Overview:

1. Trace Log: ^Pro The trace log file records all information that is going on at all times with the plugin. Since multiple requests can be executed by multiple users the trace log takes all communication from the plugin into consideration and logs that data. To further improve the full picture of all activity going on in PHP on the server (not just Duplicator Pro). There is an options in Settings ❯ General ❯ Debug labeled "Enhanced Tracing" screen. This option will also log all trace log activity to the PHP error log.
2. Package Log: The package log is a log file that is generated for every package that is built. The log will show the progress and state of the package and will most errors/warnings that may happen during the creation of a package file.

Overview:

Stored Data:

Server Settings:

Scan Validator:

Overview:

• Lite: This allows anyone to get help with the free product. Response times can vary widely as all lite requests are handled after the pro users have been addressed. Response times can vary from 1-5 business days.
• Pro Personal: This support level is for all pro personal users. All tickets will be handled before Lite users, but after Pro Freelancer+ users. Response times for most requests will be within 2 days or less depending on the complexing of the response.
• Pro Freelancer/Business/Gold: This level includes all Freelancer/Business/Gold users. All tickets will be handled before Lite and Pro Personal users. Response times for most requests will be within 24 hours.

Overview:

Use Cases:

• Schedules: All schedules require templates to be used when running a schedule
• Profiling: There may be instances where you only want the database or the database with specific tables. There may be an instances where you only need the database with a certain subset of files. There are many different combinations that can make up your package and with templates you can easily and quickly assign these profiles when you start a build.

Overview:

Archive:

Installer:

Also see: Packages » New - Step 1: Setup

Create Template

1. Start: Goto Duplicator Pro ❯ Templates ❯ click the 'Add New' button in the upper right corner
2. Copy From: This is an optional step that will allow you to copy from an existing template
3. FILES: Apply any file filters to exclude specific file/directories/extensions
4. DATABASE: Apply any table filters that should not be included as part of the package
5. INSTALLER: Apply the installer setup values you would like to be applied to the package
6. Save: Save the template by clicking the 'Save Template' button.

Apply Template

1. Start: Goto Duplicator Pro ❯ Packages ❯ click the 'Create New' button in the upper right corner
2. Apply Template: The template you made in the step Create Template section above should be visible in the dropdown
3. After selecting your template all of the values in the Archive and Installer section should reflect the values saved in the template
4. To undo the applied template just select the [Unassigned] value and the package settings will default to its last created settings

Also see: Packages » New - Step 1: Setup
Also see: Schedules » Add/Edit

Overview:

Requirements:

• Local Server Storage
  Recovery points require one of the following 'Local Server' storage types:
  •   [Local Default] This is the default built-in local storage type.
  •   [Local Non-Default] This is a custom directory on this server.
• WordPress Core Folders
  A recovery point needs all WordPress core folders included in the package (wp-admin, wp-content & wp-includes).
• Primary Database Tables
  All database tables with the WordPress prefix (default is 'wp_') must be included in the package for this to be an eligible recovery point.

Use Cases:

• Full Restore - Yes
  A recovery point is currently only supported as a full backup of your site and use it as a recovery system. A recovery will capture your entire site and restore it exactly as it was pending you don't create any file or database table filters.
• Partial Restore - No
  To try and restore portions of your site you should not use the recovery point. Instead you should create an archive with the uploads folder filtered out, and then save that archive/installer off somewhere. If/when you need to restore your site you could just copy the installer and archive to the root of the site and browse to the installer. This will overwrite the database and any folders that are contained within the archive. For more details about this process see Various strategies for data migration Scenario 1-A.

Step By Step:

• Recovery Step 1: Choose a recovery point from the drop-down. Only valid packages that are "Recover capable" will be listed. Users can also use the "Packages view" to set a recovery point.
• Recovery Step 2: Copy the generated URL link to a safe location. This link can be used to reinstall the recover point that was created.
• Launch Installer: This will launch the installer wizard which will run users through the necessary steps to install the imported package.
• For a full step by step article see the article Quickly Restore a WordPress Site with a “Recovery Point”.

Overview:

Details:

Overview:

• Current Features: These are the current features that are available with this release.
• Beta Features: Features that can be tried but should not be used on production systems.
• Design Concepts: These are simply ideas that may or may not make it into the product.

Overview:

Export/Import:

• Export: The export section allows users to export all schedules, storage locations, templates and settings from this Duplicator Pro instance into a downloadable export file. The export file can then be used to import data settings from this instance of Duplicator Pro into another plugin instance of Duplicator Pro or the same instance if your need to restore from a previous date.
  
  After clicking the Export Data button the process will:
  • Export all schedules, storage and templates to a file for import into another Duplicator instance.
  • For security purposes, restrict access to this file and delete after use.
• Import: The import section allows users to import settings from another Duplicator Pro plugin into another instance of Duplicator Pro. Schedule, storage and template data will be appended to current data, while existing settings will be replaced. Schedules depend on storage and templates so importing schedules will require that storage and templates be checked. The import process will:
  
  
  • Append schedules, storage and templates if those options are checked
  • Overwrite current settings data if the settings option is checked
  After the import is ran its import to review templates and local storages to ensure correct path values as the import will not convert them.

Step By Step:

1. Check Data: Be sure all your schedules, storages, templates, and settings data is setup to your liking
2. Export: Navigate to Duplicator Pro ❯ Tools ❯ Data Tab and click the 'Export Data' button
3. Save Export: Save the export.dup file to a safe location as it contains sensitive information
4. Note location: Navigate to a different install unless your restoring a backup of a previous export
5. Select File: Choose the *.dup file used from the 'Save Export' step
6. Run Import: Click the 'Import Data' button and be sure to read all prompts
7. Check Data: Validate that all data was updated and note the following:
   • Schedule, storage and template data will be appended to the current data sets, if data exists. No data on these sections will be overwritten
   • All Settings from the Duplicator Pro ❯ Settings menu including all tabs General, Packages, Schedules, Storage, Licensing will be overwritten

Overview:

Details:

Overview:

Details:

Overview:

Brand Lists Screen:

Brand Details Screen:

Step By Step:

1. Goto Duplicator Pro ❯ Settings ❯ Packages Tab ❯ Installer Branding ❯ Add New
2. Fill in the Brand details and customize the look and feel
3. Check the Active check-box and click save
4. Build a package and download the installer/archive files to a location where the package can be installed.
5. In a web browser browse to the newly created installer.php file and observe the newly branded installer.

User Guide

Step By Step

Overview

• Plugin Settings
  • Duplicator Pro plugin menu appears on the Network Admin menu in Multisite vs the normal admin menu.
  • Package creation process for "Duplicator Pro - Business" includes extra filters for subsites.
• Installer Settings
  • The install process for Multisite contains additional mappings for subsites in all Pro versions.
  • Advanced features for subsites or subsite to standalone is only supported in "Duplicator Pro - Business"

Separate Domains

1. Installer Step 1 - Switch the to Advanced mode (upper right-hand corner)
2. Installer Step 3 - Choose 'Mapping' for 'Replace Mode'
3. Installer Step 3 - Set the new URLs appropriately for each subsite
4. Finish the install process

Localhost Setup

1. Open your hosts file in a text editor.
2. Add the following to the hosts file: 127.0.0.1 localhost.com
127.0.0.1 sub1.localhost.com
127.0.0.1 sub2.localhost.com

3. Save the hosts file
4. Browse to http://localhost.com/installer.php and proceed with the install.

Hosting Provider

Step-By-Step:

1. On the source site go to Duplicator Pro ❯ Packages ❯ Create New: build a package (archive/installer)
2. On the destination Multisite go to Duplicator Pro ❯ Import: Add the archive.zip/daf file from the standalone site
   1. After the archive file is uploaded, click the Launch Installer button
   2. On Step 2 of the import add or copy the recover point (optional) and click the Continue button
      Note: Recovery points are optional but are recommended in the event the install runs into issues.
3. On Import-Installer Step 1 choose Install single site on a Multisite network radio button
   1. Choose the Action drop-down with the action to add as new or replace existing subsite.
   2. Choose the Content Author and set the New Subsite URL slug. This can be any safe URL string.
   3. Click the Validate button and check the results then click Next button and let the installer run.
   4. When the installer is complete Step 2 with show with a status of the install.
      If a recovery point was set then then both an "Admin Login" and "Run Recovery" button will show.
   5. Click the Admin Login to the newly created site and validate the install process.

Step-By-Step:

1. On the source Multisite site goto: Duplicator Pro ❯ Packages ❯ Create New: build a package (archive/installer)
2. Copy package files (archive/installer) to the new host destination directory where the site will be installed
3. Browse to the installer.php in a web browser such as https://mynewhost.com/mysite_directory/installer.php
4. On installer Step 1 ❯ Overview - Installation Tab ❯ Install Type: choose "Convert subsite to standalone"
5. A dropdown containing all the subsites in the package will show. Choose one and continue with the install
6. The subsite chosen in Step 1 will be installed as a new standalone site

Step-By-Step:

1. On the source Multisite go to Duplicator Pro ❯ Packages ❯ Create New: build a package (archive/installer)
2. On the destination Multisite go to Duplicator Pro ❯ Import: Add the source Multisite archive.zip/daf file
   1. After the archive file is uploaded, click the Launch Installer button
   2. On Step 2 of the import add or copy the recover point (optional) and click the Continue button
      Note: Recovery points are optional but are recommended in the event the install runs into issues.
3. On Import-Installer Step 1 choose Install subsites on Multisite network radio button
   1. Choose the Subsite drop-down with the Multisite subsite you would like to import.
   2. Choose the Action drop-down with the action to add as new or replace existing subsite.
   3. Repeat above two steps for remaining subsites you wish to import.
   4. Click the Validate button and check the results then click Next button and let the installer run.
   5. When the installer is complete, Step 2 show a status of the install.
      If a recovery point was set then then both an "Admin Login" and "Run Recovery" button will show.
   6. Click the Admin Login to the newly created site and validate the install process.

Step-By-Step: