diff --git a/docs/cli.md b/docs/cli.md index f6d0c789..1dfd703e 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -101,6 +101,8 @@ By default if there are existing containers for a service, `fig up` will stop an Several environment variables can be used to configure Fig's behaviour. +Variables starting with `DOCKER_` are the same as those used to configure the Docker command-line client. If you're using boot2docker, `$(boot2docker shellinit)` will set them to their correct values. + ### FIG\_PROJECT\_NAME Set the project name, which is prepended to the name of every container started by Fig. Defaults to the `basename` of the current working directory. @@ -112,3 +114,11 @@ Set the path to the `fig.yml` to use. Defaults to `fig.yml` in the current worki ### DOCKER\_HOST Set the URL to the docker daemon. Defaults to `unix:///var/run/docker.sock`, as with the docker client. + +### DOCKER\_TLS\_VERIFY + +When set to anything other than an empty string, enables TLS communication with the daemon. + +### DOCKER\_CERT\_PATH + +Configure the path to the `ca.pem`, `cert.pem` and `key.pem` files used for TLS verification. Defaults to `~/.docker`. diff --git a/docs/install.md b/docs/install.md index 8c8f97a1..996cd828 100644 --- a/docs/install.md +++ b/docs/install.md @@ -8,11 +8,11 @@ Installing Fig First, install Docker version 1.3 or greater. -If you're on OS X, you can use the [OS X installer](https://docs.docker.com/installation/mac/). You'll also need to set an environment variable to point at the Boot2Docker virtual machine: +If you're on OS X, you can use the [OS X installer](https://docs.docker.com/installation/mac/) to install both Docker and boot2docker. Once boot2docker is running, set the environment variables that'll configure Docker and Fig to talk to it: - $ export DOCKER_HOST=tcp://`boot2docker ip`:2375 + $(boot2docker shellinit) -If you want this to persist across shell sessions, you can add it to your `~/.bashrc` file. +To persist the environment variables across shell sessions, you can add that line to your `~/.bashrc` file. There are also guides for [Ubuntu](https://docs.docker.com/installation/ubuntulinux/) and [other platforms](https://docs.docker.com/installation/) in Docker’s documentation.