BackupBuddy

(Difference between revisions)
Jump to: navigation, search
(Server Recommendations (full functionality))
(45 intermediate revisions by 6 users not shown)
Line 1: Line 1:
'''Release date:''' February 11, 2010 (beta), March 3, 2010 (stable)
+
* '''New to BackupBuddy?''' Check out the [[BackupBuddy:_Getting_Started|Getting Started]] page.
= Documentation =
+
* '''Problems?''' Check out the [[BackupBuddy:_Frequent_Support_Issues|Frequently Seen Support Issues]] page.
== Settings Explained ==
+
* '''Need hosting?''' ''Hostgator Coupons'' are available to BackupBuddy customers [http://ithemes.com/forum/index.php?/topic/14012-hostgator-coupons-for-our-community/ here].
=== Enable ZIP Compression ===
+
* '''[http://ithemes.com/codex/page/BackupBuddy_Multisite BackupBuddy Multisite Codex]'''
When BackupBuddy creates a backup file this is always created as a ZIP archive format file. Whether or not the files that are included in the archive are compressed in size is an option and this setting enables you to choose whether or not files will be compressed when stored within the archive.
+
  
The choice of whether to use compression or not is based on a time/space trade-off: if files are compressed it takes longer to produce the archive but the archive will (in almost all cases) be smaller in size; where as if files are not compressed the archive takes less time to produce but will (in almost all cases) be larger.
+
=Tutorials=
  
The reason why a compressed archive takes longer to produce is of course because the mechanics of compressing files is processor intensive and slower than just copying file content from one place to another.
+
===Training Videos===
 +
For video training including walkthroughs & tutorials please see http://ithemes.com/backupbuddy-training/
  
The reason why, just sometimes, an archive containing compressed files may be larger than one containing the same files in an uncompressed form is that some of the files on your site may already be in a compressed format - particularly media files - and trying to compress an already compressed file, aside from being very processor intensive, can result in a larger file.
+
===Installing BackupBuddy===
  
The default for this setting is checked, meaning that compression is enabled - this is usually the best option for most sites as it gives a good balance between speed of producing the backup and the size of the backup file. Another reason why you might want compression enabled is if you have a large site which approaches the size limits of the standard ZIP archive file format - around 4GB. Provided that you have no time constraint in producing a backup file then enabling compression means that you will get your site into a zip archive which you might otherwise not do if the files were included without compression.
+
Check out the [[Installing BackupBuddy]] section to see how BackupBuddy can be uploaded and activated on Single sites or Multisite networks or Multisite sites.
  
On the other hand, if you have time constraints on producing your backup then you might want to consider disabling compression so that the backup file may be produced faster but of course at the expense of being larger.
+
===Getting Started===
 +
Check out the [[BackupBuddy:_Getting_Started|Getting Started]] page to backup your Single sites or Multisite networks.
  
Another reason you might want to consider disabling compression is if you have a large number of media files on your site - which as explained, may already be in a compressed format. It is worth experimenting in this case, try a backup with compression enabled, see how long it takes and how large the backup file is. Then try a backup with compression disabled and again how long does it take and how large is it. By comparing the two and based on your requirements and any other constraints you can decide whether it is better to have compression enabled or disabled on that specific site.
 
  
= Troubleshooting =
+
===Restore or Migrate===
* [[BackupBuddy: Advanced Usage]] - Ex: Restoring/Migrating Using a Database Backup
+
Learn to [[BackupBuddy:_ImportBuddy|Restore or Migrate]] your Single sites or Multisite networks with the latest importbuddy.php.
  
* [[BackupBuddy: Error Codes]]
 
  
* [[BackupBuddy: Advanced Debugging]]
+
===Settings Explained===
 +
Get in depth information about the various [[BackupBuddy:_Settings|Settings]].
  
* [[BackupBuddy: Hosts]] - List of some popular hosts and known issues.
 
  
* [[BackupBuddy: Local Development]] - How to develop sites locally then migrate them to a live site.
+
===Developing Locally===
 
+
Set up your computer to [[BackupBuddy:_Local_Development|Develop Sites Locally]] and then migrate them to your live site.
* [[BackupBuddy: ImportBuddy]]
+
 
+
* [http://pluginbuddy.com/tutorials/backupbuddy/ Videos & Tutorials]
+
 
+
= Server Requirements & Recommendations =
+
  
 +
=Specifications=
 
Server configuration is a very complex topic and varies wildly between hosts, server operating systems, and even the personal preference of the server administrator. Below are the bare minimum requirements for the plugin along with the recommended setup to get the most out of this plugin. You may use [[ServerBuddy]] to help you determine how your server compares to our minimum requirements & recommendations.
 
Server configuration is a very complex topic and varies wildly between hosts, server operating systems, and even the personal preference of the server administrator. Below are the bare minimum requirements for the plugin along with the recommended setup to get the most out of this plugin. You may use [[ServerBuddy]] to help you determine how your server compares to our minimum requirements & recommendations.
  
 
+
===Server Recommendations (full functionality)===
==== Recommended environment for FULL functionality:====
+
 
* PHP 5.2+
 
* PHP 5.2+
** [http://wordpress.org/news/2010/07/eol-for-php4-and-mysql4/ WordPress v3.2 will require PHP 5.2+ (early 2011)]
+
** [http://wordpress.org/news/2010/07/eol-for-php4-and-mysql4/ WordPress v3.2+ requires PHP 5.2+]
 
* mySQL 5.x+
 
* mySQL 5.x+
** [http://wordpress.org/news/2010/07/eol-for-php4-and-mysql4/ WordPress v3.2 will require mySQL 5.0.15+ (early 2011)]
+
** [http://wordpress.org/news/2010/07/eol-for-php4-and-mysql4/ WordPress v3.2+ requires mySQL 5.0.15+]
* WordPress 2.9+
+
** For best results, use MySQL 5.1+
 +
* WordPress 3.3+  
 
* Write permissions to /wp-content/uploads/ for the user running BackupBuddy.
 
* Write permissions to /wp-content/uploads/ for the user running BackupBuddy.
 
** Backups will be stored in /wp-content/uploads/backupbuddy_backups/
 
** Backups will be stored in /wp-content/uploads/backupbuddy_backups/
 
** Temporary files will be stored in /wp-content/uploads/backupbuddy_temp/xxxxxxx/ (temporarily generated at each backup)
 
** Temporary files will be stored in /wp-content/uploads/backupbuddy_temp/xxxxxxx/ (temporarily generated at each backup)
 
* Free disk space equal to or greater than the entire size of your site once compressed.
 
* Free disk space equal to or greater than the entire size of your site once compressed.
** SuPHP or environment so that file operations/zip run as user to prevent permissions issues. (recommendation)
+
** SuPHP or environment so that file operations/zip run as user to prevent permissions issues.
** PHP exec() function enabled (recommendation)
+
** PHP exec() function enabled
** PHP ZipArchive class installed (recommendation)
+
** PHP ZipArchive class installed
* Linux:
+
* Linux (Apache):
** Command-line zip installed and accessible (recommendation)
+
** Command-line zip installed and accessible via exec().
* Windows:
+
* Windows (only supported for local development via Apache; IIS is not officially supported):
** Windows zip executable (available [http://pluginbuddy.com/wp-content/uploads/2010/05/backupbuddy_windows_unzip.zip here]) (recommendation)
+
** Windows zip executable (available [http://pluginbuddy.com/wp-content/uploads/2010/05/backupbuddy_windows_unzip.zip here])
 +
*** You must have the ability to configure your server to allow execution of this zip.exe file for it to function.
 +
*** File permissions must also be set to allow access and execution of the zip executable.
 +
* wp-config.php file must be in WordPress installation directory OR (starting with BackupBuddy v3.0) in the parent directory.
  
 
+
===Minimum Server Requirements (reduced functionality)===
====Minimum requirements to run with reduced functionality:====
+
'' NOTE: Some features of BackupBuddy will be unavailable or limited if running on minimum requirements without recommendations. Large sites may not be able to be backed up with these minimum features.'''
'' NOTE: Some features of BackupBuddy will be unavailable or limited if running on minimum requirements without recommendations.'''
+
 
* PHP 5.2+
 
* PHP 5.2+
** [http://wordpress.org/news/2010/07/eol-for-php4-and-mysql4/ WordPress v3.2 will require PHP 5.2+ (early 2011)]
+
** [http://wordpress.org/news/2010/07/eol-for-php4-and-mysql4/ WordPress v3.2+ requires PHP 5.2+]
* mySQL 4.x+
+
* mySQL 5.x+
** [http://wordpress.org/news/2010/07/eol-for-php4-and-mysql4/ WordPress v3.2 will require mySQL 5.0.15+ (early 2011)]
+
** [http://wordpress.org/news/2010/07/eol-for-php4-and-mysql4/ WordPress v3.2+ requires mySQL 5.0.15+]
* WordPress 2.9+
+
* WordPress 3.2+
 +
** We are trying to maintain bare minimum backup functionality for legacy versions as far back as WordPress v2.6 (though it's not pretty nor guaranteed to work perfectly at this time; we recommend only performing backups & direct restores for older versions and use it for safety while upgrading to the latest WordPress).
 
* Write permissions to /wp-content/uploads/ for the user running BackupBuddy.
 
* Write permissions to /wp-content/uploads/ for the user running BackupBuddy.
 +
* BackupBuddy requires the uploads directory to be in the standard WordPress location.
 
** Backups will be stored in /wp-content/uploads/backupbuddy_backups/
 
** Backups will be stored in /wp-content/uploads/backupbuddy_backups/
 
** Temporary files will be stored in /wp-content/uploads/backupbuddy_temp/xxxxxxx/ (temporarily generated at each backup)
 
** Temporary files will be stored in /wp-content/uploads/backupbuddy_temp/xxxxxxx/ (temporarily generated at each backup)
 
* Free disk space equal to or greater than the entire size of your site once compressed.
 
* Free disk space equal to or greater than the entire size of your site once compressed.
 +
* wp-config.php file must be in WordPress installation directory OR (starting with BackupBuddy v3.0) in the parent directory.
  
 +
===Host Compatibility===
 +
Compare various [[BackupBuddy:_Hosts|Hosts & Hosting Environments]] to see how your host/potential host compares.
  
====NOTES:====
 
* WordPress MU is not officially supported though reported to work
 
* 3.0 MultiSite is currently not officially supported though reported to work for direct restores. Migration not available.
 
* Importing on MAC may require modifications to default file permissions for the restoration directory. A work-around is being looked into.
 
  
 +
===Misc. Information===
 +
Find out some [[BackupBuddy:_Misc_Information|Miscellaneous Information]] about BackupBuddy.
  
=Advanced Information=
+
 +
=Troubleshooting=
  
'''What is the behind the scenes flow during a backup?'''
+
===Frequently Seen Support Issues===
 +
''Problems?'' We have compiled a list of issues and solutions to many problems that we have seen encountered before. [[BackupBuddy:_Frequent_Support_Issues|Frequently Seen Support Issues]] to attempt to narrow down your problem and find a solution.
  
See page: [[BackupBuddy:_Behind_the_Scenes]]
+
===BackupBuddy: Error Codes===
 +
Receive an error code? Check out the [[BackupBuddy:_Error_Codes|Error Codes]] page for explanations.
  
  
'''How does scheduling work in BackupBuddy?'''
+
===Manual Migration===
 +
Import fails on file extraction? Learn how to perform a [[BackupBuddy:_Manual_Migration|Manual Migration]] ... it's easier than you'd think!
  
Schedules are inserted into the WordPress cron system and are executed once by the WordPress actions core at a time which you specify. The action will fire off when someone visits your WordPress site, if the schedule time has passed. A scheduled action cannot occur until someone visits after the scheduled time has passed.
 
  
 +
=Additional Resources=
  
'''My host blocks Linux command line zip and/or exec()'''
+
'''Tools'''
  
You can ask your host to allow this. The more people that do, the greater the chance they will do so. You can use this example of what to say:
+
* [http://ithemes.com/codex/page/File:Zip_test.zip Manually test command line zip functionality]
"I am attempting to use a PHP script that uses Linux's command line ZIP executable to generate a zip file.  It attempts to run the zip command via PHP's exec() function.  However, the script is reporting that it is unable to do so.  Is it possible to obtain access to this?"
+
  
 +
=Multisite=
  
'''If I override php.ini with my own, what options could I use?'''
+
BackupBuddy supports the following Multisite functionality:
 +
* Export a Multisite subsite to standalone
 +
* Import an exported Multisite subsite into an existing Network
 +
* Import a standalone WordPress site into an existing Network
 +
* Backup entire Network (backup/restore only; no migration to new URL)
 +
* Restore entire Network WITHOUT URL migration for subsites within if migrating to a new URL (URL changes have limitations. Please see Multisite page for details)
  
Here are some recommended values for a custom php.ini:
 
  
max_execution_time = 300
+
[http://ithemes.com/codex/page/BackupBuddy_Multisite Check out the BackupBuddy Multisite Codex] and [http://pluginbuddy.com/purchase/backupbuddy/ Get BackupBuddy Multisite Beta Today!]
  
memory_limit = 128M
+
BETA indicates that Multisite functionality has known issues and is not reccomended for production use except at your own risk.  We do NOT guarantee its functionality or provide guaranteed support for beta products.
  
disable_functions =
+
'''Links'''
 
+
'''Does BackupBuddy migrate all links from the old URL to the new?'''
+
 
+
Yes, except for URLs hard-coded into .php or .html files.  BackupBuddy does not alter files to avoid any problems.  Under normal circumstances (and proper WordPress practices) you should never encounter this problem.
+
 
+
'''I dont understand databases!'''
+
 
+
Think of databases & database servers in terms of a filing cabinet analogy.  The filing cabinet is the server.  Within the server (filing cabinet) there are databases (drawers).  Within the databases (drawers) there are folders (tables).  Within the folders (tables) there are rows of data (the pages of paper).
+
 
+
'''BackupBuddy is leaving temporary files.'''
+
 
+
BackupBuddy automatically removed temporary files after approximately 12 hours.  These files are left there temporarily to assure that remote destination transfers properly finish before the files are removed.
+
 
+
[[File:Db_explanation.gif‎]]
+
 
+
=Major Version Release Changes=
+
 
+
==Version 2.0==
+
<pre class="brush:html">
+
Key Improvements
+
Streamlined flow & usability – Easier to use than ever.
+
Built-in popup tutorial videos – Get stuck? Quickly learn about features & how to use them.
+
Improved status feedback (simple & advanced) – Less confusion, easier to troubleshoot.
+
Improved performance & compatibility
+
Supports larger sites / slower servers
+
Better failure recovery – In case everything goes wrong, cleanly recover.
+
More robust archive integrity verification – More peace of mind that backups are good.
+
 
+
Key New Features
+
Added support for Rackspace Cloud Storage for remote backups. - More choices.
+
Manage remote Amazon S3, FTP, & Rackspace Cloud backups within BackupBuddy
+
Increases ease of use in managing remote backups.
+
Define remote destinations on a per schedule basis
+
Great for increased reliability of backups & clients providing backup services.
+
Background manual backups – Start the backup and close the page & it continues.
+
Quick backup after creating or editing a post/page. - Helps you to remember to backup.
+
Server Information / Tools – Vital tools for viewing your site status & troubleshooting.
+
Compatibility checking – Make sure your server is configured properly.
+
File permissions – Make sure your most basic security is correct.
+
Site size maps – Find where all your space is being used up.
+
Database size – Find any excessively large database tables.
+
Cron viewer – View, delete, or run scheduled operations in WordPress.
+
Malware Scanner – Check your site for malware.
+
 
+
 
+
Over 50 other additional features & enhancements.
+
</pre>
+
 
+
==Version 1.3.x==
+
Version 1.3.0 implemented the following:
+
* Major importbuddy.php rewrite for enhanced compatibility & improved features.
+
** Added a new compatibility mode (medium speed) to importbuddy for a total of three modes of operation: Full high speed (normal mode), medium speed (compatibility mode with ZipArchive), and low speed (compatibility mode with PCLZip).
+
** Added a text logging system to both BackupBuddy itself and importbuddy.php with user-selectable logging (errors only, errors + warnings, log everything). This allows for better debugging and technical support, particularly when odd situations occur.
+
** Added more thorough error checking to the entire import process to detect problems earlier.
+
** Added more detailed mysql connection checking when clicking the 'Test Database Settings' button to make it easier to correct mysql database setting problems.
+
** Added new options to force a certain compatibility mode if automatic mode detection is failing due to server settings.
+
** Improved directions and tooltips to better explain the process and walk the user through the steps.
+
 
+
* Bug Fixes
+
** Fixed FTP system not sending scheduled sends in some situations.
+
** Fixed default FTP type on manual FTP sending to properly indicate the selected mode in settings.
+
 
+
=Additional Resources=
+
 
# [http://pluginbuddy.com/purchase/backupbuddy/ Purchase BackupBuddy]
 
# [http://pluginbuddy.com/purchase/backupbuddy/ Purchase BackupBuddy]
 
+
# [http://ithemes.com/codex/page/BackupBuddy_Multisite BackupBuddy Multisite Codex]
 +
# [http://pluginbuddy.com/backupbuddy-multisite-migration-expanded-features-in-beta-coming-soon/ BackupBuddy beta Multisite support announcement]
 +
# [http://pluginbuddy.com/5-reasons-to-love-backupbuddy-with-new-wordpress-multisite-support/ BackupBuddy beta Multisite key points everyone is raving about!]
 
# [http://pluginbuddy.com/tutorials/ PluginBuddy Tutorials]
 
# [http://pluginbuddy.com/tutorials/ PluginBuddy Tutorials]
 
# [http://pluginbuddy.com/ PluginBuddy.com]
 
# [http://pluginbuddy.com/ PluginBuddy.com]

Revision as of 09:19, March 15, 2013

Contents

Tutorials

Training Videos

For video training including walkthroughs & tutorials please see http://ithemes.com/backupbuddy-training/

Installing BackupBuddy

Check out the Installing BackupBuddy section to see how BackupBuddy can be uploaded and activated on Single sites or Multisite networks or Multisite sites.

Getting Started

Check out the Getting Started page to backup your Single sites or Multisite networks.


Restore or Migrate

Learn to Restore or Migrate your Single sites or Multisite networks with the latest importbuddy.php.


Settings Explained

Get in depth information about the various Settings.


Developing Locally

Set up your computer to Develop Sites Locally and then migrate them to your live site.

Specifications

Server configuration is a very complex topic and varies wildly between hosts, server operating systems, and even the personal preference of the server administrator. Below are the bare minimum requirements for the plugin along with the recommended setup to get the most out of this plugin. You may use ServerBuddy to help you determine how your server compares to our minimum requirements & recommendations.

Server Recommendations (full functionality)

  • PHP 5.2+
  • mySQL 5.x+
  • WordPress 3.3+
  • Write permissions to /wp-content/uploads/ for the user running BackupBuddy.
    • Backups will be stored in /wp-content/uploads/backupbuddy_backups/
    • Temporary files will be stored in /wp-content/uploads/backupbuddy_temp/xxxxxxx/ (temporarily generated at each backup)
  • Free disk space equal to or greater than the entire size of your site once compressed.
    • SuPHP or environment so that file operations/zip run as user to prevent permissions issues.
    • PHP exec() function enabled
    • PHP ZipArchive class installed
  • Linux (Apache):
    • Command-line zip installed and accessible via exec().
  • Windows (only supported for local development via Apache; IIS is not officially supported):
    • Windows zip executable (available here)
      • You must have the ability to configure your server to allow execution of this zip.exe file for it to function.
      • File permissions must also be set to allow access and execution of the zip executable.
  • wp-config.php file must be in WordPress installation directory OR (starting with BackupBuddy v3.0) in the parent directory.

Minimum Server Requirements (reduced functionality)

NOTE: Some features of BackupBuddy will be unavailable or limited if running on minimum requirements without recommendations. Large sites may not be able to be backed up with these minimum features.'

  • PHP 5.2+
  • mySQL 5.x+
  • WordPress 3.2+
    • We are trying to maintain bare minimum backup functionality for legacy versions as far back as WordPress v2.6 (though it's not pretty nor guaranteed to work perfectly at this time; we recommend only performing backups & direct restores for older versions and use it for safety while upgrading to the latest WordPress).
  • Write permissions to /wp-content/uploads/ for the user running BackupBuddy.
  • BackupBuddy requires the uploads directory to be in the standard WordPress location.
    • Backups will be stored in /wp-content/uploads/backupbuddy_backups/
    • Temporary files will be stored in /wp-content/uploads/backupbuddy_temp/xxxxxxx/ (temporarily generated at each backup)
  • Free disk space equal to or greater than the entire size of your site once compressed.
  • wp-config.php file must be in WordPress installation directory OR (starting with BackupBuddy v3.0) in the parent directory.

Host Compatibility

Compare various Hosts & Hosting Environments to see how your host/potential host compares.


Misc. Information

Find out some Miscellaneous Information about BackupBuddy.


Troubleshooting

Frequently Seen Support Issues

Problems? We have compiled a list of issues and solutions to many problems that we have seen encountered before. Frequently Seen Support Issues to attempt to narrow down your problem and find a solution.

BackupBuddy: Error Codes

Receive an error code? Check out the Error Codes page for explanations.


Manual Migration

Import fails on file extraction? Learn how to perform a Manual Migration ... it's easier than you'd think!


Additional Resources

Tools

Multisite

BackupBuddy supports the following Multisite functionality:

  • Export a Multisite subsite to standalone
  • Import an exported Multisite subsite into an existing Network
  • Import a standalone WordPress site into an existing Network
  • Backup entire Network (backup/restore only; no migration to new URL)
  • Restore entire Network WITHOUT URL migration for subsites within if migrating to a new URL (URL changes have limitations. Please see Multisite page for details)


Check out the BackupBuddy Multisite Codex and Get BackupBuddy Multisite Beta Today!

BETA indicates that Multisite functionality has known issues and is not reccomended for production use except at your own risk. We do NOT guarantee its functionality or provide guaranteed support for beta products.

Links

  1. Purchase BackupBuddy
  2. BackupBuddy Multisite Codex
  3. BackupBuddy beta Multisite support announcement
  4. BackupBuddy beta Multisite key points everyone is raving about!
  5. PluginBuddy Tutorials
  6. PluginBuddy.com
  7. Support Forums
Personal tools
Namespaces
Variants
Actions
iThemes Codex
Codex Navigation
Toolbox