BackupBuddy: Deployment

From iThemes Codex
Revision as of 23:02, 20 April 2015 by Dustin (talk | contribs) (Setup)
Jump to: navigation, search


BackupBuddy Deployment allow you to easily push or pull a site's database, media files, plugins, and active theme back and forth between sites. This allows you to develop on one site and then push changes to another. Contents of the destination site (the site you are pushing to) will be overwritten as needed. During Deployment you will be displayed a continuous status of the process and you will be given the opportunity to test the changes and undo the database changes before making them permanent.

  • New "BackupBuddy Deployment" remote destination allowing pushing or pulling your entire site to or from another existing site, in as few as two clicks.
  • See differences in site server settings, active plugins, theme, versions, and media prior to deploying.
  • Options to transfer the database (all tables, some, or none), plugins, theme, and/or media.
  • Automatic migration of URLs, paths, and other settings just like manual migrations.
  • Watch the deployment progress just like a normal backup, displaying a continuous status including a detailed advanced status log of the entire process, all in one place.
  • Ability to undo the database changes with one click if something goes wrong prior to confirming the deployment once you're satisfied.
  • Automatic chunking of data transferred between servers to support large files or slow servers.
  • Swaps databases only after the entire database and all files have been transferred to attempt to minimize site downtime to mere seconds (or less!).
  • Perfect for developing your site in a different location from the live site. Use staging best practices.


  1. On the site you want to Push to or Pull from, go to the BackupBuddy > Remote Destinations page then select the "Show Deployment Key" button at the top of the page.
    • If it is your first time to set up Deployment on this site you will be prompted to add the following line to the wp-config.php file (after doing so, refresh the page and select "Show Deployment Key" again to view the key):
      define( 'BACKUPBUDDY_API_ENABLE', true );
  2. You will see a Deployment API Key that looks something like the following:
  3. Copy this key. You will enter this key in your other site.
  4. On the site you want to Push from or Pull to go to the BackupBuddy > Remote Destinations page and click the tab "+ Add New".
  5. Select the "BackupBuddy Deployment" destination.
  6. Enter the API key you copied from the other site. You may test and add the destination now. Setup is now complete.

Pushing & Pulling

  1. Go to the site you wish to Push from or Pull
  2. Go to the BackupBuddy > Remote Destinations page and select the tab for the Deployment destination you added during Setup.
  3. Select "Push to" or "Pull from" depending on what you want to do.
  4. You will be shown information about both sites and their server configuration including WordPress & plugin versions, media information, database tables, runtime details, and more.
  5. Select what data you wish to transfer including Database tables, Media files, Plugins, and Theme files.
  6. Click "Begin Deployment" to start the process.
  7. You will be shown a status display giving an overview of the current progress including files transferred including a detailed Status Log.
  8. Test the destination site to verify everything looks okay and then click "Confirm Deployment" to finalize these changes. If you do not confirm the changes within 12 hours they will be considered finalized. If you are not satisfied with the changes select "Undo Database Changes" to rollback to the database in place prior to the Deployment process.

See also

← Back to BackupBuddy Codex Home