middleman-deploy/README.md

66 lines
982 B
Markdown
Raw Normal View History

2012-08-21 01:50:53 +02:00
Middleman Delpoy -- Deploy a [middleman](http://middlemanapp.com/) built site over rsync.
2012-08-21 01:42:11 +02:00
===
## QUICK START
Be sure that `rsync` 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"
Then run:
bundle install
### Step 4
#### These settings are required.
Edit `config.ru`, and add:
activate :deploy do |deploy|
deploy.user = "tvaughan"
deploy.host = "www.example.com"
deploy.path = "/srv/www/site"
end
Adjust these values accordingly.
### Step 4.1
#### These settings are optional.
2012-08-21 01:47:42 +02:00
To use a particular SSH port, add:
2012-08-21 01:42:11 +02:00
deploy.port = 5309
2012-08-21 01:47:42 +02:00
Default is `22`.
To pass the `--delete` option to rsync, add:
2012-08-21 01:42:11 +02:00
deploy.delete = true
2012-08-21 01:47:42 +02:00
Default is `false`.
2012-08-21 01:42:11 +02:00
### Step 5
middleman build
middleman deploy
2012-08-21 01:56:13 +02:00
### NOTES
Inspired by the rsync task in [Octopress](https://github.com/imathis/octopress).