<commit_before>---
title: Quick start Docker
type: documentation
weight: 20
aliases:
  - /quick-start/
  - /getting-started/
menu:
    main:
      parent: installation
    
---

# Quick start with Docker

The easiest way to get started with Vamp is by spinning up one of the Docker images stored
in the [vamp-docker repo](https://github.com/magneticio/vamp-docker) and the [public Docker hub](https://hub.docker.com/r/magneticio/vamp-docker/).
This setup will run Vamp inside a Docker container with Vamp's Docker driver.
It is possible to run Vamp with and without [Marathon](https://mesosphere.github.io/marathon/).

## Step 1: Get Docker

Please install one of the following for your platform/architecture

- Docker 1.9.x (Linux), OR
- [Docker Toolbox] (https://www.docker.com/docker-toolbox) if on Mac OS X 10.8+ or Windows 7+


## Step 2: Run Vamp

Start the `magneticio/vamp-docker:0.8.0` container, taking care to pass in the right parameters. 

### Mac OS X 10.8+ or Windows 7+

NB If you installed Docker Toolbox please use "Docker Quickstart Terminal". At this moment we don't support Kitematic yet.

A typical command on Mac OS X running Docker Toolbox would be:
{{% copyable %}}
```
docker run --net=host \
           -v ~/.docker/machine/machines/default:/certs \
           -e "DOCKER_TLS_VERIFY=1" \
           -e "DOCKER_HOST=`docker-machine url default`" \
           -e "DOCKER_CERT_PATH=/certs" \
           magneticio/vamp-docker:0.8.0
```
{{% /copyable %}}

Please notice the mounting of the docker machine certificates. Please set this to your specific environment. 
You can get this info by running for instance `docker-machine config default`. 
If you don't use Docker Toolbox (or Boot2Docker), set the `DOCKER_HOST` variable to whatever is relevant to your system.
<commit_msg>adding linux quick start<commit_after>---
title: Quick start Docker
type: documentation
weight: 20
aliases:
  - /quick-start/
  - /getting-started/
menu:
    main:
      parent: installation
    
---

# Quick start with Docker

The easiest way to get started with Vamp is by spinning up one of the Docker images stored
in the [vamp-docker repo](https://github.com/magneticio/vamp-docker) and the [public Docker hub](https://hub.docker.com/r/magneticio/vamp-docker/).
This setup will run Vamp inside a Docker container with Vamp's Docker driver.
It is possible to run Vamp with and without [Marathon](https://mesosphere.github.io/marathon/).

## Step 1: Get Docker

Please install one of the following for your platform/architecture

- Docker 1.9.x (Linux), OR
- [Docker Toolbox] (https://www.docker.com/docker-toolbox) if on Mac OS X 10.8+ or Windows 7+


## Step 2: Run Vamp

Start the `magneticio/vamp-docker:0.8.0` container, taking care to pass in the right parameters. 

### Linux

A typical command would be:
{{% copyable %}}
```
docker run --net=host \
           -v /var/run/docker.sock:/var/run/docker.sock \
           -v $(which docker):/bin/docker \
           magneticio/vamp-docker:0.8.0
```
{{% /copyable %}}

Mounting volumes is important. 
Great article about starting Docker containers from/within another Docker container can be found [here](https://jpetazzo.github.io/2015/09/03/do-not-use-docker-in-docker-for-ci/).

If you want to run Vamp with Marathon:

{{% copyable %}}
```
docker run --net=host \
           -v /var/run/docker.sock:/var/run/docker.sock \
           -v $(which docker):/bin/docker \
           -v "/sys/fs/cgroup:/sys/fs/cgroup" \
           -e "DOCKER_HOST_IP=localhost" \
           magneticio/vamp-docker:0.8.0-marathon
```
{{% /copyable %}}

> **Note:** Default Marathon port is 9090 (e.g. http://localhost:9090/). 


### Mac OS X 10.8+ or Windows 7+

NB If you installed Docker Toolbox please use "Docker Quickstart Terminal". At this moment we don't support Kitematic yet.

A typical command on Mac OS X running Docker Toolbox would be:
{{% copyable %}}
```
docker run --net=host \
           -v ~/.docker/machine/machines/default:/certs \
           -e "DOCKER_TLS_VERIFY=1" \
           -e "DOCKER_HOST=`docker-machine url default`" \
           -e "DOCKER_CERT_PATH=/certs" \
           magneticio/vamp-docker:0.8.0
```
{{% /copyable %}}

Please notice the mounting of the docker machine certificates. Please set this to your specific environment. 
You can get this info by running for instance `docker-machine config default`. 
If you don't use Docker Toolbox (or Boot2Docker), set the `DOCKER_HOST` variable to whatever is relevant to your system.

{'fraction_non_alphanumeric': 0.11681101487896958, 'fraction_numerical': 0.014656895403064623, 'mean_word_length': 3.11324200913242, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 4, 'https://': 9, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1684983', 'n_tokens_mistral': 1541, 'n_tokens_neox': 1374, 'n_words': 501}