Simple Rsync Deployer Plugin for DocPad

Deploy to remotes via docpad deploy-rsync using rsync. Inspired by the GitHub Pages Deployer Plugin for DocPad by Bevry and Docpad rsync Deploy Script by Jayson Harshbarger.

Install

docpad install rsync

Usage

Inside your docpad configuration file add this:

plugins:
  rsync:
    host: 'example.com'       # target host
    path: '/var/www/htdocs'   # target path
    user: 'deployer'          # target username (optional)

Now when you run docpad deploy-rsync --env static, the generated out directory will be pushed up to your target using rsync.

If you are using multiple environments to generate different sites in one project (like this), you can specify different settings for each environment:

plugins:
  rsync:
    host: 'example.com'
    user: 'deployer'
    environments:
      en:
        path: '/var/www/htdocs_en'
      ru:
        path: '/var/www/htdocs_ru'

Also you can add dryrun: true in your config to test if all settings are ok.

plugins:
  rsync:
    dryrun: true
    host: 'example.com'
    path: '/var/www/htdocs'

License

Copyright © 2015 Yuri Sementsov and licensed under MIT License.