groundwork

Groundwork

Vagrantfile helper for provisioning VMs

PLEASE NOTE: This is very crude and not really ready for general usage yet.

Install

$ npm install -g groundwork

Usage

$ groundwork init

This will generate a base groundwork.json file for you to customize the VM details and what provisioners to use. Along with that, it also generates .groundwork/Groundwork.rb, which is what hooks into our custom Vagrantfile which also gets generated, and does all the magic for your VM.

$ groundwork build

If you already have a configured groundwork.json file in your project already, but no accompanying Vagrantfile and .groundwork/ you can run this command to build your Vagrant requirements.

Contents of groundwork.json

By default this is what groundwork init will put in your groundwork.json file. Which is currently all the available provisioners. In the next release it will prompt you for the data.

{
  "box": "ubuntu/trusty64",
  "hostname": "groundwork-vm",
  "ip": "192.168.1.2",
  "cpus": 1,
  "memory": 512,
  "provisioners": {
    "mariadb": null,
    "nginx": null,
    "nodejs": null,
    "php": null,
    "pm2": null,
    "redis": null,
    "ubuntu": null,
    "vhost": null
  }
}

As you can see, the provisioners are key/value based. Key is the name of the provision file, and the value is a space delimited argument holder for what to pass off to the provisioner.

For example, the option below will tell the mariadb provisioner to set the root password to 123abc, create a groundwork database, and import the sql contents from database.sql file relevant to your project into it.

{
  "provisioners": {
    "mariadb": "password=123abc database=groundwork import=database.sql"
  }
}

Testing

$ npm test

Credits

• Josh Manders
• All Contributors

License

(The MIT License)

Copyright (c) 2015 We're Bold <[e-mail]>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.