Update docs for local-exec push

This commit is contained in:
Seth Vargo 2014-11-17 13:22:40 -05:00
parent ede14d7daa
commit 202326875f
1 changed files with 8 additions and 3 deletions

View File

@ -23,8 +23,13 @@ shell command or script as part of a push.
The Vagrant Push Local Exec strategy supports the following configuration The Vagrant Push Local Exec strategy supports the following configuration
options: options:
- `command` - The command to execute (as a string). - `script` - The path to a script on disk (relative to the `Vagrantfile`) to
execute. Vagrant will attempt to convert this script to an executable, but an
exception will be raised if that fails.
- `inline` - The inline script to execute (as a string).
Please note - only one of the `script` and `inline` options may be specified in
a single push definition.
### Usage ### Usage
@ -33,7 +38,7 @@ The Vagrant Push Local Exec strategy is defined in the `Vagrantfile` using the
```ruby ```ruby
config.push.define "local-exec" do |push| config.push.define "local-exec" do |push|
push.command = <<-SCRIPT push.inline = <<-SCRIPT
scp . /var/www/website scp . /var/www/website
SCRIPT SCRIPT
end end
@ -44,7 +49,7 @@ them from the `Vagrantfile` like so:
```ruby ```ruby
config.push.define "local-exec" do |push| config.push.define "local-exec" do |push|
push.command = File.read("my-script.sh") push.script = "my-script.sh"
end end
``` ```