tyler.durden
/
compose
mirror of https://github.com/docker/compose.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update documentation 

Signed-off-by: Laura Brehm <laurabrehm@hey.com>
This commit is contained in:
Laura Brehm 2022-12-29 13:32:16 +00:00
parent 52e7f0fb3e
commit 8a3248d0cd
No known key found for this signature in database
GPG Key ID: 526E3FC49260D47A
22 changed files with 192 additions and 193 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/reference/compose.md
View File

@ -6,7 +6,7 @@ Docker Compose
### Subcommands ### Subcommands
| Name | Description | | Name | Description |
| --- | --- | |:--------------------------------|:------------------------------------------------------------------------|
| [`build`](compose_build.md) | Build or rebuild services | | [`build`](compose_build.md) | Build or rebuild services |
| [`convert`](compose_convert.md) | Converts the compose file to platform's canonical format | | [`convert`](compose_convert.md) | Converts the compose file to platform's canonical format |
| [`cp`](compose_cp.md) | Copy files/folders between a service container and the local filesystem | | [`cp`](compose_cp.md) | Copy files/folders between a service container and the local filesystem |
@ -37,15 +37,14 @@ Docker Compose
### Options ### Options
| Name | Type | Default | Description | | Name | Type | Default | Description |
| --- | --- | --- | --- | |:-----------------------|:--------------|:--------|:----------------------------------------------------------------------------------------------------|
| `--ansi` | `string` | `auto` | Control when to print ANSI control characters ("never"\|"always"\|"auto") | | `--ansi` | `string` | `auto` | Control when to print ANSI control characters ("never"\|"always"\|"auto") |
| `--compatibility` | | | Run compose in backward compatibility mode | | `--compatibility` | | | Run compose in backward compatibility mode |
| `--env-file` | `string` | | Specify an alternate environment file. | | `--env-file` | `string` | | Specify an alternate environment file. |
| `-f`, `--file` | `stringArray` | | Compose configuration files | | `-f`, `--file` | `stringArray` | | Compose configuration files |
| `--parallel` | `int` | `-1` | Control max parallelism, -1 for unlimited | | `--parallel` | `int` | `-1` | Control max parallelism, -1 for unlimited |
| `--profile` | `stringArray` | | Specify a profile to enable | | `--profile` | `stringArray` | | Specify a profile to enable |
| `--project-directory` | `string` | | Specify an alternate working directory | `--project-directory` | `string` | | Specify an alternate working directory<br>(default: the path of the, first specified, Compose file) |
(default: the path of the, first specified, Compose file) |
| `-p`, `--project-name` | `string` | | Project name | | `-p`, `--project-name` | `string` | | Project name |

2
docs/reference/compose_build.md
View File

@ -6,7 +6,7 @@ Build or rebuild services
### Options ### Options
| Name | Type | Default | Description | | Name | Type | Default | Description |
| --- | --- | --- | --- | |:----------------|:--------------|:--------|:------------------------------------------------------------------------------------------------------------|
| `--build-arg` | `stringArray` | | Set build-time variables for services. | | `--build-arg` | `stringArray` | | Set build-time variables for services. |
| `--no-cache` | | | Do not use cache when building the image | | `--no-cache` | | | Do not use cache when building the image |
| `--progress` | `string` | `auto` | Set type of progress output (auto, tty, plain, quiet) | | `--progress` | `string` | `auto` | Set type of progress output (auto, tty, plain, quiet) |

2
docs/reference/compose_convert.md
View File

@ -10,7 +10,7 @@ Converts the compose file to platform's canonical format
### Options ### Options
| Name | Type | Default | Description | | Name | Type | Default | Description |
| --- | --- | --- | --- | |:--------------------------|:---------|:--------|:----------------------------------------------------------------------------|
| `--format` | `string` | `yaml` | Format the output. Values: [yaml \| json] | | `--format` | `string` | `yaml` | Format the output. Values: [yaml \| json] |
| `--hash` | `string` | | Print the service config hash, one per line. | | `--hash` | `string` | | Print the service config hash, one per line. |
| `--images` | | | Print the image names, one per line. | | `--images` | | | Print the image names, one per line. |

2
docs/reference/compose_cp.md
View File

@ -6,7 +6,7 @@ Copy files/folders between a service container and the local filesystem
### Options ### Options
| Name | Type | Default | Description | | Name | Type | Default | Description |
| --- | --- | --- | --- | |:----------------------|:------|:--------|:----------------------------------------------------------------------|
| `-a`, `--archive` | | | Archive mode (copy all uid/gid information) | | `-a`, `--archive` | | | Archive mode (copy all uid/gid information) |
| `-L`, `--follow-link` | | | Always follow symbol link in SRC_PATH | | `-L`, `--follow-link` | | | Always follow symbol link in SRC_PATH |
| `--index` | `int` | `0` | Index of the container if there are multiple instances of a service . | | `--index` | `int` | `0` | Index of the container if there are multiple instances of a service . |

2
docs/reference/compose_create.md
View File

@ -6,7 +6,7 @@ Creates containers for a service.
### Options ### Options
| Name | Type | Default | Description | | Name | Type | Default | Description |
| --- | --- | --- | --- | |:-------------------|:---------|:----------|:--------------------------------------------------------------------------------------|
| `--build` | | | Build images before starting containers. | | `--build` | | | Build images before starting containers. |
| `--force-recreate` | | | Recreate containers even if their configuration and image haven't changed. | | `--force-recreate` | | | Recreate containers even if their configuration and image haven't changed. |
| `--no-build` | | | Don't build an image, even if it's missing. | | `--no-build` | | | Don't build an image, even if it's missing. |

2
docs/reference/compose_down.md
View File

@ -6,7 +6,7 @@ Stop and remove containers, networks
### Options ### Options
| Name | Type | Default | Description | | Name | Type | Default | Description |
| --- | --- | --- | --- | |:-------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------|
| `--remove-orphans` | | | Remove containers for services not defined in the Compose file. | | `--remove-orphans` | | | Remove containers for services not defined in the Compose file. |
| `--rmi` | `string` | | Remove images used by services. "local" remove only images that don't have a custom tag ("local"\|"all") | | `--rmi` | `string` | | Remove images used by services. "local" remove only images that don't have a custom tag ("local"\|"all") |
| `-t`, `--timeout` | `int` | `10` | Specify a shutdown timeout in seconds | | `-t`, `--timeout` | `int` | `10` | Specify a shutdown timeout in seconds |

2
docs/reference/compose_events.md
View File

@ -6,7 +6,7 @@ Receive real time events from containers.
### Options ### Options
| Name | Type | Default | Description | | Name | Type | Default | Description |
| --- | --- | --- | --- | |:---------|:-----|:--------|:------------------------------------------|
| `--json` | | | Output events as a stream of json objects | | `--json` | | | Output events as a stream of json objects |

2
docs/reference/compose_exec.md
View File

@ -6,7 +6,7 @@ Execute a command in a running container.
### Options ### Options
| Name | Type | Default | Description | | Name | Type | Default | Description |
| --- | --- | --- | --- | |:------------------|:--------------|:--------|:----------------------------------------------------------------------------------|
| `-d`, `--detach` | | | Detached mode: Run command in the background. | | `-d`, `--detach` | | | Detached mode: Run command in the background. |
| `-e`, `--env` | `stringArray` | | Set environment variables | | `-e`, `--env` | `stringArray` | | Set environment variables |
| `--index` | `int` | `1` | index of the container if there are multiple instances of a service [default: 1]. | | `--index` | `int` | `1` | index of the container if there are multiple instances of a service [default: 1]. |

2
docs/reference/compose_images.md
View File

@ -6,7 +6,7 @@ List images used by the created containers
### Options ### Options
| Name | Type | Default | Description | | Name | Type | Default | Description |
| --- | --- | --- | --- | |:----------------|:---------|:--------|:--------------------------------------------|
| `--format` | `string` | `table` | Format the output. Values: [table \| json]. | | `--format` | `string` | `table` | Format the output. Values: [table \| json]. |
| `-q`, `--quiet` | | | Only display IDs | | `-q`, `--quiet` | | | Only display IDs |

2
docs/reference/compose_kill.md
View File

@ -6,7 +6,7 @@ Force stop service containers.
### Options ### Options
| Name | Type | Default | Description | | Name | Type | Default | Description |
| --- | --- | --- | --- | |:-------------------|:---------|:----------|:----------------------------------------------------------------|
| `--remove-orphans` | | | Remove containers for services not defined in the Compose file. | | `--remove-orphans` | | | Remove containers for services not defined in the Compose file. |
| `-s`, `--signal` | `string` | `SIGKILL` | SIGNAL to send to the container. | | `-s`, `--signal` | `string` | `SIGKILL` | SIGNAL to send to the container. |

2
docs/reference/compose_logs.md
View File

@ -6,7 +6,7 @@ View output from containers
### Options ### Options
| Name | Type | Default | Description | | Name | Type | Default | Description |
| --- | --- | --- | --- | |:---------------------|:---------|:--------|:-----------------------------------------------------------------------------------------------|
| `-f`, `--follow` | | | Follow log output. | | `-f`, `--follow` | | | Follow log output. |
| `--no-color` | | | Produce monochrome output. | | `--no-color` | | | Produce monochrome output. |
| `--no-log-prefix` | | | Don't print prefix in logs. | | `--no-log-prefix` | | | Don't print prefix in logs. |

2
docs/reference/compose_ls.md
View File

@ -6,7 +6,7 @@ List running compose projects
### Options ### Options
| Name | Type | Default | Description | | Name | Type | Default | Description |
| --- | --- | --- | --- | |:----------------|:---------|:--------|:--------------------------------------------|
| `-a`, `--all` | | | Show all stopped Compose projects | | `-a`, `--all` | | | Show all stopped Compose projects |
| `--filter` | `filter` | | Filter output based on conditions provided. | | `--filter` | `filter` | | Filter output based on conditions provided. |
| `--format` | `string` | `table` | Format the output. Values: [table \| json]. | | `--format` | `string` | `table` | Format the output. Values: [table \| json]. |

2
docs/reference/compose_port.md
View File

@ -6,7 +6,7 @@ Print the public port for a port binding.
### Options ### Options
| Name | Type | Default | Description | | Name | Type | Default | Description |
| --- | --- | --- | --- | |:-------------|:---------|:--------|:--------------------------------------------------------|
| `--index` | `int` | `1` | index of the container if service has multiple replicas | | `--index` | `int` | `1` | index of the container if service has multiple replicas |
| `--protocol` | `string` | `tcp` | tcp or udp | | `--protocol` | `string` | `tcp` | tcp or udp |

2
docs/reference/compose_ps.md
View File

@ -6,7 +6,7 @@ List containers
### Options ### Options
| Name | Type | Default | Description | | Name | Type | Default | Description |
| --- | --- | --- | --- | |:----------------------|:--------------|:--------|:--------------------------------------------------------------------------------------------------------------|
| `-a`, `--all` | | | Show all stopped containers (including those created by the run command) | | `-a`, `--all` | | | Show all stopped containers (including those created by the run command) |
| [`--filter`](#filter) | `string` | | Filter services by a property (supported filters: status). | | [`--filter`](#filter) | `string` | | Filter services by a property (supported filters: status). |
| [`--format`](#format) | `string` | `table` | Format the output. Values: [table \| json] | | [`--format`](#format) | `string` | `table` | Format the output. Values: [table \| json] |

2
docs/reference/compose_pull.md
View File

@ -6,7 +6,7 @@ Pull service images
### Options ### Options
| Name | Type | Default | Description | | Name | Type | Default | Description |
| --- | --- | --- | --- | |:-------------------------|:-----|:--------|:-------------------------------------------------------|
| `--ignore-pull-failures` | | | Pull what it can and ignores images with pull failures | | `--ignore-pull-failures` | | | Pull what it can and ignores images with pull failures |
| `--include-deps` | | | Also pull services declared as dependencies | | `--include-deps` | | | Also pull services declared as dependencies |
| `-q`, `--quiet` | | | Pull without printing progress information | | `-q`, `--quiet` | | | Pull without printing progress information |

2
docs/reference/compose_push.md
View File

@ -6,7 +6,7 @@ Push service images
### Options ### Options
| Name | Type | Default | Description | | Name | Type | Default | Description |
| --- | --- | --- | --- | |:-------------------------|:-----|:--------|:-------------------------------------------------------|
| `--ignore-push-failures` | | | Push what it can and ignores images with push failures | | `--ignore-push-failures` | | | Push what it can and ignores images with push failures |
| `--include-deps` | | | Also push images of services declared as dependencies | | `--include-deps` | | | Also push images of services declared as dependencies |
| `-q`, `--quiet` | | | Push without printing progress information | | `-q`, `--quiet` | | | Push without printing progress information |

2
docs/reference/compose_restart.md
View File

@ -6,7 +6,7 @@ Restart service containers
### Options ### Options
| Name | Type | Default | Description | | Name | Type | Default | Description |
| --- | --- | --- | --- | |:------------------|:------|:--------|:--------------------------------------|
| `-t`, `--timeout` | `int` | `10` | Specify a shutdown timeout in seconds | | `-t`, `--timeout` | `int` | `10` | Specify a shutdown timeout in seconds |

2
docs/reference/compose_rm.md
View File

@ -11,7 +11,7 @@ Any data which is not in a volume will be lost.
### Options ### Options
| Name | Type | Default | Description | | Name | Type | Default | Description |
| --- | --- | --- | --- | |:------------------|:-----|:--------|:----------------------------------------------------|
| `-f`, `--force` | | | Don't ask to confirm removal | | `-f`, `--force` | | | Don't ask to confirm removal |
| `-s`, `--stop` | | | Stop the containers, if required, before removing | | `-s`, `--stop` | | | Stop the containers, if required, before removing |
| `-v`, `--volumes` | | | Remove any anonymous volumes attached to containers | | `-v`, `--volumes` | | | Remove any anonymous volumes attached to containers |

2
docs/reference/compose_run.md
View File

@ -6,7 +6,7 @@ Run a one-off command on a service.
### Options ### Options
| Name | Type | Default | Description | | Name | Type | Default | Description |
| --- | --- | --- | --- | |:----------------------|:--------------|:--------|:----------------------------------------------------------------------------------|
| `--build` | | | Build image before starting container. | | `--build` | | | Build image before starting container. |
| `-d`, `--detach` | | | Run container in background and print container ID | | `-d`, `--detach` | | | Run container in background and print container ID |
| `--entrypoint` | `string` | | Override the entrypoint of the image | | `--entrypoint` | `string` | | Override the entrypoint of the image |

2
docs/reference/compose_stop.md
View File

@ -6,7 +6,7 @@ Stop services
### Options ### Options
| Name | Type | Default | Description | | Name | Type | Default | Description |
| --- | --- | --- | --- | |:------------------|:------|:--------|:--------------------------------------|
| `-t`, `--timeout` | `int` | `10` | Specify a shutdown timeout in seconds | | `-t`, `--timeout` | `int` | `10` | Specify a shutdown timeout in seconds |

2
docs/reference/compose_up.md
View File

@ -6,7 +6,7 @@ Create and start containers
### Options ### Options
| Name | Type | Default | Description | | Name | Type | Default | Description |
| --- | --- | --- | --- | |:-----------------------------|:--------------|:----------|:---------------------------------------------------------------------------------------------------------|
| `--abort-on-container-exit` | | | Stops all containers if any container was stopped. Incompatible with -d | | `--abort-on-container-exit` | | | Stops all containers if any container was stopped. Incompatible with -d |
| `--always-recreate-deps` | | | Recreate dependent containers. Incompatible with --no-recreate. | | `--always-recreate-deps` | | | Recreate dependent containers. Incompatible with --no-recreate. |
| `--attach` | `stringArray` | | Attach to service output. | | `--attach` | `stringArray` | | Attach to service output. |

2
docs/reference/compose_version.md
View File

@ -6,7 +6,7 @@ Show the Docker Compose version information
### Options ### Options
| Name | Type | Default | Description | | Name | Type | Default | Description |
| --- | --- | --- | --- | |:-----------------|:---------|:--------|:---------------------------------------------------------------|
| `-f`, `--format` | `string` | | Format the output. Values: [pretty \| json]. (Default: pretty) | | `-f`, `--format` | `string` | | Format the output. Values: [pretty \| json]. (Default: pretty) |
| `--short` | | | Shows only Compose's version number. | | `--short` | | | Shows only Compose's version number. |