haskal
/
vagrant
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

doc: mention "directory" in the file provisioner reference

This commit is contained in:
Daniel Hahler 2015-09-25 15:14:12 +02:00
parent ce08fc155d
commit 6b033f2d65
1 changed files with 10 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
website/docs/source/v2/provisioning/file.html.md
View File

@ -7,8 +7,8 @@ sidebar_current: "provisioning-file"
**Provisioner name: `"file"`**
The file provisioner allows you to upload a file from the host machine to
the guest machine.
The file provisioner allows you to upload a file or directory from the host
machine to the guest machine.
File provisioning is a simple way to, for example, replicate your local
~/.gitconfig to the vagrant user's home directory on the guest machine so
@ -21,19 +21,20 @@ new VM.
config.vm.provision "file", source: "~/.gitconfig", destination: ".gitconfig"
end
Note that, unlike with synced folders, files that are uploaded will not
be kept in sync. Continuing with the example above, if you make further
changes to your local ~/.gitconfig, they will not be immediately reflected
in the copy you uploaded to the guest machine.
Note that, unlike with synced folders, files or directories that are uploaded
will not be kept in sync. Continuing with the example above, if you make
further changes to your local ~/.gitconfig, they will not be immediately
reflected in the copy you uploaded to the guest machine.
## Options
The file provisioner takes only two options, both of which are required:
* `source` (string) - Is the local path of the file to be uploaded.
* `source` (string) - Is the local path of the file or directory to be
uploaded.
* `destination` (string) - Is the remote path on the guest machine where
the file will be uploaded to. The file is uploaded as the SSH user over
SCP, so this location must be writable to that user. The SSH user can be
the source will be uploaded to. The file/folder is uploaded as the SSH user
over SCP, so this location must be writable to that user. The SSH user can be
determined by running `vagrant ssh-config`, and defaults to "vagrant".