Updated documentation
This commit is contained in:
parent
bf8ce71a49
commit
134420026b
1 changed files with 17 additions and 7 deletions
24
README.md
24
README.md
|
@ -6,7 +6,7 @@ Middleman Delpoy -- Deploy a [middleman](http://middlemanapp.com/) built site ov
|
||||||
|
|
||||||
## QUICK START
|
## QUICK START
|
||||||
|
|
||||||
Be sure that `rsync` is installed.
|
If deploying through `rsync`, be sure it is installed.
|
||||||
|
|
||||||
### Step 1
|
### Step 1
|
||||||
|
|
||||||
|
@ -27,22 +27,21 @@ Then run:
|
||||||
|
|
||||||
bundle install
|
bundle install
|
||||||
|
|
||||||
### Step 4
|
### Step 4a - Rsync setup
|
||||||
|
|
||||||
#### These settings are required.
|
#### These settings are required.
|
||||||
|
|
||||||
Edit `config.rb`, and add:
|
Edit `config.rb`, and add:
|
||||||
|
|
||||||
activate :deploy do |deploy|
|
activate :deploy do |deploy|
|
||||||
deploy.user = "tvaughan"
|
deploy.method = :rsync
|
||||||
deploy.host = "www.example.com"
|
deploy.user = "tvaughan"
|
||||||
deploy.path = "/srv/www/site"
|
deploy.host = "www.example.com"
|
||||||
|
deploy.path = "/srv/www/site"
|
||||||
end
|
end
|
||||||
|
|
||||||
Adjust these values accordingly.
|
Adjust these values accordingly.
|
||||||
|
|
||||||
### Step 4.1
|
|
||||||
|
|
||||||
#### These settings are optional.
|
#### These settings are optional.
|
||||||
|
|
||||||
To use a particular SSH port, add:
|
To use a particular SSH port, add:
|
||||||
|
@ -57,6 +56,17 @@ To remove orphaned files or directories on the remote host, add:
|
||||||
|
|
||||||
Default is `false`.
|
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
|
### Step 5
|
||||||
|
|
||||||
middleman build
|
middleman build
|
||||||
|
|
Loading…
Reference in a new issue