Getting started

Docker

Currently, the only supported way of deployment is through Docker. Please consult the Docker documentation at https://docs.docker.com/ for this.

Configuring and running chefdoc.

The easiest way to get started with chefdoc is by creating your own configuration and mounting it as a Docker volume. For that, copy the config/config.sample.yaml from the repo and adapt it to your needs. If you want chefdoc to connect to your chef server make sure that it is at least version 12.4 with the Berkshelf universe endpoint (see release announcement).

With a valid config you can start chefdoc by running

docker run -d --name chefdoc -p 8080:8080 --volume=/path/to/local/config.yaml:/app/config/config.yaml chefdoc/chefdoc.info

If you want data to be persistent you can mount a volume to /data

docker run -d --volume=/tmp/chefdoc:/data --name chefdoc -p 8080:8080 -v /tmp/config.yaml:/app/config/config.yaml chefdoc/chefdoc.info

And if you want to use a real Redis instance you can do so:

docker run -d --name chefdoc-redis redis:3-alpine
docker run -d --volume=/tmp/chefdoc:/data --env 'REDIS_HOST=redis.db' --link chefdoc-redis:redis.db --name chefdoc -p 8080:8080 -v /tmp/config.yaml:/app/config/config.yaml chefdoc/chefdoc.info

In any case, you can now access chefdoc locally via http://localhost:8080.