BackupBuddy: ImportBuddy Rough Draft

From IThemes Codex
(Difference between revisions)
Jump to: navigation, search
(Manually Downloading and Uploading to Destination Server)
(The 6 ImportBuddy Steps)
 
(44 intermediate revisions by one user not shown)
Line 1: Line 1:
'''ImportBuddy''' is the tool that allows you to [[BackupBuddy:_Migrations|migrate]] or [[BackupBuddy:_Restore|restore]] a site with BackupBuddy.  
+
'''ImportBuddy''' (importbuddy.php) is the tool that allows you to [[BackupBuddy:_Migrations|migrate]] or [[BackupBuddy:_Restore|restore]] a site with BackupBuddy. Keep a copy of the ImportBuddy script with your backups for restoring sites directly from backups.  
  
 
<br />
 
<br />
Line 5: Line 5:
 
=ImportBuddy Password=
 
=ImportBuddy Password=
  
To use ImportBuddy, you'll first need to set a password.   
+
To use ImportBuddy, you'll first need to set a password.  ImportBuddy requires this to protect unauthorized access to your site and backup files before you have finished restoring.
 +
 
 +
* This password is encoded inside your <code>importbuddy.php</code> file when it is made, so:
 +
** If you share this <code>importbuddy.php</code> file to another for usage with a backup file you will need to provide the corresponding password.
 +
** If you change the password will need to download a new copy of <code>importbuddy.php</code>. Changing the password will NOT change it in existing <code>importbuddy.php</code> files.
  
<br />
 
  
 
#To set your password, navigate to '''BackupBuddy > Settings''' and enter the password you'd like to use in the [[BackupBuddy_Settings:_General#ImportBuddy_.26_RepairBuddy_password|ImportBuddy & RepairBuddy password]] section.<br /><br /><br />[[File:IBPassword.png|IBPassword.png|link=]]<br /><br /><br />
 
#To set your password, navigate to '''BackupBuddy > Settings''' and enter the password you'd like to use in the [[BackupBuddy_Settings:_General#ImportBuddy_.26_RepairBuddy_password|ImportBuddy & RepairBuddy password]] section.<br /><br /><br />[[File:IBPassword.png|IBPassword.png|link=]]<br /><br /><br />
 
#You can also set a password when you [[#Download|download ImportBuddy]]. If you set a password when downloading ImportBuddy, it overrides the password you created in your BackupBuddy Settings.  If you leave the option blank, it will use the default password you created in your settings.<br /><br /><br />[[File:ImportBuddyDownloadPassword.png|ImportBuddyDownloadPassword.png|link=]]<br /><br /><br />
 
#You can also set a password when you [[#Download|download ImportBuddy]]. If you set a password when downloading ImportBuddy, it overrides the password you created in your BackupBuddy Settings.  If you leave the option blank, it will use the default password you created in your settings.<br /><br /><br />[[File:ImportBuddyDownloadPassword.png|ImportBuddyDownloadPassword.png|link=]]<br /><br /><br />
 
#An ImportBuddy password can also be set during the [[BackupBuddy:_Quick_Setup#2._Create_a_password_for_restoring_or_migrating_your_backups|Quick Setup]] page after first installing BackupBuddy.
 
#An ImportBuddy password can also be set during the [[BackupBuddy:_Quick_Setup#2._Create_a_password_for_restoring_or_migrating_your_backups|Quick Setup]] page after first installing BackupBuddy.
 +
 +
<br />
  
 
=Accessing ImportBuddy=
 
=Accessing ImportBuddy=
Line 17: Line 22:
 
After setting your ImportBuddy password, there are two ways you can access ImportBuddy:
 
After setting your ImportBuddy password, there are two ways you can access ImportBuddy:
  
<br />
+
*Manually downloading (and then uploading to destination server)
 
+
*Manually downloading and uploading to destination server
+
 
*Sending to destination from within BackupBuddy
 
*Sending to destination from within BackupBuddy
  
Line 25: Line 28:
  
 
==Manually Downloading and Uploading to Destination Server==
 
==Manually Downloading and Uploading to Destination Server==
 +
 +
To manually download ImportBuddy and upload to your destination server, follow these steps:
 +
 +
<br />
  
 
===Manually Downloading ImportBuddy===
 
===Manually Downloading ImportBuddy===
Line 32: Line 39:
 
#To download ImportBuddy, navigate to the '''Restore/Migrate''' page in BackupBuddy and click the '''Download ImportBuddy''' button. This will initiate the download of the ImportBuddy file.<br /><br /><br />[[File:DownloadImportBuddy.png|DownloadImportBuddy.png|link=]]<br /><br /><br />
 
#To download ImportBuddy, navigate to the '''Restore/Migrate''' page in BackupBuddy and click the '''Download ImportBuddy''' button. This will initiate the download of the ImportBuddy file.<br /><br /><br />[[File:DownloadImportBuddy.png|DownloadImportBuddy.png|link=]]<br /><br /><br />
 
#Save the file to your computer.  
 
#Save the file to your computer.  
#You will next upload this file to your destination server to begin using it.
+
#You will next [[BackupBuddy:_ImportBuddy_Rough_Draft#Uploading_ImportBuddy_to_your_destination_server|upload the ImportBuddy file to your destination server]] to begin using it.
  
 
<br />
 
<br />
  
 
===Uploading ImportBuddy to your destination server===
 
===Uploading ImportBuddy to your destination server===
 +
 +
<br />
 +
 
#Decide on the FTP directory that you would like to migrate or restore the backup to (using an empty directory is best) that corresponds to the web URL you want your destination site to be at. For example, if you want your new site's URL to be "http://your.com/mybuddy/" then your server directory MIGHT be something like <code> /user/yourusername/public_html/mybuddy/</code>. This is the directory you will then put importbuddy.php into. '''Note:''' The directory structure varies host to host but often follows a similar format.
 
#Decide on the FTP directory that you would like to migrate or restore the backup to (using an empty directory is best) that corresponds to the web URL you want your destination site to be at. For example, if you want your new site's URL to be "http://your.com/mybuddy/" then your server directory MIGHT be something like <code> /user/yourusername/public_html/mybuddy/</code>. This is the directory you will then put importbuddy.php into. '''Note:''' The directory structure varies host to host but often follows a similar format.
 
#Upload <code>importbuddy.php</code> and your backup zip file to the FTP directory that corresponds to your desired URL.
 
#Upload <code>importbuddy.php</code> and your backup zip file to the FTP directory that corresponds to your desired URL.
Line 42: Line 52:
 
#To complete the migration or restoration process, visit the [[BackupBuddy:_Manual_Migration|Manual Migration]] page.
 
#To complete the migration or restoration process, visit the [[BackupBuddy:_Manual_Migration|Manual Migration]] page.
  
==Sending ImportBuddy to Destination==
+
<br />
  
 
<br />
 
<br />
  
Instead of downloading ImportBuddy, you can send ImportBuddy directly to the location of your migration/restoration.
+
==Sending ImportBuddy to Destination==
 +
 
 +
Instead of manually downloading ImportBuddy, you can send ImportBuddy directly to the location of your migration/restoration from within BackupBuddy.
  
 
<br />
 
<br />
Line 52: Line 64:
 
#To send ImportBuddy to a destination, navigate to the '''Restore/Migrate''' page in BackupBuddy and click the '''Send ImportBuddy to a Destination'''.<br /><br /><br />[[File:ImportBuddySendtoDestination.png|ImportBuddySendtoDestination.png|link=]]<br /><br /><br />
 
#To send ImportBuddy to a destination, navigate to the '''Restore/Migrate''' page in BackupBuddy and click the '''Send ImportBuddy to a Destination'''.<br /><br /><br />[[File:ImportBuddySendtoDestination.png|ImportBuddySendtoDestination.png|link=]]<br /><br /><br />
 
#In the window that opens, you be given options for where to send the ImportBuddy file. You'll find a list of your current remote destinations and an option to create a new destination.<br /><br /><br />[[File:ImportBuddyDestinationOptions.png|ImportBuddyDestinationOptions.png|link=]]<br /><br /><br />
 
#In the window that opens, you be given options for where to send the ImportBuddy file. You'll find a list of your current remote destinations and an option to create a new destination.<br /><br /><br />[[File:ImportBuddyDestinationOptions.png|ImportBuddyDestinationOptions.png|link=]]<br /><br /><br />
#Follow the steps for [[BackupBuddy:_Manual_Migration|Manual Migration]] or [[BackupBuddy:_Magic_Migration|Magic Migration]].
+
#Follow the steps for [[BackupBuddy:_Manual_Migration|Manual Migration]].
 +
 
 +
<br />
 +
 
 +
=The 6 ImportBuddy Steps=
 +
 
 +
For more information on the ImportBuddy migration/restore process, visit the following links:
 +
 
 +
*[[BackupBuddy:_Manual_Migration#The_6_ImportBuddy_Steps_for_Manual_Migrations|The 6 ImportBuddy Steps for Manual Migrations]]
 +
*[[BackupBuddy:_Magic_Migration#The_6_ImportBuddy_Steps_for_Magic_Migrations|The 6 ImportBuddy Steps for Magic Migrations]]
 +
 
 +
<br />
 +
 
 +
=Advanced Options=
 +
ImportBuddy's '''Advanced Options''' allow customization of various ImportBuddy functionality for custom purposes or troubleshooting. '''Exercise caution as some advanced options may have unforeseen effects if not used properly, such as overwriting existing files or erasing existing database content.'''
 +
 
 +
Advanced Options can be located after clicking the '''Advanced Options''' button during Step 1 and 4 the [[BackupBuddy:_ImportBuddy_Rough_Draft#The_6_ImportBuddy_Steps|6 ImportBuddy Steps]].
 +
 
 +
<br />
 +
 
 +
[[File:Step1-advanced-options.png|link=]]
 +
 
 +
<br />
 +
 
 +
'''Step 1 Advanced Options:'''
 +
 
 +
*'''ZIP Archive Extraction (Step 2)'''
 +
**'''Skip zip file extraction''' - Checking this box will prevent extraction/unzipping of the backup ZIP file.  You will need to manually extract it either on your local computer then upload it or use a server-based tool such as cPanel to extract it. This feature is useful if the extraction step is unable to complete for some reason.
 +
**'''Force medium speed compatibility mode (ZipArchive)''' - Bypass attempting to use command line zip. Rarely needed; troubleshooting.
 +
**'''Force slow speed compatibility mode (PCLZip)''' - Bypass both high speed mode and medium speed mode, falling back all the way to PCLZip (slow speed). Rarely needed; troubleshooting.
 +
 
 +
*'''Database Import & Migration (Steps 3-5)'''
 +
**Select the "Adanced Options" button while on Step 3 for database options.
 +
 
 +
*'''General'''
 +
**'''Skip migration of .htaccess file''' - Rarely used; for technical purposes only.
 +
**'''Show detailed PHP warnings'''
 +
 
 +
*'''Import Logging''' - Errors and other debugging information will be written to importbuddy.txt in the same directory as importbuddy.php.  This is useful for debugging any problems encountered during import.  Support may request this file to aid in tracking down any problems or bugs.
 +
 
 +
<br />
 +
 
 +
[[File:Screen Shot 2013-08-13 at 12.33.03 PM.png|link=]]
 +
 
 +
<br />
 +
 
 +
'''Step 4 Advanced Options''':
 +
 
 +
*'''Database Import (Step 4)'''
 +
**'''Skip import of database'''
 +
**'''Delete database tables that match new prefix on import''' - WARNING: Checking this box will have this script clear ALL existing data from your database that match the new database prefix prior to import, possibly including non-WordPress data. This is useful if you are restoring over an existing site or repairing a failed migration. Use caution when using this option and double check the destination prefix. This cannot be undone.
 +
**'''Delete ALL database tables, erasing ALL database content''' - WARNING: Checking this box will have this script clear ALL existing data from your database, period, including non-WordPress data found. Use with extreme caution, verifying you are using the exact correct database settings. This cannot be undone.
 +
**'''Force database import compatibility (pre-v3.0) mode'''
 +
**'''Ignore existing WordPress tables and import (merge tables) anyways''' -  When checked ImportBuddy will allow importing database tables that have the same name as existing tables. This results in a merge of the existing data with the imported database being merged. Note that this is does NOT update existing data and only ADDS new database table rows. All other SQL conflict errors will be suppressed as well. Use this feature with caution.
 +
 
 +
*'''Maximum time allowed per import chunk'''
 +
 
 +
*'''Database Migration (Step 5)'''
 +
**'''Skip all migration of URLs/paths in database''' - Skip extended brute force migration of URLS/paths in database.
 +
**'''Skip extended brute force migration of URLS/paths in database''' - By default BackupBuddy will extensively examine and migrate unknown database tables.  Sometimes however this can cause timeouts on larger sites.  You may skip this intensive procedure to reduce required runtime for database migration steps. Note that some URLs or paths may not be updated if skipping this step.  All major WordPress URLs and paths will still be updated however.
 +
 
 +
=See also=
 +
*[[BackupBuddy_Restore/Migrate:_Introduction|Introduction]]
 +
*ImportBuddy
 +
*[[BackupBuddy:_Migrations|Migrations]]
 +
**[[BackupBuddy:_Manual_Migration|Manual Migration]]
 +
**[[BackupBuddy:_Magic_Migration|Magic Migration]]
 +
*[[BackupBuddy:_Restore|Restore]]
 +
**[[BackupBuddy:_View_and_Restore_Individual_Files|Individual File View & Restore]]
 +
 
 +
<br />
 +
[[:BackupBuddy_Test|← Back to BackupBuddy Codex Home]]

Latest revision as of 15:20, August 13, 2013

ImportBuddy (importbuddy.php) is the tool that allows you to migrate or restore a site with BackupBuddy. Keep a copy of the ImportBuddy script with your backups for restoring sites directly from backups.


Contents

ImportBuddy Password

To use ImportBuddy, you'll first need to set a password. ImportBuddy requires this to protect unauthorized access to your site and backup files before you have finished restoring.

  • This password is encoded inside your importbuddy.php file when it is made, so:
    • If you share this importbuddy.php file to another for usage with a backup file you will need to provide the corresponding password.
    • If you change the password will need to download a new copy of importbuddy.php. Changing the password will NOT change it in existing importbuddy.php files.


  1. To set your password, navigate to BackupBuddy > Settings and enter the password you'd like to use in the ImportBuddy & RepairBuddy password section.


    IBPassword.png


  2. You can also set a password when you download ImportBuddy. If you set a password when downloading ImportBuddy, it overrides the password you created in your BackupBuddy Settings. If you leave the option blank, it will use the default password you created in your settings.


    ImportBuddyDownloadPassword.png


  3. An ImportBuddy password can also be set during the Quick Setup page after first installing BackupBuddy.


Accessing ImportBuddy

After setting your ImportBuddy password, there are two ways you can access ImportBuddy:

  • Manually downloading (and then uploading to destination server)
  • Sending to destination from within BackupBuddy


Manually Downloading and Uploading to Destination Server

To manually download ImportBuddy and upload to your destination server, follow these steps:


Manually Downloading ImportBuddy


  1. To download ImportBuddy, navigate to the Restore/Migrate page in BackupBuddy and click the Download ImportBuddy button. This will initiate the download of the ImportBuddy file.


    DownloadImportBuddy.png


  2. Save the file to your computer.
  3. You will next upload the ImportBuddy file to your destination server to begin using it.


Uploading ImportBuddy to your destination server


  1. Decide on the FTP directory that you would like to migrate or restore the backup to (using an empty directory is best) that corresponds to the web URL you want your destination site to be at. For example, if you want your new site's URL to be "http://your.com/mybuddy/" then your server directory MIGHT be something like /user/yourusername/public_html/mybuddy/. This is the directory you will then put importbuddy.php into. Note: The directory structure varies host to host but often follows a similar format.
  2. Upload importbuddy.php and your backup zip file to the FTP directory that corresponds to your desired URL.
  3. Navigate to the importbuddy.php file in your web browser after it has been uploaded. Example: http://newsite.com/importbuddy.php
  4. To complete the migration or restoration process, visit the Manual Migration page.



Sending ImportBuddy to Destination

Instead of manually downloading ImportBuddy, you can send ImportBuddy directly to the location of your migration/restoration from within BackupBuddy.


  1. To send ImportBuddy to a destination, navigate to the Restore/Migrate page in BackupBuddy and click the Send ImportBuddy to a Destination.


    ImportBuddySendtoDestination.png


  2. In the window that opens, you be given options for where to send the ImportBuddy file. You'll find a list of your current remote destinations and an option to create a new destination.


    ImportBuddyDestinationOptions.png


  3. Follow the steps for Manual Migration.


The 6 ImportBuddy Steps

For more information on the ImportBuddy migration/restore process, visit the following links:


Advanced Options

ImportBuddy's Advanced Options allow customization of various ImportBuddy functionality for custom purposes or troubleshooting. Exercise caution as some advanced options may have unforeseen effects if not used properly, such as overwriting existing files or erasing existing database content.

Advanced Options can be located after clicking the Advanced Options button during Step 1 and 4 the 6 ImportBuddy Steps.


Step1-advanced-options.png


Step 1 Advanced Options:

  • ZIP Archive Extraction (Step 2)
    • Skip zip file extraction - Checking this box will prevent extraction/unzipping of the backup ZIP file. You will need to manually extract it either on your local computer then upload it or use a server-based tool such as cPanel to extract it. This feature is useful if the extraction step is unable to complete for some reason.
    • Force medium speed compatibility mode (ZipArchive) - Bypass attempting to use command line zip. Rarely needed; troubleshooting.
    • Force slow speed compatibility mode (PCLZip) - Bypass both high speed mode and medium speed mode, falling back all the way to PCLZip (slow speed). Rarely needed; troubleshooting.
  • Database Import & Migration (Steps 3-5)
    • Select the "Adanced Options" button while on Step 3 for database options.
  • General
    • Skip migration of .htaccess file - Rarely used; for technical purposes only.
    • Show detailed PHP warnings
  • Import Logging - Errors and other debugging information will be written to importbuddy.txt in the same directory as importbuddy.php. This is useful for debugging any problems encountered during import. Support may request this file to aid in tracking down any problems or bugs.


Screen Shot 2013-08-13 at 12.33.03 PM.png


Step 4 Advanced Options:

  • Database Import (Step 4)
    • Skip import of database
    • Delete database tables that match new prefix on import - WARNING: Checking this box will have this script clear ALL existing data from your database that match the new database prefix prior to import, possibly including non-WordPress data. This is useful if you are restoring over an existing site or repairing a failed migration. Use caution when using this option and double check the destination prefix. This cannot be undone.
    • Delete ALL database tables, erasing ALL database content - WARNING: Checking this box will have this script clear ALL existing data from your database, period, including non-WordPress data found. Use with extreme caution, verifying you are using the exact correct database settings. This cannot be undone.
    • Force database import compatibility (pre-v3.0) mode
    • Ignore existing WordPress tables and import (merge tables) anyways - When checked ImportBuddy will allow importing database tables that have the same name as existing tables. This results in a merge of the existing data with the imported database being merged. Note that this is does NOT update existing data and only ADDS new database table rows. All other SQL conflict errors will be suppressed as well. Use this feature with caution.
  • Maximum time allowed per import chunk
  • Database Migration (Step 5)
    • Skip all migration of URLs/paths in database - Skip extended brute force migration of URLS/paths in database.
    • Skip extended brute force migration of URLS/paths in database - By default BackupBuddy will extensively examine and migrate unknown database tables. Sometimes however this can cause timeouts on larger sites. You may skip this intensive procedure to reduce required runtime for database migration steps. Note that some URLs or paths may not be updated if skipping this step. All major WordPress URLs and paths will still be updated however.

See also


← Back to BackupBuddy Codex Home

Personal tools
Namespaces
Variants
Actions
iThemes Codex
Codex Navigation
Toolbox