tamtam-vagrant-reload 1.1.3 → 1.2.1

data/vendor/cache/vagrant-2092df529ae7/website/content/docs/synced-folders/nfs.mdx

@@ -0,0 +1,280 @@
+---
+layout: docs
+page_title: NFS - Synced Folders
+description: >-
+  In some cases the default shared folder implementations such as VirtualBox
+
+  shared folders have high performance penalties. If you are seeing less than
+
+  ideal performance with synced folders, NFS can offer a solution. Vagrant has
+
+  built-in support to orchestrate the configuration of the NFS server on the
+  host
+
+  and guest for you.
+---
+
+# NFS
+
+In some cases the default shared folder implementations (such as VirtualBox
+shared folders) have high performance penalties. If you are seeing less
+than ideal performance with synced folders, [NFS](https://en.wikipedia.org/wiki/Network_File_System_%28protocol%29)
+can offer a solution. Vagrant has built-in support to orchestrate the
+configuration of the NFS server on the host and guest for you.
+
+~> **Windows users:** NFS folders do not work on Windows hosts. Vagrant will
+ignore your request for NFS synced folders on Windows.
+
+## Prerequisites
+
+Before using synced folders backed by NFS, the host machine must have
+`nfsd` installed, the NFS server daemon. This comes pre-installed on Mac
+OS X, and is typically a simple package install on Linux.
+
+Additionally, the guest machine must have NFS support installed. This is
+also usually a simple package installation away.
+
+If you are using the VirtualBox provider, you will also need to make sure you
+have a
+[private network set up](/vagrant/docs/networking/private_network). This is due to a limitation of VirtualBox's built-in networking. With
+VMware, you do not need this.
+
+## Enabling NFS Synced Folders
+
+To enable NFS, just add the `type: "nfs"` flag onto your synced folder:
+
+```ruby
+Vagrant.configure("2") do |config|
+  config.vm.synced_folder ".", "/vagrant", type: "nfs"
+end
+```
+
+If you add this to an existing Vagrantfile that has a running guest machine,
+be sure to `vagrant reload` to see your changes.
+
+## NFS Synced Folder Options
+
+NFS synced folders have a set of options that can be specified that are
+unique to NFS. These are listed below. These options can be specified in
+the final part of the `config.vm.synced_folder` definition, along with the
+`type` option.
+
+- `nfs_export` (boolean) - If this is false, then Vagrant will not modify
+  your `/etc/exports` automatically and assumes you've done so already.
+
+- `nfs_udp` (boolean) - Whether or not to use UDP as the transport. UDP
+  is faster but has some limitations (see the NFS documentation for more
+  details). This defaults to true.
+
+- `nfs_version` (string | integer) - The NFS protocol version to use when
+  mounting the folder on the guest. This defaults to 3.
+
+## NFS Global Options
+
+There are also more global NFS options you can set with `config.nfs` in
+the Vagrantfile. These are documented below:
+
+- `functional` (bool) - Defaults to true. If false, then NFS will not be used
+  as a synced folder type. If a synced folder specifically requests NFS,
+  it will error.
+
+- `map_uid` and `map_gid` (int) - The UID/GID, respectively, to map all
+  read/write requests too. This will not affect the owner/group within the
+  guest machine itself, but any writes will behave as if they were written
+  as this UID/GID on the host. This defaults to the current user running
+  Vagrant.
+
+- `verify_installed` (bool) - Defaults to true. If this is false, then
+  Vagrant will skip checking if NFS is installed.
+
+## Specifying NFS Arguments
+
+In addition to the options specified above, it is possible for Vagrant to
+specify alternate NFS arguments when mounting the NFS share by using the
+`mount_options` key. For example, to use the `actimeo=2` client mount option:
+
+```ruby
+config.vm.synced_folder ".", "/vagrant",
+  type: "nfs",
+  mount_options: ['actimeo=2']
+```
+
+This would result in the following `mount` command being executed on the guest:
+
+```
+mount -o 'actimeo=2' 172.28.128.1:'/path/to/vagrantfile' /vagrant
+```
+
+You can also tweak the arguments specified in the `/etc/exports` template
+when the mount is added, by using the OS-specific `linux__nfs_options` or
+`bsd__nfs_options` keys. Note that these options completely override the default
+arguments that are added by Vagrant automatically. For example, to make the
+NFS share asynchronous:
+
+```ruby
+config.vm.synced_folder ".", "/vagrant",
+  type: "nfs",
+  linux__nfs_options: ['rw','no_subtree_check','all_squash','async']
+```
+
+This would result in the following content in `/etc/exports` on the host (note
+the added `async` flag):
+
+```
+# VAGRANT-BEGIN: 21171 5b8f0135-9e73-4166-9bfd-ac43d5f14261
+"/path/to/vagrantfile" 172.28.128.5(rw,no_subtree_check,all_squash,async,anonuid=21171,anongid=660,fsid=3382034405)
+# VAGRANT-END: 21171 5b8f0135-9e73-4166-9bfd-ac43d5f14261
+```
+
+## Root Privilege Requirement
+
+To configure NFS, Vagrant must modify system files on the host. Therefore,
+at some point during the `vagrant up` sequence, you may be prompted for
+administrative privileges (via the typical `sudo` program). These
+privileges are used to modify `/etc/exports` as well as to start and
+stop the NFS server daemon.
+
+If you do not want to type your password on every `vagrant up`, Vagrant
+uses thoughtfully crafted commands to make fine-grained sudoers modifications
+possible to avoid entering your password.
+
+Below, we have a couple example sudoers entries. Note that you may
+have to modify them _slightly_ on certain hosts because the way Vagrant
+modifies `/etc/exports` changes a bit from OS to OS. If the commands below
+are located in non-standard paths, modify them as appropriate.
+
+Also note that in the sudoer file format, entries are applied in order. If you've added the appropriate entries but still have to type in your password, make sure the entries aren't inserted too early. From the sudoers man page: "When multiple entries match for a user, they are applied in order. Where there are multiple matches, the last match is used (which is not necessarily the most specific match)."
+
+For \*nix users, make sure to edit your `/etc/sudoers` file with `visudo`. It protects you against syntax errors which could leave you without the ability to gain elevated privileges.
+
+All of the snippets below require Vagrant version 1.7.3 or higher.
+
+~> **Use the appropriate group for your user** Depending on how your machine is
+configured, you might need to use a different group than the ones listed in the examples below.
+
+For macOS, sudoers should have this entry:
+
+```
+Cmnd_Alias VAGRANT_EXPORTS_ADD = /usr/bin/tee -a /etc/exports
+Cmnd_Alias VAGRANT_NFSD = /sbin/nfsd restart
+Cmnd_Alias VAGRANT_EXPORTS_REMOVE = /usr/bin/sed -E -e /*/ d -ibak /etc/exports
+%admin ALL=(root) NOPASSWD: VAGRANT_EXPORTS_ADD, VAGRANT_NFSD, VAGRANT_EXPORTS_REMOVE
+```
+
+For Linux , sudoers should look like this:
+
+```
+Cmnd_Alias VAGRANT_EXPORTS_CHOWN = /bin/chown 0\:0 /tmp/vagrant-exports
+Cmnd_Alias VAGRANT_EXPORTS_MV = /bin/mv -f /tmp/vagrant-exports /etc/exports
+Cmnd_Alias VAGRANT_NFSD_CHECK = /etc/init.d/nfs-kernel-server status
+Cmnd_Alias VAGRANT_NFSD_START = /etc/init.d/nfs-kernel-server start
+Cmnd_Alias VAGRANT_NFSD_APPLY = /usr/sbin/exportfs -ar
+%sudo ALL=(root) NOPASSWD: VAGRANT_EXPORTS_CHOWN, VAGRANT_EXPORTS_MV, VAGRANT_NFSD_CHECK, VAGRANT_NFSD_START, VAGRANT_NFSD_APPLY
+```
+
+For Fedora Linux, sudoers might look like this (given your user
+belongs to the vagrant group):
+
+```
+Cmnd_Alias VAGRANT_EXPORTS_CHOWN = /bin/chown 0\:0 /tmp/vagrant-exports
+Cmnd_Alias VAGRANT_EXPORTS_MV = /bin/mv -f /tmp/vagrant-exports /etc/exports
+Cmnd_Alias VAGRANT_NFSD_CHECK = /usr/bin/systemctl status --no-pager nfs-server.service
+Cmnd_Alias VAGRANT_NFSD_START = /usr/bin/systemctl start nfs-server.service
+Cmnd_Alias VAGRANT_NFSD_APPLY = /usr/sbin/exportfs -ar
+%vagrant ALL=(root) NOPASSWD: VAGRANT_EXPORTS_CHOWN, VAGRANT_EXPORTS_MV, VAGRANT_NFSD_CHECK, VAGRANT_NFSD_START, VAGRANT_NFSD_APPLY
+```
+
+For SUSE Linux, sudoers might look like this (given your user
+belongs to the vagrant group):
+
+```
+Cmnd_Alias VAGRANT_CHOWN = /usr/bin/chown 0\:0 /tmp/vagrant-exports
+Cmnd_Alias VAGRANT_MV = /usr/bin/mv -f /tmp/vagrant-exports /etc/exports
+Cmnd_Alias VAGRANT_START = /usr/bin/systemctl start --no-pager nfs-server
+Cmnd_Alias VAGRANT_STATUS = /usr/bin/systemctl status --no-pager nfs-server
+Cmnd_Alias VAGRANT_APPLY = /usr/sbin/exportfs -ar
+%vagrant ALL=(root) NOPASSWD: VAGRANT_CHOWN, VAGRANT_MV, VAGRANT_START, VAGRANT_STATUS, VAGRANT_APPLY
+```
+
+If you don't want to edit `/etc/sudoers` directly, you can create
+`/etc/sudoers.d/vagrant-syncedfolders` with the appropriate entries,
+assuming `/etc/sudoers.d` has been enabled.
+
+## Other Notes
+
+**Encrypted folders:** If you have an encrypted disk, then NFS very often
+will refuse to export the filesystem. The error message given by NFS is
+often not clear. One error message seen is `<path> does not support NFS`.
+There is no workaround for this other than sharing a directory which is not
+encrypted.
+
+**Version 4:** UDP is generally not a valid transport protocol for NFSv4.
+Early implementations of NFS 4.0 still allowed UDP which allows the UDP
+transport protocol to be used in rare cases. RFC5661 explicitly states
+UDP alone should not be used for the transport protocol in NFS 4.1. Errors
+due to unsupported transport protocols for specific versions of NFS are
+not always clear. A common error message when attempting to use UDP with
+NFSv4:
+
+```
+mount.nfs: an incorrect mount option was specified
+```
+
+When using NFSv4, ensure the `nfs_udp` option is set to false. For example:
+
+```ruby
+config.vm.synced_folder ".", "/vagrant",
+  type: "nfs",
+  nfs_version: 4,
+  nfs_udp: false
+```
+
+For more information about transport protocols and NFS version 4 see:
+
+- NFSv4.0 - [RFC7530](https://tools.ietf.org/html/rfc7530#section-3.1)
+- NFSv4.1 - [RFC5661](https://tools.ietf.org/html/rfc5661#section-2.9.1)
+
+## Troubleshooting NFS Issues
+
+NFS issues may arise for a variety of reasons. The following list
+describes how to possibly identify the root of the issue.
+
+- Ensure nfs server is running on the host. Check if it is running using
+  the command `ps aux | grep nfsd`. If the nfs service is not running,
+  then it may require a manual restart.
+
+- Check status of nfs-kernel-server `systemctl status nfs-kernel-server` for
+  errors like `exportfs: Failed to stat /path : No such file or directory`.
+  Then create the missing directory or remove the line from `/etc/exports`
+  and restart the nfs-kerne-server `sysctemctl start nfs-kernel-server`
+
+- If using Mac, ensure that `/sbin/nfsd` has been given Full Disk Access.
+
+- Ensure the synced folder is present in the hosts `/etc/exports` file.
+  If the target folder is not listed in `/etc/exports`, then ensure that
+  the synced_folder option `nfs_export` is set to `true`, or manually add
+  the entry.
+
+- Ensure that the contents of `/etc/exports` is valid. For example, if running
+  nfsd, this can be done by running `nfsd checkexports`.
+
+- Ensure guest machine has a nfs client installed. The client may differ
+  depending on the OS. If no nfs client is installed on the guest, then it may
+  need to be installed.
+
+- Ensure the guest has access to the mounts. This can be done using something
+  like the `rpcinfo` or `showmount` commands. For example `rpcinfo -u <ip> nfs`
+  or `showmount -e <ip>`.
+
+- Ensure a firewall is not blocking NFS.
+
+- Try manually mounting the folder, enabling verbose output:
+
+  ```
+  $ vagrant ssh
+  $ mount -v -t nfs -o <mount options> <ip address>:<path to folder on host> <mountpoint>
+  ```
+
+- If using a UDP connection: ensure UDP is enabled by the nfs server. This setting
+  can likely be changed in config file `/etc/nfs.conf`. Or, in Vagrant, set the
+  `nfs_udp` option for the synced folder to `false`.

data/vendor/cache/vagrant-2092df529ae7/website/content/docs/synced-folders/rsync.mdx

@@ -0,0 +1,105 @@
+---
+layout: docs
+page_title: RSync - Synced Folders
+description: |-
+  Vagrant can use rsync as a mechanism to sync a folder to the guest machine.
+  This synced folder type is useful primarily in situations where other synced
+  folder mechanisms are not available, such as when NFS or VirtualBox shared
+  folders are not available in the guest machine.
+---
+
+# RSync
+
+**Synced folder type:** `rsync`
+
+Vagrant can use [rsync](https://en.wikipedia.org/wiki/Rsync) as a mechanism
+to sync a folder to the guest machine. This synced folder type is useful
+primarily in situations where other synced folder mechanisms are not available,
+such as when NFS or VirtualBox shared folders are not available in the guest
+machine.
+
+The rsync synced folder does a one-time one-way sync from the machine running
+to the machine being started by Vagrant.
+
+The [rsync](/vagrant/docs/cli/rsync) and [rsync-auto](/vagrant/docs/cli/rsync-auto)
+commands can be used to force a resync and to automatically resync when
+changes occur in the filesystem. Without running these commands, Vagrant
+only syncs the folders on `vagrant up` or `vagrant reload`.
+
+## Prerequisites
+
+To use the rsync synced folder type, the machine running Vagrant must have
+`rsync` (or `rsync.exe`) on the path. This executable is expected to behave
+like the standard rsync tool.
+
+On Windows, rsync installed with Cygwin or MinGW will be detected by
+Vagrant and works well.
+
+The destination machine must also have rsync installed, but Vagrant
+can automatically install rsync into many operating systems. If Vagrant
+is unable to automatically install rsync for your operating system,
+it will tell you.
+
+The destination folder will be created as the user initiating the connection,
+this is `vagrant` by default. This user requires the appropriate permissions on
+the destination folder.
+
+## Options
+
+The rsync synced folder type accepts the following options:
+
+- `rsync__args` (array of strings) - A list of arguments to supply
+  to `rsync`. By default this is `["--verbose", "--archive", "--delete", "-z", "--copy-links"]`.
+
+- `rsync__auto` (boolean) - If false, then `rsync-auto` will not
+  watch and automatically sync this folder. By default, this is true. **Note**: This
+  option will not automatically invoke the `rsync-auto` subcommand.
+
+- `rsync__chown` (boolean) - If false, then the
+  [`owner` and `group`](/vagrant/docs/synced-folders/basic_usage)
+  options for the synced folder are ignored and Vagrant will not execute
+  a recursive `chown`. This defaults to true. This option exists because
+  the `chown` causes issues for some development environments. Note that
+  any `rsync__args` options for ownership **will be overridden** by
+  `rsync__chown`.
+
+- `rsync__exclude` (string or array of strings) - A list of files or directories
+  to exclude from the sync. The values can be any acceptable rsync exclude
+  pattern. By default, the ".vagrant/" directory is excluded. We recommend
+  excluding revision control directories such as ".git/" as well.
+
+- `rsync__rsync_ownership` (boolean) - If true, and rsync executables in use
+  are >= 3.1.0, then rsync will be used to set the owner and group instead
+  of a separate call to modify ownership. By default, this is false.
+
+- `rsync__rsync_path` (string) - The path on the remote host where rsync
+  is and how it is executed. This is platform specific but defaults to
+  "sudo rsync" for many guests.
+
+- `rsync__verbose` (boolean) - If true, then the output from the rsync
+  process will be echoed to the console. The output of rsync is subject
+  to `rsync__args` of course. By default, this is false.
+
+## Example
+
+The following is an example of using RSync to sync a folder:
+
+```ruby
+Vagrant.configure("2") do |config|
+  config.vm.synced_folder ".", "/vagrant", type: "rsync",
+    rsync__exclude: ".git/"
+end
+```
+
+## Rsync to a restricted folder
+
+If required to copy to a destination where `vagrant` user does not have
+permissions, use `"--rsync-path='sudo rsync'"` to run rsync with sudo on the guest
+
+```ruby
+Vagrant.configure("2") do |config|
+  config.vm.synced_folder "bin", "/usr/local/bin", type: "rsync",
+    rsync__exclude: ".git/",
+    rsync__args: ["--verbose", "--rsync-path='sudo rsync'", "--archive", "--delete", "-z"]
+end
+```

data/vendor/cache/vagrant-2092df529ae7/website/content/docs/synced-folders/smb.mdx

@@ -0,0 +1,128 @@
+---
+layout: docs
+page_title: SMB - Synced Folders
+description: |-
+  Vagrant can use SMB as a mechanism to create a bi-directional synced folder
+  between the host machine and the Vagrant machine.
+---
+
+# SMB
+
+**Synced folder type:** `smb`
+
+Vagrant can use [SMB](https://en.wikipedia.org/wiki/Server_Message_Block)
+as a mechanism to create a bi-directional synced folder between the host
+machine and the Vagrant machine.
+
+SMB is built-in to Windows machines and provides a higher performance
+alternative to some other mechanisms such as VirtualBox shared folders.
+
+-> SMB is currently only supported when the host machine is Windows or
+macOS. The guest machine can be Windows, Linux, or macOS.
+
+## Prerequisites
+
+### Windows Host
+
+To use the SMB synced folder type on a Windows host, the machine must have
+PowerShell version 3 or later installed. In addition, when Vagrant attempts
+to create new SMB shares, or remove existing SMB shares, Administrator
+privileges will be required. Vagrant will request these privileges using UAC.
+
+### macOS Host
+
+To use the SMB synced folder type on a macOS host, file sharing must be enabled
+for the local account. Enable SMB file sharing by following the instructions
+below:
+
+- Open "System Preferences"
+- Click "Sharing"
+- Check the "On" checkbox next to "File Sharing"
+- Click "Options"
+- Check "Share files and folders using SMB"
+- Check the "On" checkbox next to your username within "Windows File Sharing"
+- Click "Done"
+
+When Vagrant attempts to create new SMB shares, or remove existing SMB shares,
+root access will be required. Vagrant will request these privileges using
+`sudo` to run the `/usr/sbin/sharing` command. Adding the following to
+the system's `sudoers` configuration will allow Vagrant to manage SMB shares
+without requiring a password each time:
+
+```
+Cmnd_Alias VAGRANT_SMB_ADD = /usr/sbin/sharing -a * -S * -s * -g * -n *
+Cmnd_Alias VAGRANT_SMB_REMOVE = /usr/sbin/sharing -r *
+Cmnd_Alias VAGRANT_SMB_LIST = /usr/sbin/sharing -l
+Cmnd_Alias VAGRANT_SMB_PLOAD = /bin/launchctl load -w /System/Library/LaunchDaemons/com.apple.smb.preferences.plist
+Cmnd_Alias VAGRANT_SMB_DLOAD = /bin/launchctl load -w /System/Library/LaunchDaemons/com.apple.smbd.plist
+Cmnd_Alias VAGRANT_SMB_DSTART = /bin/launchctl start com.apple.smbd
+%admin ALL=(root) NOPASSWD: VAGRANT_SMB_ADD, VAGRANT_SMB_REMOVE, VAGRANT_SMB_LIST, VAGRANT_SMB_PLOAD, VAGRANT_SMB_DLOAD, VAGRANT_SMB_DSTART
+```
+
+### Guests
+
+The destination machine must be able to mount SMB filesystems. On Linux
+the package to do this is usually called `smbfs` or `cifs`. Vagrant knows
+how to automatically install this for some operating systems.
+
+## Options
+
+The SMB synced folder type has a variety of options it accepts:
+
+- `smb_host` (string) - The host IP where the SMB mount is located. If this
+  is not specified, Vagrant will attempt to determine this automatically.
+
+- `smb_password` (string) - The password used for authentication to mount
+  the SMB mount. This is the password for the username specified by
+  `smb_username`. If this is not specified, Vagrant will prompt you for it.
+  It is highly recommended that you do not set this, since it would expose
+  your password directly in your Vagrantfile.
+
+- `smb_username` (string) - The username used for authentication to mount
+  the SMB mount. This is the username to access the mount, _not_ the username
+  of the account where the folder is being mounted to. This is usually your
+  Windows username. If you sign into a domain, specify it as `user@domain`.
+  If this option is not specified, Vagrant will prompt you for it.
+
+## Example
+
+The following is an example of using SMB to sync a folder:
+
+```ruby
+Vagrant.configure("2") do |config|
+  config.vm.synced_folder ".", "/vagrant", type: "smb"
+end
+```
+
+## Preventing Idle Disconnects
+
+On Windows, if a file is not accessed for some period of time, it may
+disconnect from the guest and prevent the guest from accessing the SMB-mounted
+share. To prevent this, the following command can be used in a superuser
+shell. Note that you should research if this is the right option for you.
+
+```
+net config server /autodisconnect:-1
+```
+
+## Common Issues
+
+### "wrong fs type" Error
+
+If during mounting on Linux you are seeing an error message that includes
+the words "wrong fs type," this is because the SMB kernel extension needs to
+be updated in the OS.
+
+If updating the kernel extension is not an option, you can workaround the
+issue by specifying the following options on your synced folder:
+
+```ruby
+mount_options: ["username=USERNAME","password=PASSWORD"]
+```
+
+Replace "USERNAME" and "PASSWORD" with your SMB username and password.
+
+Vagrant 1.8 changed SMB mounting to use the more secure credential file
+mechanism. However, many operating systems ship with an outdated filesystem
+type for SMB out of the box which does not support this. The above workaround
+reverts Vagrant to the insecure before, but causes it work.

data/vendor/cache/vagrant-2092df529ae7/website/content/docs/synced-folders/virtualbox.mdx

@@ -0,0 +1,42 @@
+---
+layout: docs
+page_title: VirtualBox Shared Folders - Synced Folders
+description: |-
+  If you are using the Vagrant VirtualBox provider, then VirtualBox shared
+  folders are the default synced folder type. These synced folders use the
+  VirtualBox shared folder system to sync file changes from the guest to the
+  host and vice versa.
+---
+
+# VirtualBox
+
+If you are using the Vagrant VirtualBox [provider](/vagrant/docs/providers/), then
+VirtualBox shared folders are the default synced folder type. These synced
+folders use the VirtualBox shared folder system to sync file changes from
+the guest to the host and vice versa.
+
+## Options
+
+- `automount` (boolean) - If true, the `--automount` flag will be used when
+  using the VirtualBox tools to share the folder with the guest VM. Defaults to false
+  if not present.
+
+- `SharedFoldersEnableSymlinksCreate` (boolean) - If false, will disable the
+  ability to create symlinks with the given VirtualBox shared folder. Defaults to
+  true if the option is not present.
+
+## Caveats
+
+There is a [VirtualBox bug][sendfile bug] related to `sendfile` which can result
+in corrupted or non-updating files. You should deactivate `sendfile` in any
+web servers you may be running.
+
+In Nginx:
+
+    sendfile off;
+
+In Apache:
+
+    EnableSendfile Off
+
+[sendfile bug]: https://github.com/hashicorp/vagrant/issues/351#issuecomment-1339640