README.md in vagrant-parallels-0.0.4 vs README.md in vagrant-parallels-0.0.5
- old
+ new
@@ -1,16 +1,16 @@
# Vagrant Parallels Provider
-This is a [Vagrant](http://www.vagrantup.com) 1.3+ plugin that adds an [Parallels Desktop](http://www.parallels.com/products/desktop/)
-provider to Vagrant, allowing Vagrant to control and provision machines using Parallels Desktop insead of the default Virtualbox.
+This is a [Vagrant](http://www.vagrantup.com) 1.3+ plugin that adds a [Parallels Desktop](http://www.parallels.com/products/desktop/)
+provider to Vagrant, allowing Vagrant to control and provision machines using Parallels Desktop instead of the default Virtualbox.
## Note
-This project is still in active development and not all vagrant features have been developed, please report any issues you might find.
-Almost all features are available except for exporting/packaging VM's this will be available soon.
+This project is still in active development and not all vagrant features have been developed, so please report any issues you might find.
+Almost all features are available except for exporting/packaging VM's. This will be available soon.
-We look forward to hearing from you with any issues or features, Thank you
+We look forward to hearing from you with any issues or features. Thank you!
## Usage
Install using standard Vagrant 1.1+ plugin installation methods. After installing, then do a `vagrant up` and specify the `parallels` provider. An example is shown below.
```
@@ -19,12 +19,32 @@
$ vagrant init
$ vagrant up --provider=parallels
...
```
-You need to have a paralles compatible box file installed before doing a `vagrnat up`, please refer to the coming section for instaructions.
+You need to have a parallels compatible box file installed before doing a `vagrant up`, please refer to the coming section for instructions.
+### Default Provider
+
+When using parallels as your vagrant provider after almost every command you will need to append `--provider=parallels`. To simplify this you can set your default vagrant provider as **parallels**
+
+If you're using BASH
+
+```
+# Append to bash
+echo "export VAGRANT_DEFAULT_PROVIDER=parallels" | tee -a ~/.bashrc
+source ~/.bashrc
+```
+
+If you're using ZSH
+
+```
+# Append to zsh
+echo "export VAGRANT_DEFAULT_PROVIDER=parallels" | tee -a ~/.zshrc
+source ~/.zshrc
+```
+
## Box Format
Every provider in Vagrant must introduce a custom box format. This
provider introduces `parallels` boxes. You can download one using this [link](https://s3-eu-west-1.amazonaws.com/vagrant-parallels/devbox.box).
That directory also contains instructions on how to build a box.
@@ -38,10 +58,33 @@
The box format is basically just the required `metadata.json` file
along with a `Vagrantfile` that does default settings for the
provider-specific configuration for this provider.
+## Networking
+By default 'vagrant-parallels' uses the basic Vagrant networking approach. By default VM has one adapter assigned to the 'Shared' network in Parallels Desktop.
+But you can also add one ore more `:private_network` adapters, as described below:
+
+### Private Network
+It is fully compatible with basic Vagrant [Private Networking](http://docs.vagrantup.com/v2/networking/private_network.html).
+#### Available arguments:
+- `type` - IP configuration way: `:static` or `:dhcp`. Default is `:static`. If `:dchp` is set, such interface will get an IP dynamically from default subnet "10.37.129.1/255.255.255.0".
+- `ip` - IP address which will be assigned to this network adapter. It is required only if type is `:static`.
+- `netmask` - network mask. Default is `"255.255.255.0"`. It is required only if type is `:static`.
+- `nic_type` - Unnecessary argument, means the type of network adapter. Can be any of `"virtio"`, `"e1000"` or `"rtl"`. Default is `"e1000"`.
+
+#### Example:
+```ruby
+Vagrant.configure("2") do |config|
+ config.vm.network :private_network, ip: "33.33.33.50", netmask: "255.255.0.0"
+ config.vm.network :private_network, type: :dhcp, nic_type: "rtl"
+end
+```
+It means that two private network adapters will be configured:
+1) The first will have static ip '33.33.33.50' and mask '255.255.0.0'. It will be represented as device `"e1000"` by default (e.g. 'Intel(R) PRO/1000 MT').
+2) The second adapter will be configured as `"rtl"` ('Realtek RTL8029AS') and get an IP from internal DHCP server, which is working on the default network "10.37.129.1/255.255.255.0".
+
## Development
To work on the `vagrant-parallels` plugin, clone this repository out
```
@@ -68,11 +111,11 @@
```ruby
Vagrant.require_plugin "vagrant-parallels"
```
-You need to have a compatable box file installed, refer to box file section
+You need to have a compatible box file installed, refer to box file section
Use bundler to execute Vagrant:
```
$ bundle exec vagrant up --provider=parallels
@@ -87,6 +130,18 @@
$ rake build
...
$ vagrant plugin install ./pkg/vagrant-parallels-<version>.gem
...
```
-So, now you have your own plugin installed, check it by command `vagrant plugin list`
+So, now that you have your own plugin installed, check it with the command `vagrant plugin list`
+
+## Contributors
+
+A great thanks to the people who helping this project stand on its feet, thank you
+
+* Kevin Kaland `@wizonesolutions`
+* Mikhail Zholobov `@legal90`
+* Dmytro Vasylenko `@odi-um`
+* Thomas Koschate `@koschate`
+
+and to all the people who are using and testing this tool
+