Table of Contents

This plugin uses SSHFS slave mounts (see link) to mount a directory from the Vagrant Host into the Vagrant Guest. It uses the sftp-server software that exists on the host and sshfs running in slave mode within the guest to create a connection using the existing authentication over SSH that vagrant sets up for you.

This plugin allows you to share a folder from an arbitrary host to the Vagrant Guest. This would allow you to do a folder mount to some other host that may have files that you need. To do this the plugin will run an SSHFS command from the Guest and connect to the arbitrary host that must have an SSH daemon running. You must provide the ssh_host option in the Vagrantfile to get this to work. You can use ssh key forwarding or username/password for authentication for this.

See Options and Appendix A for more information.

NOTE: This option is dangerous as data will be destroyed upon vagrant destroy

This plugin allows you to share a folder from a Vagrant guest into the host. If you have workloads where there are a lot of disk intensive operations (such as compilation) it may be ideal to have the files live in the guest where the disk intensive operations would occur. For discussion see Issue #7.

See Options for more information on how to enable this type of mount.

In order to install the plugin simply run the following command:

Edit your Vagrantfile to specify a folder to mount from the host into the guest:

Now you can simply vagrant up and your folder should be mounted in the guest. For more options that you can add see the Options section.

vagrant sshfs [--mount|--unmount] [vm-name]

The SSHFS synced folder plugin supports a few options that can be provided in the Vagrantfile. They are described below:

• disabled

  • If set to 'true', ignore this folder and don’t mount it.

• ssh_opts_append

  • Add some options for the ssh connection that will be established.

  • See the ssh man page for more details on possible options.

• sshfs_opts_append

  • Add some options for the sshfs fuse mount that will made

  • See the sshfs man page for more details on possible options.

An example snippet from a Vagrantfile:

The following options are only to be used when sharing an arbitrary host directory with the guest. They will be ignored otherwise:

• ssh_host

  • The host to connect to via SSH. If not provided this will be detected as the Vagrant host that is running the Vagrant guest.

• ssh_port

  • The port to use when connecting. Defaults to port 22.

• ssh_username

  • The username to use when connecting. If not provided it is detected as the current user who is interacting with Vagrant.

• ssh_password

  • The password to use when connecting. If not provided and the user is not using SSH keys, then the user will be prompted for the password. Please use SSH keys and don’t use this option!

• prompt_for_password

  • The user can force Vagrant to interactively prompt the user for a password by setting this to 'true'. Alternatively the user can deny Vagrant from ever prompting for the password by setting this to 'false'.

An example snippet from a Vagrantfile:

If your host has the sshfs software installed then the following options enable mounting a folder from a Vagrant Guest into the Vagrant Host:

• reverse

  • This can be set to 'true' to enable reverse mounting a guest folder into the Vagrant host.

An example snippet from a Vagrantfile where we want to mount /data on the guest into /guest/data on the host:

Sometimes it can take time for files to appear on the other end of the sshfs mount. An example would be I create a file on my host system and then it doesn’t show up inside the guest mount for 10 to 20 seconds. This is because of caching that SSHFS does to improve performance. Performance vs accuracy is always going to be a trade-off. If you’d like to disable caching completely you can disable caching completely by appending the cache=no SSHFS option to the synced folder definition in the Vagrantfile like so:

All caching options that are available to sshfs can be added/modified in this same manner.

config.ssh.forward_agent = 'true'

# eval $(ssh-agent)
# ssh-add /path/to/key1

# vagrant up

# Install development dependencies
$ gem install bundler && bundle install

# Build the gem (gets generated in the 'pkg' directory
$ bundle exec rake build

# Run Vagrant in the context of the plugin
$ bundle exec vagrant <command>

# Install built gem into global Vagrant installation (run outside of git checkout!)
$ vagrant plugin install <path to gem in pkg directory>