generator-dockervagrant

Docker-Vagrant

This repo contains files to help create docker images to turn your application into a service container. It also has base Vagrantfiles to setup a local dev environment for your containers. The repo is also a Yeoman generator. You can use the generator to copy the needed files automatically to your project directory.

Getting Started

There are two ways to use this repo.

1. Install as a yeoman generator to automatically copy all files

$ npm install -g generator-dockervagrant

2. Clone and copy the files needed manually

Its recommended to use option 1 (see the what-is-yeoman? section for more info). But if you don't want to get involved with node and npm option 2 is available.

What is Yeoman?

Basically, he wears a top hat, lives in your computer, and waits for you to tell him what kind of application you wish to create.

Not every new computer comes with a Yeoman pre-installed. He lives in the npm package repository. You only have to ask for him once, then he packs up and moves into your hard drive. Make sure you clean up, he likes new and shiny things.

npm install -g yo

Yeoman Generators

Yeoman travels light. He didn't pack any generators when he moved in. You can think of a generator like a plug-in. You get to choose what type of application you wish to create, such as a Backbone application or even a Chrome extension.

To install generator-dockervagrant from npm, run:

npm install -g generator-dockervagrant

Finally, initiate the generator:

yo dockervagrant

It will install these basic files for a Docker/Vagrant setup

• .dockerignore - a basic docker ignore file to get you started
• Dockerfile - generic Dockerfile for any application type
• Vagrantfile - if you answer yes to using Vagrant this file will get you started with a VM setup with docker and install your image on it (recommended)
• docker_removecontainers.sh - helper script for Vagrant vm to cleanup image when restarting/reloading vm
• provision_base.sh - configures the Vagrant vm with basic defaults for docker
• provision_custom.sh - a place to put custom install instructions for the Vagrant vm
• provision_before_docker.sh - custom provisioning instructions before running Docker provisioning
• provision_after_docker.sh - custom provisioning instructions after running Docker provisioning

Sub-Generators

This will give you the option to install additional helper containers into your dev environment.

yo dockervagrant:containers

Dockerfile and a few config files for a nodejs application container.

yo dockervagrant:nodejs

Dockerfile and a few config files for a PHP/Apache application container.

yo dockervagrant:php

License

MIT