README.md in vagrant-sshfs-0.0.4 vs README.md in vagrant-sshfs-0.0.5.beta1

- old
+ new

@@ -20,9 +20,37 @@ By default it will use the Vagrant ssh username. You can change that with the following: `config.sshfs.username = "theusername"` +The plugin is enabled by default, so it will run everytime the machine starts. In case that is not desired, you can disabled that with the following configuration: + +`config.sshfs.enabled = false` + +## Issues + +### Connection reset by peer + +In case you are getting "Connection reset by peer" errors, it might be the case that you already have a host configuration under your `~/.ssh/know_hosts` for the given ip, and you are using the same ip with a different machine. If that is the case, you can set a `StrictHostKeyChecking no` under that ip to skip the check: + +``` +Host 127.0.0.1 +StrictHostKeyChecking no +``` + +### Mounting on guest (box) + +You need to have `sshfs` installed on guest machine and ssh server on host. + +To mount a host folder on guest machine add a configuration like this: + + config.sshfs.mount_on_guest = true + config.sshfs.paths = { "src" => "mountpoint" } + config.sshfs.host_addr = '10.0.2.2' + +`src` is the source absolute path to the folder in the host machine, `mountpoint` is the folder in the guest. `src` can be an absolute path, or relative to the `Vagrantfile`. +`host_addr` is the host machine IP accessible from guest. + ## Contributing If you have issues or ideas, please contribute! You can create an issue throught Github, or send a Pull Request. ## Development