tquentin / lair-docker

Lair Framework dockerized.

lair-docker

This is a dockerized version of the Lair Framework. An attempt to take all the steps from the Installation Instructions and simplify it to a few simple commands.

It also includes ngrok, to help automate the process of sharing your Lair instance with co-workers.

This was inspired and built off the initial work done by b00stfr3ak here: https://github.com/b00stfr3ak/dockerfiles/tree/master/lair;

Installation

First make sure you have docker installed. Here are OS X Beta and Linux instructions.

To install docker-compose in Linux (in case you have problem with version 1.5.2 of the repos) use the following guide. You may also need to create a symbolic link

$ ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose

then use the following commands:

$ git clone https://github.com/ryhanson/lair-docker.git
$ cd lair-docker
$ docker-compose build
$ docker-compose up

If everything worked, you should see something like:

lair_setup   | MongoDB shell version: 3.2.7
lair_setup   | connecting to: lairdb:27017/admin
lair_setup   | "Replication set initialized."
lair_caddy   | Activating privacy features... done.
lair_caddy   | 0.0.0.0:11013
lair_caddy   | 0.0.0.0:11012
lair_setup exited with code 0
lair_lair    | Created admin@localhost with password 1234abcd5678ef
lair_api     | 2016/06/20 06:29:42 Listening on 0.0.0.0:11015

Copy, paste, save, or write down your admin credentials. Then you can press Ctrl+C to stop all the services.

Usage

Before running any docker-compose commands, make sure you are in the lair-docker directory.

When you are ready to start up Lair again, run:

$ docker-compose start

To stop all Lair services, run:

$ docker-compose stop

To use ngrok, set ENABLED: 1 in docker-compose.yml and run:

$ docker-compose up ngrok

Once you've done this, you can press Ctrl+C and use start and stop like below. The up command has to be ran any time you update the docker-compose.yml file.

Moving existing MongoDB database

If you previously used this environment with /usr/local/mongodb configured as the volume for MongoDB, you'll need to copy your database files to the new volume location. You can do so by running:

$ mkdir ~/.lair
$ cp -R /usr/local/mongodb ~/.lair/

This update was made due to issues with Docker on OS X and not having proper permissions to create the /usr/local/mongodb folder. If you haven't used this Docker environment, you won't have a database to move and you can ignore the instructions above.

Using ngrok

NOTE: If you used this Docker envrionment before the ENABLED flag was added, you'll need to rebuild ngrok by running:

$ docker-compose build ngrok

To re-start ngrok after it has been stopped, run:

$ docker-compose start ngrok

To find the ngrok URL after running start, you can run:

$ docker logs lair_ngrok

To stop ngrok, run:

$ docker-compose stop ngrok