From 265f1db33311c1f292211da3dcccdc1a365314fe Mon Sep 17 00:00:00 2001 From: Matt Konda Date: Mon, 28 Dec 2015 19:36:21 -0600 Subject: [PATCH] Start code highlighting and examples. --- DOCKER.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/DOCKER.md b/DOCKER.md index 169a3f3..302156f 100644 --- a/DOCKER.md +++ b/DOCKER.md @@ -6,7 +6,9 @@ configured and ready to go. # Installation +``` docker pull jemurai/pipeline:0.6 +``` # Usage @@ -14,6 +16,7 @@ docker pull jemurai/pipeline:0.6 docker run jemurai/pipeline:0.6 --help ## Typical Usage + docker run jemurai/pipeline:0.6 docker run jemurai/pipeline:0.6 https://github.com/YourOrg/YourProject.git @@ -23,6 +26,21 @@ docker run jemurai/pipeline:0.6 -l code -f json https://github.com/YourOrg/YourP Example: docker run jemurai/pipeline:0.6 -l code -f json https://github.com/Jemurai/triage.git +## On the File System + +Running against a local file system: +``` +docker run -v /code/location:/tmp/directory jemurai/pipeline:0.6 -d -f json /tmp/directory/ +``` + +Example: +``` +docker run -v /Users/mk/line/tmp/triage:/tmp/triage jemurai/pipeline:0.6 -l code -f json /tmp/triage/ +``` + +Note that the folder sharing on Windows and Mac is constrained by [Docker Volumes](https://docs.docker.com/engine/userguide/dockervolumes/). +To summarize those for Mac, it is easy to share directories in the Users home directory but if you want to share +a different directory you have to make it shared through VirtualBox or whatever container controls your base image. # Dependencies