README.md in bib-vagrant-0.1.2 vs README.md in bib-vagrant-0.1.3
- old
+ new
@@ -14,25 +14,26 @@
## Installation
Install the plugin:
$ vagrant plugin install bib-vagrant
-
+
Do not use this command in a directory with a Vagrantfile which requires the plugin. Vagrant does _always_ include the Vagrantfile, and therefore will fail before installation because of the missing plugin. Just ```cd``` somewhere else and retry the command, maybe from your homedir?
## Usage
+
### Developer Settings
The config file with all developer specific settings is currently ```~/.config/easybib/vagrantdefault.yml```. If no such file exists, the plugin will create the file with default settings.
The content of this file can be retrieved using the plugin as an array, the the Vagrantfile-Example below for usage.
The current default settings and their respective usage in our Vagrantfiles are:
```
#Use filesystem shares over nfs
-nfs: false
+nfs: false
#Path to the cookbooks
cookbook_path: ~/Sites/easybib/cookbooks
#Chef Log Level
@@ -90,13 +91,13 @@
web_config.vm.provision :chef_solo do |chef|
chef.cookbooks_path = vagrantconfig["cookbook_path"]
chef.add_recipe "something::here"
chef.log_level = vagrantconfig["chef_log_level"]
end
-
- web_config.vm.provision "bib_configure_npm"
-
+
+ web_config.vm.provision "bib_configure_npm"
+
end
```
The configuration is located in `~/.config/easybib/vagrantdefault.yml`:
@@ -111,9 +112,11 @@
npm_registry: <npm registry or proxy url>
npm_username: <github or npm username>
npm_usermail: <npm or github users email address>
npm_userpass: <npm or github authentication token>
```
+
+NOTE: the npm_registry should be in the format of 'http[s]://host.domain.tld/' - The trailing slash is important
## Contributing
See [Contributing](CONTRIBUTING.md)