Skip to content

Commit

Permalink
Start code highlighting and examples.
Browse files Browse the repository at this point in the history
  • Loading branch information
mkonda committed Dec 29, 2015
1 parent f83fa76 commit 265f1db
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions DOCKER.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,17 @@ configured and ready to go.

# Installation

```
docker pull jemurai/pipeline:0.6
```

# Usage

## Help
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
Expand All @@ -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

Expand Down

0 comments on commit 265f1db

Please sign in to comment.