# Wordmove

![logo](https://raw.githubusercontent.com/welaika/wordmove/master/assets/images/wordmove.png)

Wordmove is a nice little gem that lets you automatically mirror local Wordpress
installations and DB data back and forth from your local development machine to
the remote staging server. SSH and FTP connections are both supported.

Think of it like Capistrano for Wordpress, complete with push/pull capabilities.

[![Build Status](https://travis-ci.org/welaika/wordmove.png?branch=master)](https://travis-ci.org/welaika/wordmove)

## Screencasts

* Push all WordPress, including database and uploads: http://vimeo.com/74648079
* Pull database and uploads, adapting paths and urls: http://vimeo.com/74646861
* Push only theme, transfer only modified files: http://vimeo.com/74647529

## Installation

That's easy:

```
gem install wordmove
```

## Upgrading?

Beware!

From version 1.0 we have decided to change wordmove flags' behaviour: they used to tell
wordmove which options to **skip**, now they tell instead which options to **include**.
In the Movefile, we have also changed all "username" fields to be just "user".

So please, be very careful when upgrading :heart:

## Usage

```
> wordmove help
Tasks:
  wordmove help [TASK]  # Describe available tasks or one specific task
  wordmove init         # Generates a brand new Movefile
  wordmove pull         # Pulls WP data from remote host to the local machine
  wordmove push         # Pushes WP data from local machine to remote host
```

## Movefile

You can configure Wordmove creating a `Movefile`. That's just a YAML file with all the local and remote host infos:

```yaml
local:
  vhost: "http://vhost.local"
  wordpress_path: "/home/john/sites/your_site" # use an absolute path here

  database:
    name: "database_name"
    user: "user"
    password: "password"
    host: "127.0.0.1"

staging:
  vhost: "http://example.com"
  wordpress_path: "/var/www/your_site" # use an absolute path here

  database:
    name: "database_name"
    user: "user"
    password: "password"
    host: "host"
    # port: "3308" # Use just in case you have exotic server config

  exclude:
    - ".git/"
    - ".gitignore"
    - ".sass-cache/"
    - "bin/"
    - "tmp/*"
    - "Gemfile*"
    - "Movefile"
    - "wp-config.php"
    - "wp-content/*.sql"

  # paths: # you can customize wordpress internal paths
  #   wp_content: "wp-content"
  #   uploads: "wp-content/uploads"
  #   plugins: "wp-content/plugins"
  #   mu_plugins: "wp-content/mu-plugins"
  #   themes: "wp-content/themes"
  #   languages: "wp-content/languages"
  #   themes: "wp-content/themes"

  # ssh:
  #   host: "host"
  #   user: "user"
  #   password: "password" # password is optional, will use public keys if available.
  #   port: 22 # Port is optional
  #   rsync_options: "--verbose" # Additional rsync options, optional
  #   gateway: # Gateway is optional
  #     host: "host"
  #     user: "user"
  #     password: "password" # password is optional, will use public keys if available.

  # ftp:
  #   user: "user"
  #   password: "password"
  #   host: "host"
  #   passive: true
  #   scheme: "ftps" # default "ftp"

# production: # multiple environments can be specified
#   [...]
```

## SSH support

In order for wordmove to work with SSH, you need to install `rsync` on your
machine.

### If you want to use your SSH public key for authentication
Just delete the `remote.ssh.password` field in your `Movefile`. Easy peasy.

### If you want to specify SSH password on the Movefile
Please take a look at the various gotchas of the underlying [`photocopier` gem](https://github.com/welaika/photocopier#password-gotchas).

## FTP support

In order for wordmove to work with FTP, you need to install `lftp` on your
machine. Then in the remote host section in your Movefile:

* Use the relative FTP path as `wordpress_path`
* Use the absolute FTP path as `wordpress_absolute_path` (you may need to recover this from the `__FILE__` constant)

### If you want to specify a passive FTP connection
Add to the YAML config a `passive` flag set to `true`.

### Problems with server's certificate
If server's certificate is not signed by a known Certificate Authority, you can disable `lftp` check by adding
`set ssl:verify-certificate no` to your `~/.lftprc` or `~/.lftp/rc`

If host name used to connect to the server does not corresponds to the host name in its certificate, you can disable
`lftp` check by adding `set ssl:check-hostname no` to your `~/.lftprc` or `~/.lftp/rc`

More `lftp` [configuration flags here.](https://gist.github.com/gaubert/822090)

### How the heck you are able to sync the DB via FTP?
We're glad you asked! We basically upload via FTP a PHP script that performs the various
import/export operations. This script then gets executed via HTTP. Don't worry
too much about security though: the script is deleted just after the usage,
and can only be executed by `wordmove`, as each time it requires a pre-shared
one-time-password to be run.

## Need more tools?
Visit [Wordpress Tools](http://wptools.it).

## Credits

* The dump script is the [`MYSQL-dump` PHP package](https://github.com/dg/MySQL-dump) by David Grudl;
* The import script used is the [BigDump](http://www.ozerov.de/bigdump/) library;

## License

(The MIT License)

Copyright © 2013 weLaika

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the ‘Software’), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED ‘AS IS’, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.