Intro

I had a pretty hard time to setup a development environment for my Node.js applications, locally on Mac OSX, using Vagrant and Docker.

I finally got it running. I hope this repo will help you to build your own.

When done ...

... with the setup, you'll have a running NGINX/Node.js sample application, all in Docker containers on a Vagrant host, you can access your app in the Browser by going to http://example.com.

Your project directory will be mounted into Vagrant, so you can develop locally and your changes are automatically available in the respective Docker containers.

The Node.js app itself is run by nodemon, so the Node.js process will be restarted automatically once nodemon detects changes.

Installation

I assume that Node.js & NPM are already installed on your system - so let's get ready for Vagrant.

• install Vagrant
• install Virtualbox

Project

1. Checkout this repo

$ mkdir -p /var/www/projects
$ git clone [email protected]:ezmilhouse/docker.git example.com

This repo contains a sample app that needs some NPM love:

$ cd /var/www/projects/example.com/var/www
$ npm install

2. Go to project dir, create Vagrant box

$ cd /var/www/projects/example.com
$ vagrant up app --provision

# Virtualbox Guest Additions demand a reload
$ vagrant reload app

This will take a few minutes, as this is the initial vagrant up and therefore the first provisioning of your box.

What is happening here?

The Vagrantfile let's you define the network for your Vagrant box, so the IP we're using in the following steps is set here - change it if you like.

Vagrant will check the Vagrantfile from this repo's root directory to create a Vagrant box. Take a look at the file - the box will be provisioned for the use with Docker and afterwards a bootstrapping provision script ./bin/vagrant.provision.sh is called. That script is initiating the building of 3 Docker images:

• a basic Ubuntu image
• one for Node.js
• one for NGINX

The Docker images are defined by Dockerfile(s), take a look at them in /etc/docker/images - make changes as you like.

3. Start Docker containers for NGINX and Node.js

# ssh into your box
$ vagrant ssh app

# on the box, start containers
vagrantbox$ /vagrant/bin/env.sh start

# see them running
vagrantbox$ /vagrant/bin/env.sh state

Now you can enter your app in your browser by going to http://192.168.33.10.

What is happening here?

Docker is installed on your Vagrant box so you can use Docker the way you're used to it (via it's CLI) when you're connected to the box via vagrant ssh - ex: you can run $ docker ps -a on the box - just to make your life easier there is a little management script in /bin/env.sh that provides some handy shortcuts to start, stop or restart your Docker containers on the box.

# start all containers
$ /vagrant/bin/env.sh start

> # stop all containers
$ /vagrant/bin/env.sh stop 

> # restart all containers
$ /vagrant/bin/env.sh restart 

> # show STDOUT of container
$ /vagrant/bin/env.sh log [CONTAINER]

> # show list of running containers
$ /vagrant/bin/env.sh state 

4. Add entry to Mac OS X hosts file

# if you're still on the box, leave it for now
vagrantbox$ exit

# edit hosts file, save & exit (Ctrl-x, y)
$ sudo nano /etc/hosts

Add line (use the IP set in our Vagrantfile):

192.168.33.10    example.com

Save and flush host cache:

$ dscacheutil -flushcache; sudo killall -HUP mDNSResponder

Go to your browser, enter http://example.com - brilliant.

5. Make changes, feel the magic

Finally your app is running in Docker containers, the containers are hosted on a Vagrant box, and your project dir is synced to your local Mac OS X file system.

Let's start developing and make some changes:

• open the index.js in your app's working dir: /var/www/projects/example.com/var/www
• change the res.send('Hello World!'); into res.send('Hello Planet!');
• refresh browser at http://example.com

Have fun!