Skip to content
This repository was archived by the owner on Oct 25, 2018. It is now read-only.

Commit 5129364

Browse files
author
Giuseppe Morelli
committed
[imp] readme
- better organization of table config file
1 parent b200000 commit 5129364

File tree

1 file changed

+45
-32
lines changed

1 file changed

+45
-32
lines changed

README.md

Lines changed: 45 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ See `BOXES.md` for software installed list.
3131

3232
## How to use
3333
- download latest version [https://github.com/gmdotnet/vagrant-multi-machine-virtualbox/releases](https://github.com/gmdotnet/vagrant-multi-machine-virtualbox/releases)
34-
- unzip on your favorite work folder
34+
- extract on your favorite work folder
3535
- rename `config/config.yaml.sample` in `config/config.yaml`
3636
- change settings in `config/config.yaml`
3737
- run `vagrant up` on folder where is `Vagrantfile`
@@ -42,42 +42,55 @@ See `BOXES.md` for software installed list.
4242

4343
Tab indent: 4 spaces or tab
4444

45-
| Field | Type | Description | Note |
46-
| ----------------------------------- | ------------- | ------------------------------------------------------- | ---- |
47-
| host | group field | Each group of `host` create a machine in virtualbox | |
45+
| Field | Type | Description | Note |
46+
| ----------------------------------- | ------------- | ------------------------------------------------------- | ----- |
47+
| host | group field | Each group of `host` create a machine in virtualbox | |
4848
| enable | boolean | Enable or not the machine | Disabled machine aren't managed by Vagrant file, so if you want to destroy it you have to make this flag with `yes` |
49-
| vagrantbox_name | string | Name for vagrant software | |
50-
| hostname | string | Hostname of the machine | |
51-
| box > name | string | Name of the public vagrant box | Need to be publish in https://app.vagrantup.com/boxes/search |
52-
| box > version | version x.y.z | Vagrant box version | Leave empty if you want to get latest version |
53-
| box > check_update | boolean | Check for update of your box | |
49+
| vagrantbox_name | string | Name for vagrant software | |
50+
| hostname | string | Hostname of the machine | |
51+
| | | | |
52+
| **box** | | | |
53+
| box > name | string | Name of the public vagrant box | Need to be publish in https://app.vagrantup.com/boxes/search |
54+
| box > version | version x.y.z | Vagrant box version | Leave empty if you want to get latest version |
55+
| box > check_update | boolean | Check for update of your box | |
56+
| | | | |
5457
| private_ip | ipv4 | Internal ipv4 of the machine | Don't use same subnet of your computer |
5558
| ram | int | Amout of ram to allocate | |
56-
| provision > ansible > enable | boolean | Enable Ansible provisioning | |
57-
| provision > ansible > playbook_path | string | Relative path from Vagrantfile of your Ansible Playbook | |
58-
| provision > script > enable | boolean | Enable script provisioning | |
59-
| provision > script > path | string | Relative path from Vagrantfile of your script | |
60-
| plugin > hostsupdater > enable | boolean | Enable or not hostsupdater plugin | https://github.com/cogitatio/vagrant-hostsupdater |
61-
| plugin > hostsupdater > permanent | boolean | Your changes to /etc/hosts will be permanent | Only if you destroy the machine, entries in /etc/hosts will be removed |
62-
| plugin > hostsupdater > aliases | array | domain aliases for the same ip | Leave blank for no aliases |
63-
| share > folder | group field | Group of shared folder via virtualbox system | https://www.vagrantup.com/docs/synced-folders/basic_usage.html |
64-
| share > folder > host_folder | string | Path of the folder on your machine | |
65-
| share > folder > vagrant_folder | string | Path of the folder inside vagrant machine | |
66-
| share > folder > owner | string | Change owner folder inside vagrant machine | Default: vagrant |
67-
| share > folder > group | string | Change owner folder inside vagrant machine | Default: vagrant |
68-
| rsync > folder | group field | Group of sync folder via rsync | |
69-
| rsync > folder > host_folder | string | Path of the folder on your machine | |
70-
| rsync > folder > vagrant_folder | string | Path of the folder inside vagrant machine | |
71-
| rsync > folder > options | group field | Rsync parameters. One per line | https://www.vagrantup.com/docs/synced-folders/rsync.html |
72-
| rsync > folder > exclude | group field | Exclude folders from rsync | https://www.vagrantup.com/docs/synced-folders/rsync.html#rsync__exclude |
73-
| nfs > folder | group field | Group of sync folder via nfs | https://www.vagrantup.com/docs/synced-folders/nfs.html |
74-
| nfs > folder > host_folder | string | Path of the folder on your machine | |
75-
| nfs > folder > vagrant_folder | string | Path of the folder inside vagrant machine | |
76-
| nfs > folder > options | group field | Nfs options. One per line | https://www.vagrantup.com/docs/synced-folders/nfs.html#nfs-synced-folder-options |
59+
| | | | |
60+
| **provision** | | | |
61+
| provision > ansible > enable | boolean | Enable Ansible provisioning | |
62+
| provision > ansible > playbook_path | string | Relative path from Vagrantfile of your Ansible Playbook | |
63+
| provision > script > enable | boolean | Enable script provisioning | |
64+
| provision > script > path | string | Relative path from Vagrantfile of your script | |
65+
| | | | |
66+
| **plugin** | | | |
67+
| plugin > hostsupdater > enable | boolean | Enable or not hostsupdater plugin | https://github.com/cogitatio/vagrant-hostsupdater |
68+
| plugin > hostsupdater > permanent | boolean | Your changes to /etc/hosts will be permanent | Only if you destroy the machine, entries in /etc/hosts will be removed |
69+
| plugin > hostsupdater > aliases | array | domain aliases for the same ip | Leave blank for no aliases |
70+
| | | | |
71+
| **share** | | | |
72+
| share > folder | group field | Group of shared folder via virtualbox system | https://www.vagrantup.com/docs/synced-folders/basic_usage.html |
73+
| share > folder > host_folder | string | Path of the folder on your machine | |
74+
| share > folder > vagrant_folder | string | Path of the folder inside vagrant machine | |
75+
| share > folder > owner | string | Change owner folder inside vagrant machine | Default: vagrant |
76+
| share > folder > group | string | Change owner folder inside vagrant machine | Default: vagrant |
77+
| | | | |
78+
| **rsync** | | | |
79+
| rsync > folder | group field | Group of sync folder via rsync | |
80+
| rsync > folder > host_folder | string | Path of the folder on your machine | |
81+
| rsync > folder > vagrant_folder | string | Path of the folder inside vagrant machine | |
82+
| rsync > folder > options | group field | Rsync parameters. One per line | https://www.vagrantup.com/docs/synced-folders/rsync.html |
83+
| rsync > folder > exclude | group field | Exclude folders from rsync | https://www.vagrantup.com/docs/synced-folders/rsync.html#rsync__exclude |
84+
| | | | |
85+
| **nfs** | | | |
86+
| nfs > folder | group field | Group of sync folder via nfs | https://www.vagrantup.com/docs/synced-folders/nfs.html |
87+
| nfs > folder > host_folder | string | Path of the folder on your machine | |
88+
| nfs > folder > vagrant_folder | string | Path of the folder inside vagrant machine | |
89+
| nfs > folder > options | group field | Nfs options. One per line | https://www.vagrantup.com/docs/synced-folders/nfs.html#nfs-synced-folder-options |
7790

7891
## Find out GMdotnet Vagrant projects
79-
- Vagrant multi machine for Amazon AWS: [vagrant-multi-machine-amazon-aws](https://github.com/gmdotnet/vagrant-multi-machine-amazon-aws)
80-
- Vagrant multi machine for Digital Ocean: [vagrant-multi-machine-digital-ocean](https://github.com/gmdotnet/vagrant-multi-machine-digital-ocean)
92+
- Vagrant multi machine for **Amazon AWS**: [vagrant-multi-machine-amazon-aws](https://github.com/gmdotnet/vagrant-multi-machine-amazon-aws)
93+
- Vagrant multi machine for **Digital Ocean**: [vagrant-multi-machine-digital-ocean](https://github.com/gmdotnet/vagrant-multi-machine-digital-ocean)
8194

8295
## Contribution
8396
Any contribution is highly appreciated. The best way to contribute code is to open a [pull request on GitHub](https://help.github.com/articles/using-pull-requests).<br />Please create your pull request against the `develop` branch

0 commit comments

Comments
 (0)