How to: Easily Move a WordPress Install from Development to Production?

Question

I do development on one box and use a second for production. Right now I just dump the database and then do a find a replace for the URL changes; then copy over the files and import the new SQL.

Are there better ways of doing this?

Answer 1

@Insanity5902: Deployment of a WordPress site from one box to another has been a PITA since day one I started working with WordPress. (Truth-be-told it was a PITA with Drupal for 2 years before I started with WordPress so the problem is certainly not exclusively with WordPress.)

It bothered me that every time I needed to move a site I'd have to spend so much often duplicated effort and it kept me from deploying to test as frequently as I would have preferred. So about 4-6 months ago I started working on a plugin to solve the webhost migration problem and I mentioned my ideas on the WP Tavern forum.

Well fast forward to today and I've pretty much got it working and I'm conveniently calling it "WP Migrate Webhosts." Even though the plugin is still very much beta (probably even alpha) given your question I think I'm ready to let people start banging on it.

The envisioned use-case is that 1.) first the developer handles uploading all the changed theme and plugin files via FTP, 2.) then uploads the development MySQL database to the testing server in its entirety and finally 3.) then runs the plugin to migrate any references from the prior domain to the new one. (My plugin does not attempt to solve the merging of new database fields or tables with live data; THAT is a much bigger problem that I'm not sure how to solve.)

You can download the plugin from my website and unzip into your plugins directory (if you don't know how to do this then this plugin is not for you because it requires someone who knows what they are doing to use it.) I'll keep this plugin online until I release it to WordPress.org after which you should look for it there.

To use it you take a different approach in your wp-config.php that normal by commenting out the four (4) defines DB_NAME, DB_USER, DB_PASSWORD and DB_HOST and instead registering the defaults for webhosts and then registering info about each webhost itself. Here's what that segment of wp-config.php might look like (note the first section is the unneeded code commented out and also note that I set up my hosts file on my local machine with non-routable .dev top level domains to make day-to-day development easier. On the Mac VirtualHostX makes this a breeze):

// ** MySQL settings - You can get this info from your web host ** //
/** The name of the database for WordPress */
//define('DB_NAME', 'wp30');

/** MySQL database username */
//define('DB_USER', 'wp30_anon');

/** MySQL database password */
//define('DB_PASSWORD', '12345');

/** MySQL hostname */
//define('DB_HOST', '127.0.0.1:3306');

require_once(ABSPATH . 'wp-content/plugins/wp-migrate-webhosts/wp-webhosts.php');
register_webhost_defaults(array(
 'database'  => 'example_db',
 'user'      => 'example_user',
 'password'  => '12345',
 'host'      => 'localhost',
 'sitepath'  => '',        // '' if WordPress is installed in the root
));
register_webhost('dev',array(
 'name'      => 'Example Local Development',
 'host'      => '127.0.0.1:3306',
 'domain'    => 'example.dev',
 'rootdir'   => '/Users/mikeschinkel/Sites/example/trunk',
));
register_webhost('test',array(
 'name'      => 'Example Test Server',
 'rootdir'   => '/home/example/public_html/test',
 'domain'    => 'test.example.com',
));
register_webhost('stage',array(
 'name'      => 'Example Staging Server',
 'rootdir'   => '/home/example/public_html/stage',
 'domain'    => 'stage.example.com',
));
register_webhost('live',array(
 'name'      => 'Example Live Site',
 'rootdir'   => '/home/example/public_html/',
 'password'  => '%asd59kar12*fr',
 'domain'    => 'www.example.com',
));
require_once(ABSPATH . 'wp-content/plugins/wp-migrate-webhosts/set-webhost.php');

Hopefully this is (mostly) self explanatory. I attempted to make the code as clean as I could but unfortunately it requires those two cryptic require_once() lines before and after the block of webhost registration code since there was no way for me to "hook" WordPress before wp-config.php is called.

Once you have updated your wp-config.php then you can simply use the URL shortcut wp-migrate-webhosts to go to the admin screen like so:

http://example.com/wp-migrate-webhosts

The above will take you to an admin screen like the following which has a fair bit of description text and allows you to migrate FROM any of the other webhost domains with a single click after selecting the domains to migrate from (NOTE: this example shows going DOWN from test/stage/live servers to local development but rest assured it can migrate TO any domain where it happens to be located. This also means the plugin will be great for taking an existing live site and quickly getting a local development environment working!):

If it's not clear "migration" in this context means to update all the references in the current database to be appropriate for the currently defined webhost (and "current" is sniffed by inspecting $_SERVER['SERVER_NAME'].)

What's cool about the plugin is that it implements some basic migrations but anyone can hook it and perform their own migrations. For example, if you add a gallery plugin that stored full paths to images in the database you could hook the migrate_webhosts action which will be passed the "from" webhost and the "to" webhost each as an array of metadata and you'll be allowed to perform whatever you need to do in the database using SQL or any applicable WordPress API functions to do the migration. Yes any of us could do this without the plugin but without the plugin I found that writing all the code needed was more effort than it was worth. With the plugin it's just easier to write these tiny hooks and get it over with.

You may also find my migrations fail in edge cases I've not tested and maybe you can help me improve the plugin? Anyone who wants to can email me via my gmail account (my alias is "mikeschinkel.")

Also, the plugin was designed to accept user-define webhost metadata in addition to the ones it recognizes like database, user, password, host, domain etc. A perfect example might be googlemaps_apikey where you can store a the different API keys for each domain that your Google Map's plugin needs to operate correct (who among you who has used a Google Maps plugin hasn't deployed an app to a live server and forgotten to change the code to the correct API key? Come on, be honest... :) With this plugin, a googlemaps_apikey element in your register_webhost() array and a small custom migrate_webhosts hook you can effectively eliminate that as a concern!

Well that's about it. I'm launching this plugin here on WordPress Answer's Exchange because @Insanity5902's question triggered it. Let me know if it's helpful, here if appropriate or via email if not.

P.S. If you do decide to use this remember it is alpha/beta and that means it will change so be prepared for some minor surgery if you want to use it now and then use the released version once its been beaten on by many hands.

P.P.S. What are my goals with this? I've love to see this migrate into WordPress core so that everybody would have access to it. But before that can even be considered lots of people have to be interested in using it to ensure it actually solves more problems then it potentially could create. So if you like the idea then by all means use it and help me gain momentum with it for eventual hopeful inclusion into WordPress core.

Answer 2

When possible, I set WP_HOME and WP_SITEURL in wp-config.php. This, combined with a database dump and import, is the most simple of all solutions I'm familiar with.

http://codex.wordpress.org/Changing_The_Site_URL#Edit_wp-config.php

Answer 3

I wanted something similar when I migrated to WP a few months back, so I wrote a pretty simple shell script that uses rsync and mysqldump over ssh:

http://snarfed.org/sync_wordpress

It's not sophisticated or web based, but I'm happy with it.

Answer 4

My favourite hack; add a setting to your /etc/hosts to make the production domain point to your development box, just on your machine. To deploy to production you rsync all the files and push the database over.

The risks of this strategy are clear; you might confuse your development environment with your production environment.

It still an easy fix though.

Answer 5

I am personally addressing this issue with my project on Github, called Autopress. I don't have a perfect solution yet, but I'm getting closer, especially with the wpstage plugin from the wpengine folks.

Answer 6

WP Engine is a new service that offers "One-Click Staging":

WPEngine has an exclusive feature called “staging.” Here’s how it works: Before you make a scary change to your blog, click the “snapshot” button. We make a complete copy of your blog and set it up in a separate, safe area. You can play with anything you want; nothing’s live. Only when you’re ready to make it live do you touch your main site.

Looks like a very easy way to quickly move from development to production, especially with an already live site.

Answer 7

You might take a look at a product from iThemes, called BackUpBuddy. I've only used it twice, each time had a hitch or two, but overall it looks promising.

Answer 8

This looks promising. We are working on some scripts to handle migrating some of the data, wp-options for example, changing paths in the db, a copying over media.

The issue I have is that the live site continues to grow while the other is in development. One site we work on has 20 posts a day and over 3,000 comments per day. That is too much data to move over with phpmyadmin or via the command line. Also, moving the data around always causes UTF issues for some reason.

Also, now that it looks like menu options are stored in the DB, I have even more to deal with.

I check all my code into SVN and deploy the code via FTP from the server (Beanstalk). This does not make the changes to the DB for me though or activate new plugins.

My plan right now is to create a manifest file while I am developing to do all my changes to the live site.

For example the file would have human readable lines

It would include plugins to activate, wp-options to move over, images to move, pages to move. Then my plugin, would detect the manifest file and make all the changes to the staging site.

Once I tested that and was sure I got everything, I could be sure it would work on production.

This plugin is still just an idea, but I have some code written for it.

Also, if you want to make changes to just the URL in you DB, you can use the following SQL.

just replace $old$ with the old domain and $new$ with the new

update wp_postmeta set meta_value = replace(meta_value, '$old$' , '$new$') ; update wp_posts set post_content = replace(post_content, '$old$' , '$new$') ; update wp_options set option_value = replace(option_value, '$old$' , '$new$') ;

Answer 9

I use subversion's export command to install the WordPress files (http://core.svn.wordpress.org/tags//) as well as all plugins in the repository (http://plugins.svn.wordpress.org//tags//), then just zip the theme and custom plugins and install them normally. Once all of that is up and running without content, I export the test DB and do a search/replace for the URL AND the filepath (stored for media) and import into an empty database, then just switch the database info in wp-config.php. Generally takes me about 10 - 20 minutes.

Answer 10

Two Google Summer of Code projects that have a similar goal:

• Automatic Migration (GSoC 2010)
• WordPress Move (proposal) (GSoC 2011)

Answer 11

since I run my sites in IIS (I also run asp.net, so I need windows) I use WebPI from Msft to install a new instance, then I copy the template and use the import/export to transfer the data.

It's not perfect but the whole thing takes less than an hour.

Obviously it would be nice to have a one-click solution, but this is what I found to be easiest for me.

Answer 12

Normally I login to phpMyadmin upload the database and edit the contents of wp_options>siteurl and wp_options>home to the expected domain. If you need to update URLs within your posts and pages content you can do a search/replace for the URL and the media/uploads path on the .SQL file prior to uploading. It's a quick job.

Answer 13

Another paying solution: the Xtreme One theme framework released version 1.2 with Xtreme Backup which allows you to "export or import the settings of your Childthemes, Layouts or Widgets with all their settings/content as XML file."

Answer 14

A coworker found this. Interesting concept, though it doesn't work cross server it looks like. I'm still exploring it, but looks like it could work great for a staging instance

http://code.google.com/p/deploymint/

Answer 15

Duplicator Plugin: Here is a plugin that I have been working on. It's currently in beta but it gets the job done for most sites. Right now it is targeted at smaller WordPress installs. http://wordpress.org/extend/plugins/duplicator/

Resources: Additional resources for the plugin can be found here: http://lifeinthegrid.com/duplicator/

Community: Please let us know about your successes or any issues you might run into! In an effort to more easily manage the various threads please post issues to the WordPress.org plugin forums. Please do not post any logging data from the plugin into the online forums. Logging data can be submitted to our support site.

Answer 16

for continuous syncs I highly suggest rsync along with some custom code to rewrite specific php variables if needed.

Answer 17

http://wp.tutsplus.com/tutorials/how-to-sync-a-local-remote-wordpress-blog-using-version-control/

Answer 18

This may not have been around when you asked the question, but I've been using a service called Blogvault for a couple months and it has done this flawlessly. I've probably done over 50 migrations (crossing domains, sub-domains, and web hosts), not a hitch and takes no time at all.

It's a paid service (per domain/month), but not that much.