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

Commit ab54cf0

Browse files
author
Giuseppe Morelli
authored
Update README
1 parent af0564a commit ab54cf0

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[![stable version](https://img.shields.io/badge/stable%20version-1.0.0-green.svg?style=flat-square)](https://github.com/gmdotnet/vagrant-multi-machine-virtualbox/releases/tag/1.0.0)
1+
[![stable version](https://img.shields.io/badge/stable%20version-1.1.0-green.svg?style=flat-square)](https://github.com/gmdotnet/vagrant-multi-machine-virtualbox/releases/tag/1.1.0)
22
[![develop](https://img.shields.io/badge/beta%20version-branch%20develop-oran.svg?style=flat-square)](https://github.com/gmdotnet/vagrant-multi-machine-virtualbox/tree/develop)
33
[![license](https://img.shields.io/badge/license-OSL--3-blue.svg?style=flat-square)](https://github.com/gmdotnet/vagrant-multi-machine-virtualbox/blob/master/LICENSE.txt)
44
[![gitter](https://img.shields.io/gitter/room/nwjs/nw.js.svg)](https://gitter.im/GMdotnet/Lobby?utm_source=share-link&utm_medium=link&utm_campaign=share-link)
@@ -38,6 +38,20 @@ See `BOXES.md` for software installed list.
3838
- (optional) make your configuration on vagrant machine entering by run `vagrant ssh`
3939
- have fun and happy coding!
4040

41+
### Config file `config.yaml`
42+
43+
| Field | Type | Description | Note |
44+
| --------------- | ------------- | --------------------------------------------------- | ---- |
45+
| host | group field | Each group of `host` create a machine in virtualbox | |
46+
| 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` |
47+
| vagrantbox_name | string | Name for vagrant software | |
48+
| hostname | string | Hostname of the machine | |
49+
| box > name | string | Name of the public vagrant box | Need to be publish in https://app.vagrantup.com/boxes/search |
50+
| box > version | version x.y.z | Vagrant box version | |
51+
| check_update | boolean | Check for update of your box | |
52+
| private_ip | ipv4 | Internal ipv4 of the machine | Don't use same subnet of your computer |
53+
| ram | int | Amout of ram to allocate | |
54+
4155
## Contribution
4256
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
4357

0 commit comments

Comments
 (0)