clair/docs/Run.md

# Running Clair

## Configuration

Clair makes uses of a configuration file in YAML.

Copy [`config.example.yaml`](../config.example.yaml) to your choice of location, and update the values as required.
The example configuration file is commented and explains every available key.

## Docker

The easiest way to run Clair is with Docker.

```
$ docker pull quay.io/coreos/clair:latest
$ docker run -p 6060:6060 -p 6061:6061 -v <DIR_WITH_CONFIG>:/config:ro quay.io/coreos/clair:latest --config=/config/<CONFIG_FILENAME>.yaml
```

## Initial update & API

Right after Clair starts, it will update its vulnerability database.
The initial update can take quite a long time depending on the database backend in use.
Clair will announce the update completion.

As soon as Clair has started, you can start querying the API to interact with it.
Read the [API Documentation](API.md) to learn more.
The [`contrib`](../contrib) folder contains some tools that may help you to get started.
main: Use configuration file instead of flags and simplify app extension. Clair will now use a YAML configuration file instead of command line arguments as the number of parameters grows. Also, Clair now exposes a Boot() func that allows everyone to easily create their own project and load dynamically their own fetchers/updaters. 2015-12-07 21:38:50 +00:00			`# Running Clair`
Initial commit 2015-11-13 19:11:28 +00:00
main: Use configuration file instead of flags and simplify app extension. Clair will now use a YAML configuration file instead of command line arguments as the number of parameters grows. Also, Clair now exposes a Boot() func that allows everyone to easily create their own project and load dynamically their own fetchers/updaters. 2015-12-07 21:38:50 +00:00			`## Configuration`
Initial commit 2015-11-13 19:11:28 +00:00
main: Use configuration file instead of flags and simplify app extension. Clair will now use a YAML configuration file instead of command line arguments as the number of parameters grows. Also, Clair now exposes a Boot() func that allows everyone to easily create their own project and load dynamically their own fetchers/updaters. 2015-12-07 21:38:50 +00:00			`Clair makes uses of a configuration file in YAML.`
Initial commit 2015-11-13 19:11:28 +00:00
main: Use configuration file instead of flags and simplify app extension. Clair will now use a YAML configuration file instead of command line arguments as the number of parameters grows. Also, Clair now exposes a Boot() func that allows everyone to easily create their own project and load dynamically their own fetchers/updaters. 2015-12-07 21:38:50 +00:00			Copy [`config.example.yaml`](../config.example.yaml) to your choice of location, and update the values as required.
			`The example configuration file is commented and explains every available key.`
Initial commit 2015-11-13 19:11:28 +00:00
main: Use configuration file instead of flags and simplify app extension. Clair will now use a YAML configuration file instead of command line arguments as the number of parameters grows. Also, Clair now exposes a Boot() func that allows everyone to easily create their own project and load dynamically their own fetchers/updaters. 2015-12-07 21:38:50 +00:00			`## Docker`
Initial commit 2015-11-13 19:11:28 +00:00
main: Use configuration file instead of flags and simplify app extension. Clair will now use a YAML configuration file instead of command line arguments as the number of parameters grows. Also, Clair now exposes a Boot() func that allows everyone to easily create their own project and load dynamically their own fetchers/updaters. 2015-12-07 21:38:50 +00:00			`The easiest way to run Clair is with Docker.`
Initial commit 2015-11-13 19:11:28 +00:00
main: Use configuration file instead of flags and simplify app extension. Clair will now use a YAML configuration file instead of command line arguments as the number of parameters grows. Also, Clair now exposes a Boot() func that allows everyone to easily create their own project and load dynamically their own fetchers/updaters. 2015-12-07 21:38:50 +00:00			```
			`$ docker pull quay.io/coreos/clair:latest`
			`$ docker run -p 6060:6060 -p 6061:6061 -v <DIR_WITH_CONFIG>:/config:ro quay.io/coreos/clair:latest --config=/config/<CONFIG_FILENAME>.yaml`
			```
Initial commit 2015-11-13 19:11:28 +00:00
main: Use configuration file instead of flags and simplify app extension. Clair will now use a YAML configuration file instead of command line arguments as the number of parameters grows. Also, Clair now exposes a Boot() func that allows everyone to easily create their own project and load dynamically their own fetchers/updaters. 2015-12-07 21:38:50 +00:00			`## Initial update & API`
Initial commit 2015-11-13 19:11:28 +00:00
main: Use configuration file instead of flags and simplify app extension. Clair will now use a YAML configuration file instead of command line arguments as the number of parameters grows. Also, Clair now exposes a Boot() func that allows everyone to easily create their own project and load dynamically their own fetchers/updaters. 2015-12-07 21:38:50 +00:00			`Right after Clair starts, it will update its vulnerability database.`
			`The initial update can take quite a long time depending on the database backend in use.`
			`Clair will announce the update completion.`

			`As soon as Clair has started, you can start querying the API to interact with it.`
			`Read the [API Documentation](API.md) to learn more.`
			The [`contrib`](../contrib) folder contains some tools that may help you to get started.