Add Docker docs.docker.com meta-data, and reflow to 80-chars to simplify github diffs
Signed-off-by: Sven Dowideit <SvenDowideit@docker.com>
This commit is contained in:
Sven Dowideit
Sven Dowideit
parent
e4d6a2c240
commit
d8d0fd6dc9
4 changed files with 130 additions and 54 deletions
63
docs/cli.md
63
docs/cli.md
|
|
@ -1,12 +1,15 @@
|
|||
---
|
||||
layout: default
|
||||
title: Compose CLI reference
|
||||
page_title: Compose CLI reference
|
||||
page_description: Compose CLI reference
|
||||
page_keywords: fig, composition, compose, docker
|
||||
---
|
||||
|
||||
CLI reference
|
||||
=============
|
||||
# CLI reference
|
||||
|
||||
Most commands are run against one or more services. If the service is omitted, it will apply to all services.
|
||||
Most commands are run against one or more services. If the service is omitted,
|
||||
it will apply to all services.
|
||||
|
||||
Run `docker-compose [COMMAND] --help` for full usage.
|
||||
|
||||
|
|
@ -34,7 +37,9 @@ Run `docker-compose [COMMAND] --help` for full usage.
|
|||
|
||||
Build or rebuild services.
|
||||
|
||||
Services are built once and then tagged as `project_service`, e.g. `composetest_db`. If you change a service's `Dockerfile` or the contents of its build directory, you can run `docker-compose build` to rebuild it.
|
||||
Services are built once and then tagged as `project_service`, e.g.,`composetest_db`.
|
||||
If you change a service's `Dockerfile` or the contents of its build directory, you
|
||||
can run `docker-compose build` to rebuild it.
|
||||
|
||||
### help
|
||||
|
||||
|
|
@ -42,7 +47,8 @@ Get help on a command.
|
|||
|
||||
### kill
|
||||
|
||||
Force stop running containers by sending a `SIGKILL` signal. Optionally the signal can be passed, for example:
|
||||
Force stop running containers by sending a `SIGKILL` signal. Optionally the signal
|
||||
can be passed, for example:
|
||||
|
||||
$ docker-compose kill -s SIGINT
|
||||
|
||||
|
|
@ -77,17 +83,24 @@ For example:
|
|||
|
||||
By default, linked services will be started, unless they are already running.
|
||||
|
||||
One-off commands are started in new containers with the same configuration as a normal container for that service, so volumes, links, etc will all be created as expected. The only thing different to a normal container is the command will be overridden with the one specified and by default no ports will be created in case they collide.
|
||||
One-off commands are started in new containers with the same configuration as a
|
||||
normal container for that service, so volumes, links, etc will all be created as
|
||||
expected. The only thing different to a normal container is the command will be
|
||||
overridden with the one specified and by default no ports will be created in case
|
||||
they collide.
|
||||
|
||||
Links are also created between one-off commands and the other containers for that service so you can do stuff like this:
|
||||
Links are also created between one-off commands and the other containers for that
|
||||
service so you can do stuff like this:
|
||||
|
||||
$ docker-compose run db psql -h db -U docker
|
||||
|
||||
If you do not want linked containers to be started when running the one-off command, specify the `--no-deps` flag:
|
||||
If you do not want linked containers to be started when running the one-off command,
|
||||
specify the `--no-deps` flag:
|
||||
|
||||
$ docker-compose run --no-deps web python manage.py shell
|
||||
|
||||
If you want the service's ports to be created and mapped to the host, specify the `--service-ports` flag:
|
||||
If you want the service's ports to be created and mapped to the host, specify the
|
||||
`--service-ports` flag:
|
||||
$ docker-compose run --service-ports web python manage.py shell
|
||||
|
||||
### scale
|
||||
|
|
@ -105,7 +118,8 @@ Start existing containers for a service.
|
|||
|
||||
### stop
|
||||
|
||||
Stop running containers without removing them. They can be started again with `docker-compose start`.
|
||||
Stop running containers without removing them. They can be started again with
|
||||
`docker-compose start`.
|
||||
|
||||
### up
|
||||
|
||||
|
|
@ -113,9 +127,15 @@ Build, (re)create, start and attach to containers for a service.
|
|||
|
||||
Linked services will be started, unless they are already running.
|
||||
|
||||
By default, `docker-compose up` will aggregate the output of each container, and when it exits, all containers will be stopped. If you run `docker-compose up -d`, it'll start the containers in the background and leave them running.
|
||||
By default, `docker-compose up` will aggregate the output of each container, and when
|
||||
it exits, all containers will be stopped. If you run `docker-compose up -d`, it'll
|
||||
start the containers in the background and leave them running.
|
||||
|
||||
By default if there are existing containers for a service, `docker-compose up` will stop and recreate them (preserving mounted volumes with [volumes-from]), so that changes in `docker-compose.yml` are picked up. If you do no want containers to be stopped and recreated, use `docker-compose up --no-recreate`. This will still start any stopped containers, if needed.
|
||||
By default if there are existing containers for a service, `docker-compose up` will
|
||||
stop and recreate them (preserving mounted volumes with [volumes-from]), so that
|
||||
changes in `docker-compose.yml` are picked up. If you do not want containers to be
|
||||
stopped and recreated, use `docker-compose up --no-recreate`. This will still start
|
||||
any stopped containers, if needed.
|
||||
|
||||
[volumes-from]: http://docs.docker.io/en/latest/use/working_with_volumes/
|
||||
|
||||
|
|
@ -124,24 +144,31 @@ By default if there are existing containers for a service, `docker-compose up` w
|
|||
|
||||
Several environment variables can be used to configure Compose'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.
|
||||
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 Compose. Defaults to the `basename` of the current working directory.
|
||||
Set the project name, which is prepended to the name of every container started by
|
||||
Compose. Defaults to the `basename` of the current working directory.
|
||||
|
||||
### FIG\_FILE
|
||||
|
||||
Set the path to the `docker-compose.yml` to use. Defaults to `docker-compose.yml` in the current working directory.
|
||||
Set the path to the `docker-compose.yml` to use. Defaults to `docker-compose.yml`
|
||||
in the current working directory.
|
||||
|
||||
### DOCKER\_HOST
|
||||
|
||||
Set the URL to the docker daemon. Defaults to `unix:///var/run/docker.sock`, as with the docker client.
|
||||
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.
|
||||
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`.
|
||||
Configure the path to the `ca.pem`, `cert.pem` and `key.pem` files used for TLS
|
||||
verification. Defaults to `~/.docker`.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue