vagrant-bindfs 0.2.1 → 0.2.2

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2010-2012 Folken Laëneck
+Copyright (c) 2010-2013 Gaël-Ian Havard
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -3,18 +3,41 @@
 A Vagrant plugin to automate [bindfs](http://code.google.com/p/bindfs/) mount in the VM.
 This allow you to change owner, group and permissions on files and, for example, work around NFS share permissions issues.
 
+## Some Background: Why `vagrant-bindfs`
+
+The default vagrant provider is [virtualbox](https://www.virtualbox.org/).
+It's free, and it works well, but it has some [performance problems](http://snippets.aktagon.com/snippets/609-Slow-IO-performance-with-Vagrant-and-VirtualBox-).
+
+People often recommend switching to [vagrant's VMWare-fusion provider](http://www.vagrantup.com/vmware).
+This reportedly has better performance, but shares with symlinks [won't work](http://communities.vmware.com/thread/428199?start=0&tstart=0)
+You also have to buy both the plugin and VMWare-fusion.
+
+The final recommendation, at least on Linux/OSX hosts, is to [use nfs](http://docs.vagrantup.com/v2/synced-folders/nfs.html).
+However, an NFS mount has the same numeric permissions in the guest as in the host.
+If you're on OSX, for instance, a folder owned by the default OSX user will appear to be [owned by `501:20`](https://groups.google.com/forum/?fromgroups#!topic/vagrant-up/qXXJ-AQuKQM) in the guest.
+
+This is where `vagrant-bindfs` comes in!
+Simply:
+
+- mount your share over NFS into a temporary location in the guest
+- re-mount the share to the actual destination with `vagrant-bindfs`, setting the correct permissions
 
 ## Installation
 
 Vagrant-bindfs is distributed as a Ruby gem.
 You can install it as any other Vagrant plugin with `vagrant plugin install vagrant-bindfs`.
 
+## Usage
 
-## Configure your VM
+In your `Vagrantfile`, use `config.bindfs.bind_folder` to configure folders that will be binded on VM startup.
+The format is:
+```ruby
+     config.bindfs.bind_folder "/path/to/source", "/path/to/destination", options
+```
 
-In your VagrantFile, you can use `config.bindfs.bind_folder` to configure folders that will be binded on VM startup.
+### Example
 
-    # In your Vagrantfile
+```ruby
     Vagrant::Config.run do |config|
     
       [...] # Your VM configuration
@@ -31,8 +54,11 @@ In your VagrantFile, you can use `config.bindfs.bind_folder` to configure folder
       config.bindfs.bind_folder "/vagrant-nfs", "guest/mount/point"
         
     end
+```
+
+### Supported options
 
-bind_folder support following arguments...
+`bind_folder` supports the following arguments:
 
 - `:user` (defaults to 'vagrant')
 - `:group` (defaults to 'vagrant')
@@ -63,11 +89,27 @@ bind_folder support following arguments...
 - `:'xattr-rw'`
 - `:'ctime-from-mtime'`
     
-Ex: ``.
-
 You can overwrite default options _via_ `config.bindfs.default_options`.
 
 See [bindfs man page](http://www.cs.helsinki.fi/u/partel/bindfs_docs/bindfs.1.html) for details.
 
 vagrant-bindfs does not check compatibility between given arguments but warn you when a binding command fail or if bindfs is not installed on your virtual machine.
 On Debian systems, it will try to install bindfs automatically.
+
+## Contributing
+
+If you find this plugin useful, we could use a few enhancements!
+In particular, capabilities files for installing vagrant-bindfs on systems other than Debian would be useful.
+We could also use some specs...
+
+### How to Test Changes
+
+If you've made changes to this plugin, you can easily test it locally in vagrant.
+From the root of the repo, do:
+
+- `bundle install`
+- `rake build`
+- `bundle exec vagrant up`
+
+This will spin up a default Debian VM and try to bindfs-mount some shares in it.
+Feel free to modify the included `Vagrantfile` to add additional test cases.

data/lib/vagrant-bindfs/version.rb

@@ -1,3 +1,3 @@
 module VagrantBindfs
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

metadata

@@ -2,21 +2,21 @@
 name: vagrant-bindfs
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors: 
-- "Folken La\xC3\xABneck"
+- "Ga\xC3\xABl-Ian Havard"
 - Igor Serebryany
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2013-06-04 00:00:00 Z
+date: 2013-07-22 00:00:00 Z
 dependencies: []
 
 description: A Vagrant plugin to automate bindfs mount in the VM. This allow you to change owner, group and permissions on files and, for example, work around NFS share permissions issues.
 email: 
-- folken.laeneck@gmail.com
+- gaelian.havard@gmail.com
 - igor.serebryany@airbnb.com
 executables: []
 
@@ -36,7 +36,7 @@ files:
 - locales/en.yml
 - README.md
 - LICENSE.txt
-homepage: https://github.com/folken-laeneck/vagrant-bindfs
+homepage: https://github.com/gael-ian/vagrant-bindfs
 licenses: []
 
 post_install_message: