1.7 KiB
| page_title | sidebar_current |
|---|---|
| RSync - Synced Folders | syncedfolder-rsync |
RSync
Synced folder type: rsync
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 aren't 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 and 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.
Options
The rsync synced folder type accepts the following options:
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.
Example
The following is an example of using RSync to sync a folder:
Vagrant.configure("2") do |config|
config.vm.synced_folder ".", "/vagrant", type: "rsync",
rsync__exclude: ".git/"
end