From 860b304f4afd094b3c0ffbb6964e854f79e7b582 Mon Sep 17 00:00:00 2001 From: Daniel Nephin Date: Wed, 2 Sep 2015 16:30:09 -0400 Subject: [PATCH 1/3] Add COMPOSE_API_VERSION to the docs Signed-off-by: Daniel Nephin --- docs/reference/overview.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/docs/reference/overview.md b/docs/reference/overview.md index 52598737..f5d778fd 100644 --- a/docs/reference/overview.md +++ b/docs/reference/overview.md @@ -31,6 +31,26 @@ Setting this is optional. If you do not set this, the `COMPOSE_PROJECT_NAME` def Specify the file containing the compose configuration. If not provided, Compose looks for a file named `docker-compose.yml` in the current directory and then each parent directory in succession until a file by that name is found. +### COMPOSE\_API\_VERSION + +The Docker API only supports requests from clients which report a specific +version. If you receive a `client and server don't have same version error` using +`docker-compose`, you can workaround this error by setting this environment +variable. Set the version value to match the server version. + +Setting this variable is intended as a workaround for situations where you need +to run temporarily with a mismatch between the client and server version. For +example, if you can upgrade the client but need to wait to upgrade the server. + +Running with this variable set and a known mismatch does prevent some Docker +features from working properly. The exact features that fail would depend on the +Docker client and server versions. For this reason, running with this variable +set is only intended as a workaround and it is not officially supported. + +If you run into problems running with this set, resolve the mismatch through +upgrade and remove this setting to see if your problems resolve before notifying +support. + ### DOCKER\_HOST Sets the URL of the `docker` daemon. As with the Docker client, defaults to `unix:///var/run/docker.sock`. From 4bdf57ead8078e9737c87c88b0910d5fa471938b Mon Sep 17 00:00:00 2001 From: Daniel Nephin Date: Wed, 2 Sep 2015 16:55:48 -0400 Subject: [PATCH 2/3] Add a where to go next section to the main index page for compose Signed-off-by: Daniel Nephin --- docs/index.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/index.md b/docs/index.md index 4e4f58da..72de04d3 100644 --- a/docs/index.md +++ b/docs/index.md @@ -222,3 +222,14 @@ like-minded individuals, we have a number of open channels for communication. * To contribute code or documentation changes: please submit a [pull request on Github](https://github.com/docker/compose/pulls). For more information and resources, please visit the [Getting Help project page](https://docs.docker.com/project/get-help/). + +## Where to go next + +- [Installing Compose](install.md) +- [Get started with Django](django.md) +- [Get started with Rails](rails.md) +- [Get started with Wordpress](wordpress.md) +- [Command line reference](/reference) +- [Yaml file reference](yml.md) +- [Compose environment variables](env.md) +- [Compose command line completion](completion.md) From 1eb925ee3198596b44f67fe588ca6cfdff9c9521 Mon Sep 17 00:00:00 2001 From: Daniel Nephin Date: Wed, 2 Sep 2015 16:59:04 -0400 Subject: [PATCH 3/3] Link between pages in the CLI reference section Signed-off-by: Daniel Nephin --- docs/reference/docker-compose.md | 5 +++++ docs/reference/index.md | 5 +++++ docs/reference/overview.md | 12 +++++++----- 3 files changed, 17 insertions(+), 5 deletions(-) diff --git a/docs/reference/docker-compose.md b/docs/reference/docker-compose.md index 6c46b31d..b43055fb 100644 --- a/docs/reference/docker-compose.md +++ b/docs/reference/docker-compose.md @@ -55,3 +55,8 @@ used all paths in the configuration are relative to the current working directory. Each configuration can has a project name. If you supply a `-p` flag, you can specify a project name. If you don't specify the flag, Compose uses the current directory name. + +## Where to go next + +* [CLI environment variables](overview.md) +* [Command line reference](index.md) diff --git a/docs/reference/index.md b/docs/reference/index.md index e7a07b09..7a1fb9b4 100644 --- a/docs/reference/index.md +++ b/docs/reference/index.md @@ -27,3 +27,8 @@ The following pages describe the usage information for the [docker-compose](/ref * [rm](/reference/rm.md) * [scale](/reference/scale.md) * [stop](/reference/stop.md) + +## Where to go next + +* [CLI environment variables](overview.md) +* [docker-compose Command](docker-compose.md) diff --git a/docs/reference/overview.md b/docs/reference/overview.md index f5d778fd..00260711 100644 --- a/docs/reference/overview.md +++ b/docs/reference/overview.md @@ -14,6 +14,13 @@ weight=-2 This section describes the subcommands you can use with the `docker-compose` command. You can run subcommand against one or more services. To run against a specific service, you supply the service name from your compose configuration. If you do not specify the service name, the command runs against all the services in your configuration. + +## Commands + +* [docker-compose Command](docker-compose.md) +* [CLI Reference](index.md) + + ## Environment Variables Several environment variables are available for you to configure the Docker Compose command-line behaviour. @@ -70,11 +77,6 @@ Configures the time (in seconds) a request to the Docker daemon is allowed to ha it failed. Defaults to 60 seconds. - - - - - ## Compose documentation - [User guide](/)