deac/middleman-deploy: Deploy a middleman built site over rsync, ftp, stfp, or git (e.g. gh-pages on github).

Deploy a middleman built site over rsync, ftp, stfp, or git (e.g. gh-pages on github).

Go to file

Tom Vaughan 72fcf8c717 periods, periods, periods		2012-09-04 11:04:09 -07:00
features/support	add a simple coverage report	2012-09-04 10:47:53 -07:00
lib	periods, periods, periods	2012-09-04 11:04:09 -07:00
.gitignore	add a simple coverage report	2012-09-04 10:47:53 -07:00
COPYING	a.k.a. the mit expat license (same (more or less) as middleman)	2012-08-20 16:22:26 -07:00
Gemfile	add a simple coverage report	2012-09-04 10:47:53 -07:00
middleman-deploy.gemspec	Added github pages support	2012-08-29 23:50:23 -04:00
Rakefile	required by travis-ci.org	2012-08-22 11:51:43 -07:00
README.md	misc clean-ups	2012-09-04 10:30:52 -07:00

README.md

Middleman Delpoy -- Deploy a middleman built site over rsync or to github pages.

===

QUICK START

If deploying through rsync, be sure it is installed.

Step 1

gem install middleman-deploy

Step 2

middleman init example-site
cd example-site

Step 3

Edit Gemfile, and add:

gem "middleman-deploy", "~>0.0.1"

Then run:

bundle install

Step 4a - Rsync setup

These settings are required.

Edit config.rb, and add:

activate :deploy do |deploy|
  deploy.method = :rsync
  deploy.user = "tvaughan"
  deploy.host = "www.example.com"
  deploy.path = "/srv/www/site"
end

Adjust these values accordingly.

These settings are optional.

To use a particular SSH port, add:

  deploy.port = 5309

Default is 22.

To remove orphaned files or directories on the remote host, add:

  deploy.clean = true

Default is false.

Step 4b - GitHub Pages setup

Edit config.rb, and add:

activate :deploy do |deploy|
  deploy.method = :git
end

The git deploy method assumes your project is in a repository with github set up as origin and a working gh-pages branch already in place.

Step 5

middleman build [--clean]
middleman deploy

NOTES

Inspired by the rsync task in Octopress.