BackupBuddy

(Difference between revisions)
Jump to: navigation, search
(Server Requirements & Recommendations)
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.
 +
* '''Need hosting?''' ''Hostgator Coupons'' are available to BackupBuddy customers [http://ithemes.com/forum/index.php?/topic/14012-hostgator-coupons-for-our-community/ here].
  
'''Hostgator coupons''' available to BackupBuddy customers here: http://ithemes.com/forum/index.php?/topic/14012-hostgator-coupons-for-our-community/
 
  
== Settings Explained ==
+
=Tutorials=
=== Enable ZIP Compression ===
+
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.  
+
===Getting Started===
 +
Check out the [[BackupBuddy:_Getting_Started|Getting Started]] page.
  
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.
 
  
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.
+
===Restore or Migrate===
 +
Learn to [[BackupBuddy:_ImportBuddy|Restore or Migrate]] your site with importbuddy.php.
  
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.
 
  
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.
+
===Settings Explained===
 +
Get in depth information about the various [[BackupBuddy:_Settings|Settings]].
  
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 =
+
===Developing Locally===
* [[BackupBuddy: Advanced Usage]] - Ex: Restoring/Migrating Using a Database Backup
+
Set up your computer to [[BackupBuddy:_Local_Development|Develop Sites Locally]] and then migrate them to your live site.
  
* [[BackupBuddy: Error Codes]]
 
 
* [[BackupBuddy: Advanced Debugging]]
 
 
* [[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.
 
 
* [[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 will require PHP 5.2+ (early 2011)]
Line 50: Line 35:
 
** 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:
** Command-line zip installed and accessible (recommendation)
+
** Command-line zip installed and accessible
 
* Windows:
 
* Windows:
** 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])
  
  
====Minimum requirements to run with reduced functionality:====
+
===Minimum Server Requirements (reduced functionality)===
 
'' NOTE: Some features of BackupBuddy will be unavailable or limited if running on minimum requirements without recommendations.'''
 
'' NOTE: Some features of BackupBuddy will be unavailable or limited if running on minimum requirements without recommendations.'''
 
* PHP 5.2+
 
* PHP 5.2+
Line 72: Line 57:
  
  
====NOTES:====
+
===Host Compatibility===
* WordPress MU is not officially supported though reported to work
+
Compare various [[BackupBuddy:_Hosts|Hosts & Hosting Environments]] to see how your host/potential host compares.
* 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.
+
 
+
=Advanced Information=
+
 
+
 
+
'''How does scheduling work in BackupBuddy?'''
+
 
+
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.
+
 
+
 
+
'''My host blocks Linux command line zip and/or exec()'''
+
 
+
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:
+
"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?"
+
 
+
 
+
'''If I override php.ini with my own, what options could I use?'''
+
 
+
Here are some recommended values for a custom php.ini:
+
 
+
max_execution_time = 300
+
 
+
memory_limit = 128M
+
 
+
disable_functions =
+
 
+
'''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.'''
+
===Misc. Information===
 +
Find out some [[BackupBuddy:_Misc_Information|Miscellaneous Information]] about BackupBuddy.
  
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.
+
 +
=Troubleshooting=
  
[[File:Db_explanation.gif‎]]
+
===Frequent_Support_Issues===
 +
''Problems?'' Start with the [[BackupBuddy:_Frequent_Support_Issues|Frequently Seen Support Issues]] to most quickly troubleshoot your problem.
  
=Major Version Release Changes=
 
  
==Version 2.0==
+
===Advanced Support Issues===
<pre class="brush:html">
+
[[BackupBuddy:_Advanced_Debugging|Advanced Debugging Information]]
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.
 
  
 +
===BackupBuddy: Error Codes===
 +
Receive an error code? Check out the [[BackupBuddy:_Error_Codes|Error Codes]] page for explanations.
  
Over 50 other additional features & enhancements.
 
</pre>
 
  
==Version 1.3.x==
+
===Manual Migration===
Version 1.3.0 implemented the following:
+
Import fails on file extraction? Learn how to perform a [[BackupBuddy:_Manual_Migration|Manual Migration]] ... it's easier than you'd think!
* 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=
 
=Additional Resources=

Revision as of 13:51, June 7, 2011


Contents

Tutorials

Getting Started

Check out the Getting Started page.


Restore or Migrate

Learn to Restore or Migrate your site with 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 2.9+ (not WordPress MU, not multisite)
  • 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:
    • Command-line zip installed and accessible
  • Windows:
    • Windows zip executable (available here)


Minimum Server Requirements (reduced functionality)

NOTE: Some features of BackupBuddy will be unavailable or limited if running on minimum requirements without recommendations.'

  • PHP 5.2+
  • mySQL 4.x+
  • WordPress 2.9+ (MU & Multisite are not officially supported though reported to work for backup/restore but not migration)
  • 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.


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

Frequent_Support_Issues

Problems? Start with the Frequently Seen Support Issues to most quickly troubleshoot your problem.


Advanced Support Issues

Advanced Debugging Information


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

  1. Purchase BackupBuddy
  1. PluginBuddy Tutorials
  2. PluginBuddy.com
  3. Support Forums
Personal tools
Namespaces
Variants
Actions
iThemes Codex
Codex Navigation
Toolbox