mirror of https://github.com/docker/compose.git
Cleanup command-line reference docs by renaming overview to envvars.
Signed-off-by: Daniel Nephin <dnephin@docker.com>
This commit is contained in:
parent
5e30f089e3
commit
2df5593e8f
|
@ -51,7 +51,7 @@ Compose uses the project name to create unique identifiers for all of a
|
|||
project's containers and other resources. To run multiple copies of a project,
|
||||
set a custom project name using the [`-p` command line
|
||||
option](./reference/docker-compose.md) or the [`COMPOSE_PROJECT_NAME`
|
||||
environment variable](./reference/overview.md#compose-project-name).
|
||||
environment variable](./reference/envvars.md#compose-project-name).
|
||||
|
||||
## What's the difference between `up`, `run`, and `start`?
|
||||
|
||||
|
|
|
@ -20,7 +20,11 @@ container for a service joins the default network and is both *reachable* by
|
|||
other containers on that network, and *discoverable* by them at a hostname
|
||||
identical to the container name.
|
||||
|
||||
> **Note:** Your app's network is given a name based on the "project name", which is based on the name of the directory it lives in. You can override the project name with either the [`--project-name` flag](reference/docker-compose.md) or the [`COMPOSE_PROJECT_NAME` environment variable](reference/overview.md#compose-project-name).
|
||||
> **Note:** Your app's network is given a name based on the "project name",
|
||||
> which is based on the name of the directory it lives in. You can override the
|
||||
> project name with either the [`--project-name`
|
||||
> flag](reference/docker-compose.md) or the [`COMPOSE_PROJECT_NAME` environment
|
||||
> variable](reference/envvars.md#compose-project-name).
|
||||
|
||||
For example, suppose your app is in a directory called `myapp`, and your `docker-compose.yml` looks like this:
|
||||
|
||||
|
|
|
@ -93,7 +93,7 @@ this project name to:
|
|||
The default project name is the basename of the project directory. You can set
|
||||
a custom project name by using the
|
||||
[`-p` command line option](./reference/docker-compose.md) or the
|
||||
[`COMPOSE_PROJECT_NAME` environment variable](./reference/overview.md#compose-project-name).
|
||||
[`COMPOSE_PROJECT_NAME` environment variable](./reference/envvars.md#compose-project-name).
|
||||
|
||||
### Preserve volume data when containers are created
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
<!--[metadata]>
|
||||
+++
|
||||
title = "docker-compose"
|
||||
title = "docker-compose Command"
|
||||
description = "docker-compose Command Binary"
|
||||
keywords = ["fig, composition, compose, docker, orchestration, cli, docker-compose"]
|
||||
[menu.main]
|
||||
|
@ -12,7 +12,13 @@ weight=-2
|
|||
|
||||
# docker-compose Command
|
||||
|
||||
This page provides the usage information for the `docker-compose` Command.
|
||||
You can also see this information by running `docker-compose --help` from the
|
||||
command line.
|
||||
|
||||
```
|
||||
Define and run multi-container applications with Docker.
|
||||
|
||||
Usage:
|
||||
docker-compose [-f=<arg>...] [options] [COMMAND] [ARGS...]
|
||||
docker-compose -h|--help
|
||||
|
@ -25,6 +31,10 @@ Options:
|
|||
|
||||
Commands:
|
||||
build Build or rebuild services
|
||||
config Validate and view the compose file
|
||||
create Create services
|
||||
down Stop and remove containers, networks, images, and volumes
|
||||
events Receive real time events from containers
|
||||
help Get help on a command
|
||||
kill Kill containers
|
||||
logs View output from containers
|
||||
|
@ -41,6 +51,7 @@ Commands:
|
|||
unpause Unpause services
|
||||
up Create and start containers
|
||||
version Show the Docker-Compose version information
|
||||
|
||||
```
|
||||
|
||||
The Docker Compose binary. You use this command to build and manage multiple
|
||||
|
@ -92,15 +103,15 @@ same directory level, Compose combines the two files into a single configuration
|
|||
The configuration in the `docker-compose.override.yml` file is applied over and
|
||||
in addition to the values in the `docker-compose.yml` file.
|
||||
|
||||
See also the `COMPOSE_FILE` [environment variable](overview.md#compose-file).
|
||||
See also the `COMPOSE_FILE` [environment variable](envvars.md#compose-file).
|
||||
|
||||
Each configuration 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. See also the `COMPOSE_PROJECT_NAME` [environment variable](
|
||||
overview.md#compose-project-name)
|
||||
envvars.md#compose-project-name)
|
||||
|
||||
|
||||
## Where to go next
|
||||
|
||||
* [CLI environment variables](overview.md)
|
||||
* [CLI environment variables](envvars.md)
|
||||
* [Command line reference](index.md)
|
||||
|
|
|
@ -1,34 +1,24 @@
|
|||
<!--[metadata]>
|
||||
+++
|
||||
title = "Introduction to the CLI"
|
||||
description = "Introduction to the CLI"
|
||||
title = "CLI Environment Variables"
|
||||
description = "CLI Environment Variables"
|
||||
keywords = ["fig, composition, compose, docker, orchestration, cli, reference"]
|
||||
aliases = ["/compose/reference/overview/"]
|
||||
[menu.main]
|
||||
parent = "smn_compose_cli"
|
||||
weight=-2
|
||||
weight=-1
|
||||
+++
|
||||
<![end-metadata]-->
|
||||
|
||||
|
||||
# Introduction to the CLI
|
||||
|
||||
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
|
||||
# CLI Environment Variables
|
||||
|
||||
Several environment variables are available for you to configure the Docker Compose command-line behaviour.
|
||||
|
||||
Variables starting with `DOCKER_` are the same as those used to configure the
|
||||
Docker command-line client. If you're using `docker-machine`, then the `eval "$(docker-machine env my-docker-vm)"` command should set them to their correct values. (In this example, `my-docker-vm` is the name of a machine you created.)
|
||||
|
||||
### COMPOSE\_PROJECT\_NAME
|
||||
## COMPOSE\_PROJECT\_NAME
|
||||
|
||||
Sets the project name. This value is prepended along with the service name to the container container on start up. For example, if you project name is `myapp` and it includes two services `db` and `web` then compose starts containers named `myapp_db_1` and `myapp_web_1` respectively.
|
||||
|
||||
|
@ -36,14 +26,14 @@ Setting this is optional. If you do not set this, the `COMPOSE_PROJECT_NAME`
|
|||
defaults to the `basename` of the project directory. See also the `-p`
|
||||
[command-line option](docker-compose.md).
|
||||
|
||||
### COMPOSE\_FILE
|
||||
## COMPOSE\_FILE
|
||||
|
||||
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. See also the `-f` [command-line option](docker-compose.md).
|
||||
|
||||
### COMPOSE\_API\_VERSION
|
||||
## 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
|
||||
|
@ -63,20 +53,20 @@ 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
|
||||
## DOCKER\_HOST
|
||||
|
||||
Sets the URL of the `docker` daemon. As with the Docker client, defaults to `unix:///var/run/docker.sock`.
|
||||
|
||||
### DOCKER\_TLS\_VERIFY
|
||||
## DOCKER\_TLS\_VERIFY
|
||||
|
||||
When set to anything other than an empty string, enables TLS communication with
|
||||
the `docker` daemon.
|
||||
|
||||
### DOCKER\_CERT\_PATH
|
||||
## DOCKER\_CERT\_PATH
|
||||
|
||||
Configures the path to the `ca.pem`, `cert.pem`, and `key.pem` files used for TLS verification. Defaults to `~/.docker`.
|
||||
|
||||
### COMPOSE\_HTTP\_TIMEOUT
|
||||
## COMPOSE\_HTTP\_TIMEOUT
|
||||
|
||||
Configures the time (in seconds) a request to the Docker daemon is allowed to hang before Compose considers
|
||||
it failed. Defaults to 60 seconds.
|
|
@ -14,6 +14,7 @@ weight=80
|
|||
|
||||
The following pages describe the usage information for the [docker-compose](docker-compose.md) subcommands. You can also see this information by running `docker-compose [SUBCOMMAND] --help` from the command line.
|
||||
|
||||
* [docker-compose](docker-compose.md)
|
||||
* [build](build.md)
|
||||
* [config](config.md)
|
||||
* [create](create.md)
|
||||
|
@ -37,5 +38,5 @@ The following pages describe the usage information for the [docker-compose](dock
|
|||
|
||||
## Where to go next
|
||||
|
||||
* [CLI environment variables](overview.md)
|
||||
* [CLI environment variables](envvars.md)
|
||||
* [docker-compose Command](docker-compose.md)
|
||||
|
|
Loading…
Reference in New Issue