website/docs: document synced folder options [GH-2274]
This commit is contained in:
parent
1156841225
commit
9a1001cbf5
|
@ -25,6 +25,37 @@ parameter must be an absolute path of where to share the folder within
|
|||
the guest machine. This folder will be created (recursively, if it must)
|
||||
if it doesn't exist.
|
||||
|
||||
## Options
|
||||
|
||||
As an optional third parameter to configuring synced folders, you may specify
|
||||
some options. These options are listed below. More detailed examples of using
|
||||
some of these options are shown below this section.
|
||||
|
||||
In addition to these options, the specific synced folder type might
|
||||
allow more options. See the documentation for your specific synced folder
|
||||
type for more details. The built-in synced folder types are documented
|
||||
in other pages available in the navigation for these docs.
|
||||
|
||||
* `disabled` (boolean) - If true, this synced folder will be disabled and
|
||||
won't be setup. This can be used to disable a previously defined synced
|
||||
folder or to conditionally disable a definition based on some external
|
||||
factor.
|
||||
|
||||
* `group` (string) - The group that will own the synced folder. By default
|
||||
this will be the SSH user. Some synced folder types don't support
|
||||
modifying the group.
|
||||
|
||||
* `mount_options` (array) - A list of additional mount options to pass
|
||||
to the `mount` command.
|
||||
|
||||
* `owner` (string) - The user who should be the owner of this synced folder.
|
||||
By default this will be the SSH user. Some synced folder types don't
|
||||
support modifying the owner.
|
||||
|
||||
* `type` (string) - The type of synced folder. If this is not specified,
|
||||
Vagrant will automatically choose the best synced folder option for your
|
||||
environment. Otherwise, you can specify a specific type such as "nfs".
|
||||
|
||||
## Enabling
|
||||
|
||||
Synced folders are automatically setup during `vagrant up` and
|
||||
|
|
Loading…
Reference in New Issue