1berry/docker-compose
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

fix build

Browse Source 
Signed-off-by: aevesdocker <allie.sadler@docker.com>
This commit is contained in:
aevesdocker 2023-10-31 10:50:42 +00:00
parent 0d4cbbdbc9
commit 4cd61957ed
33 changed files with 85 additions and 86 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/reference/compose_alpha_publish.md
View File

@ -1,7 +1,7 @@
# docker compose alpha publish # docker compose alpha publish
<!---MARKER_GEN_START--> <!---MARKER_GEN_START-->
Publish a Compose application. Publish compose application
### Options ### Options

4
docs/reference/compose_alpha_viz.md
View File

@ -1,7 +1,7 @@
# docker compose alpha viz # docker compose alpha viz
<!---MARKER_GEN_START--> <!---MARKER_GEN_START-->
Generate a Graphviz graph from your compose file EXPERIMENTAL - Generate a graphviz graph from your compose file
### Options ### Options
@ -12,7 +12,7 @@ Generate a Graphviz graph from your compose file
| `--indentation-size` | `int` | `1` | Number of tabs or spaces to use for indentation | | `--indentation-size` | `int` | `1` | Number of tabs or spaces to use for indentation |
| `--networks` | | | Include service's attached networks in output graph | | `--networks` | | | Include service's attached networks in output graph |
| `--ports` | | | Include service's exposed ports in output graph | | `--ports` | | | Include service's exposed ports in output graph |
| `--spaces` | | | If given, space character ' ' is used to indent,<br>otherwise tab character '\t' is used | | `--spaces` | | | If given, space character ' ' will be used to indent,<br>otherwise tab character '\t' will be used |
<!---MARKER_GEN_END--> <!---MARKER_GEN_END-->

2
docs/reference/compose_build.md
View File

@ -1,7 +1,7 @@
# docker compose build # docker compose build
<!---MARKER_GEN_START--> <!---MARKER_GEN_START-->
Build or rebuild services. Build or rebuild services
### Options ### Options

2
docs/reference/compose_config.md
View File

@ -1,7 +1,7 @@
# docker compose convert # docker compose convert
<!---MARKER_GEN_START--> <!---MARKER_GEN_START-->
Parse, resolve and render Compose files in canonical format. Parse, resolve and render compose file in canonical format
### Aliases ### Aliases

2
docs/reference/compose_cp.md
View File

@ -1,7 +1,7 @@
# docker compose cp # docker compose cp
<!---MARKER_GEN_START--> <!---MARKER_GEN_START-->
Copy files or folders between a service container and the local filesystem. Copy files/folders between a service container and the local filesystem
### Options ### Options

4
docs/reference/compose_create.md
View File

@ -10,10 +10,10 @@ Creates containers for a service.
| `--build` | | | Build images before starting containers. | | `--build` | | | Build images before starting containers. |
| `--dry-run` | | | Execute command in dry run mode | | `--dry-run` | | | Execute command in dry run mode |
| `--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 policy | | `--no-build` | | | Don't build an image, even if it's policy. |
| `--no-recreate` | | | If containers already exist, don't recreate them. Incompatible with --force-recreate. | | `--no-recreate` | | | If containers already exist, don't recreate them. Incompatible with --force-recreate. |
| `--pull` | `string` | `policy` | Pull image before running ("always"\|"policy"\|"never") | | `--pull` | `string` | `policy` | Pull image before running ("always"\|"policy"\|"never") |
| `--remove-orphans` | | | Remove containers for services not defined in the Compose file | | `--remove-orphans` | | | Remove containers for services not defined in the Compose file. |
| `--scale` | `stringArray` | | Scale SERVICE to NUM instances. Overrides the `scale` setting in the Compose file if present. | | `--scale` | `stringArray` | | Scale SERVICE to NUM instances. Overrides the `scale` setting in the Compose file if present. |

4
docs/reference/compose_down.md
View File

@ -1,14 +1,14 @@
# docker compose down # docker compose down
<!---MARKER_GEN_START--> <!---MARKER_GEN_START-->
Stop and remove containers, networks, volumes, and images. Stop and remove containers, networks
### Options ### Options
| Name | Type | Default | Description | | Name | Type | Default | Description |
|:-------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------| |:-------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------|
| `--dry-run` | | | Execute command in dry run mode | | `--dry-run` | | | Execute command in dry run mode |
| `--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` | `0` | Specify a shutdown timeout in seconds | | `-t`, `--timeout` | `int` | `0` | Specify a shutdown timeout in seconds |
| `-v`, `--volumes` | | | Remove named volumes declared in the "volumes" section of the Compose file and anonymous volumes attached to containers. | | `-v`, `--volumes` | | | Remove named volumes declared in the "volumes" section of the Compose file and anonymous volumes attached to containers. |

8
docs/reference/compose_exec.md
View File

@ -7,14 +7,14 @@ Execute a command in a running container.
| 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. |
| `--dry-run` | | | Execute command in dry run mode | | `--dry-run` | | | Execute command in dry run mode |
| `-e`, `--env` | `stringArray` | | Set environment variables | | `-e`, `--env` | `stringArray` | | Set environment variables |
| `--index` | `int` | `0` | index of the container if service has multiple replicas | | `--index` | `int` | `0` | index of the container if service has multiple replicas |
| `-T`, `--no-TTY` | | | Disable pseudo-TTY allocation. By default `docker compose exec` allocates a TTY. | | `-T`, `--no-TTY` | | | Disable pseudo-TTY allocation. By default `docker compose exec` allocates a TTY. |
| `--privileged` | | | Give extended privileges to the process | | `--privileged` | | | Give extended privileges to the process. |
| `-u`, `--user` | `string` | | Run the command as this user | | `-u`, `--user` | `string` | | Run the command as this user. |
| `-w`, `--workdir` | `string` | | Path to workdir directory for this command | | `-w`, `--workdir` | `string` | | Path to workdir directory for this command. |
<!---MARKER_GEN_END--> <!---MARKER_GEN_END-->

2
docs/reference/compose_images.md
View File

@ -1,7 +1,7 @@
# docker compose images # docker compose images
<!---MARKER_GEN_START--> <!---MARKER_GEN_START-->
List images used by the created containers. List images used by the created containers
### Options ### Options

12
docs/reference/compose_logs.md
View File

@ -1,19 +1,19 @@
# docker compose logs # docker compose logs
<!---MARKER_GEN_START--> <!---MARKER_GEN_START-->
View output from containers. View output from containers
### Options ### Options
| Name | Type | Default | Description | | Name | Type | Default | Description |
|:---------------------|:---------|:--------|:-----------------------------------------------------------------------------------------------| |:---------------------|:---------|:--------|:-----------------------------------------------------------------------------------------------|
| `--dry-run` | | | Execute command in dry run mode | | `--dry-run` | | | Execute command in dry run mode |
| `-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. |
| `--since` | `string` | | Show logs since timestamp (e.g. 2013-01-02T13:23:37Z) or relative (e.g. 42m for 42 minutes) | | `--since` | `string` | | Show logs since timestamp (e.g. 2013-01-02T13:23:37Z) or relative (e.g. 42m for 42 minutes) |
| `-n`, `--tail` | `string` | `all` | Number of lines to show from the end of the logs for each container | | `-n`, `--tail` | `string` | `all` | Number of lines to show from the end of the logs for each container. |
| `-t`, `--timestamps` | | | Show timestamps | | `-t`, `--timestamps` | | | Show timestamps. |
| `--until` | `string` | | Show logs before a timestamp (e.g. 2013-01-02T13:23:37Z) or relative (e.g. 42m for 42 minutes) | | `--until` | `string` | | Show logs before a timestamp (e.g. 2013-01-02T13:23:37Z) or relative (e.g. 42m for 42 minutes) |

6
docs/reference/compose_ls.md
View File

@ -1,7 +1,7 @@
# docker compose ls # docker compose ls
<!---MARKER_GEN_START--> <!---MARKER_GEN_START-->
List running compose projects. List running compose projects
### Options ### Options
@ -9,9 +9,9 @@ List running compose projects.
|:----------------|:---------|:--------|:--------------------------------------------| |:----------------|:---------|:--------|:--------------------------------------------|
| `-a`, `--all` | | | Show all stopped Compose projects | | `-a`, `--all` | | | Show all stopped Compose projects |
| `--dry-run` | | | Execute command in dry run mode | | `--dry-run` | | | Execute command in dry run mode |
| `--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]. |
| `-q`, `--quiet` | | | Only display IDs | | `-q`, `--quiet` | | | Only display IDs. |
<!---MARKER_GEN_END--> <!---MARKER_GEN_END-->

2
docs/reference/compose_pause.md
View File

@ -1,7 +1,7 @@
# docker compose pause # docker compose pause
<!---MARKER_GEN_START--> <!---MARKER_GEN_START-->
Pause services. Pause services
### Options ### Options

2
docs/reference/compose_ps.md
View File

@ -1,7 +1,7 @@
# docker compose ps # docker compose ps
<!---MARKER_GEN_START--> <!---MARKER_GEN_START-->
List containers. List containers
### Options ### Options

12
docs/reference/compose_pull.md
View File

@ -1,18 +1,18 @@
# docker compose pull # docker compose pull
<!---MARKER_GEN_START--> <!---MARKER_GEN_START-->
Pull service images. Pull service images
### Options ### Options
| Name | Type | Default | Description | | Name | Type | Default | Description |
|:-------------------------|:---------|:--------|:--------------------------------------------------------| |:-------------------------|:---------|:--------|:--------------------------------------------------------|
| `--dry-run` | | | Execute command in dry run mode | | `--dry-run` | | | Execute command in dry run mode |
| `--ignore-buildable` | | | Ignore images that can be built | | `--ignore-buildable` | | | Ignore images that can be built. |
| `--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. |
| `--policy` | `string` | | Apply pull policy ("missing"\|"always") | | `--policy` | `string` | | Apply pull policy ("missing"\|"always"). |
| `-q`, `--quiet` | | | Pull without printing progress information | | `-q`, `--quiet` | | | Pull without printing progress information. |
<!---MARKER_GEN_END--> <!---MARKER_GEN_END-->

2
docs/reference/compose_push.md
View File

@ -1,7 +1,7 @@
# docker compose push # docker compose push
<!---MARKER_GEN_START--> <!---MARKER_GEN_START-->
Push service images. Push service images
### Options ### Options

4
docs/reference/compose_restart.md
View File

@ -1,14 +1,14 @@
# docker compose restart # docker compose restart
<!---MARKER_GEN_START--> <!---MARKER_GEN_START-->
Restart service containers. Restart service containers
### Options ### Options
| Name | Type | Default | Description | | Name | Type | Default | Description |
|:------------------|:------|:--------|:--------------------------------------| |:------------------|:------|:--------|:--------------------------------------|
| `--dry-run` | | | Execute command in dry run mode | | `--dry-run` | | | Execute command in dry run mode |
| `--no-deps` | | | Don't restart dependent services | | `--no-deps` | | | Don't restart dependent services. |
| `-t`, `--timeout` | `int` | `0` | Specify a shutdown timeout in seconds | | `-t`, `--timeout` | `int` | `0` | Specify a shutdown timeout in seconds |

2
docs/reference/compose_rm.md
View File

@ -1,7 +1,7 @@
# docker compose rm # docker compose rm
<!---MARKER_GEN_START--> <!---MARKER_GEN_START-->
Removes stopped service containers. Removes stopped service containers
By default, anonymous volumes attached to containers will not be removed. You By default, anonymous volumes attached to containers will not be removed. You
can override this with -v. To list all volumes, use "docker volume ls". can override this with -v. To list all volumes, use "docker volume ls".

14
docs/reference/compose_run.md
View File

@ -7,23 +7,23 @@ Run a one-off command on a service.
| Name | Type | Default | Description | | Name | Type | Default | Description |
|:----------------------|:--------------|:--------|:----------------------------------------------------------------------------------| |:----------------------|:--------------|:--------|:----------------------------------------------------------------------------------|
| `--build` | | | Build image before starting container | | `--build` | | | Build image before starting container. |
| `--cap-add` | `list` | | Add Linux capabilities | | `--cap-add` | `list` | | Add Linux capabilities |
| `--cap-drop` | `list` | | Drop Linux capabilities | | `--cap-drop` | `list` | | Drop Linux capabilities |
| `-d`, `--detach` | | | Run container in background and print container ID | | `-d`, `--detach` | | | Run container in background and print container ID |
| `--dry-run` | | | Execute command in dry run mode | | `--dry-run` | | | Execute command in dry run mode |
| `--entrypoint` | `string` | | Override the entrypoint of the image | | `--entrypoint` | `string` | | Override the entrypoint of the image |
| `-e`, `--env` | `stringArray` | | Set environment variables | | `-e`, `--env` | `stringArray` | | Set environment variables |
| `-i`, `--interactive` | | | Keep STDIN open even if not attached | | `-i`, `--interactive` | | | Keep STDIN open even if not attached. |
| `-l`, `--label` | `stringArray` | | Add or override a label | | `-l`, `--label` | `stringArray` | | Add or override a label |
| `--name` | `string` | | Assign a name to the container | | `--name` | `string` | | Assign a name to the container |
| `-T`, `--no-TTY` | | | Disable pseudo-TTY allocation (default: auto-detected). | | `-T`, `--no-TTY` | | | Disable pseudo-TTY allocation (default: auto-detected). |
| `--no-deps` | | | Don't start linked services | | `--no-deps` | | | Don't start linked services. |
| `-p`, `--publish` | `stringArray` | | Publish a container's port(s) to the host | | `-p`, `--publish` | `stringArray` | | Publish a container's port(s) to the host. |
| `--quiet-pull` | | | Pull without printing progress information | | `--quiet-pull` | | | Pull without printing progress information. |
| `--remove-orphans` | | | Remove containers for services not defined in the Compose file | | `--remove-orphans` | | | Remove containers for services not defined in the Compose file. |
| `--rm` | | | Automatically remove the container when it exits | | `--rm` | | | Automatically remove the container when it exits |
| `--service-ports` | | | Run command with the service's ports enabled and mapped to the host | | `--service-ports` | | | Run command with the service's ports enabled and mapped to the host. |
| `--use-aliases` | | | Use the service's network useAliases in the network(s) the container connects to. | | `--use-aliases` | | | Use the service's network useAliases in the network(s) the container connects to. |
| `-u`, `--user` | `string` | | Run as specified username or uid | | `-u`, `--user` | `string` | | Run as specified username or uid |
| `-v`, `--volume` | `stringArray` | | Bind mount a volume. | | `-v`, `--volume` | `stringArray` | | Bind mount a volume. |

4
docs/reference/compose_scale.md
View File

@ -1,14 +1,14 @@
# docker compose scale # docker compose scale
<!---MARKER_GEN_START--> <!---MARKER_GEN_START-->
Scale services. Scale services
### Options ### Options
| Name | Type | Default | Description | | Name | Type | Default | Description |
|:------------|:-----|:--------|:--------------------------------| |:------------|:-----|:--------|:--------------------------------|
| `--dry-run` | | | Execute command in dry run mode | | `--dry-run` | | | Execute command in dry run mode |
| `--no-deps` | | | Don't start linked services | | `--no-deps` | | | Don't start linked services. |
<!---MARKER_GEN_END--> <!---MARKER_GEN_END-->

2
docs/reference/compose_start.md
View File

@ -1,7 +1,7 @@
# docker compose start # docker compose start
<!---MARKER_GEN_START--> <!---MARKER_GEN_START-->
Start services. Start services
### Options ### Options

2
docs/reference/compose_stop.md
View File

@ -1,7 +1,7 @@
# docker compose stop # docker compose stop
<!---MARKER_GEN_START--> <!---MARKER_GEN_START-->
Stop services. Stop services
### Options ### Options

2
docs/reference/compose_top.md
View File

@ -1,7 +1,7 @@
# docker compose top # docker compose top
<!---MARKER_GEN_START--> <!---MARKER_GEN_START-->
Display the running processes. Display the running processes
### Options ### Options

2
docs/reference/compose_unpause.md
View File

@ -1,7 +1,7 @@
# docker compose unpause # docker compose unpause
<!---MARKER_GEN_START--> <!---MARKER_GEN_START-->
Unpause services. Unpause services
### Options ### Options

30
docs/reference/compose_up.md
View File

@ -1,7 +1,7 @@
# docker compose up # docker compose up
<!---MARKER_GEN_START--> <!---MARKER_GEN_START-->
Create and start containers. Create and start containers
### Options ### Options
@ -10,28 +10,28 @@ Create and start containers.
| `--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` | | Restrict attaching to the specified services. Incompatible with --attach-dependencies. | | `--attach` | `stringArray` | | Restrict attaching to the specified services. Incompatible with --attach-dependencies. |
| `--attach-dependencies` | | | Automatically attach to log output of dependent services | | `--attach-dependencies` | | | Automatically attach to log output of dependent services. |
| `--build` | | | Build images before starting containers | | `--build` | | | Build images before starting containers. |
| `-d`, `--detach` | | | Detached mode: Run containers in the background | | `-d`, `--detach` | | | Detached mode: Run containers in the background |
| `--dry-run` | | | Execute command in dry run mode | | `--dry-run` | | | Execute command in dry run mode |
| `--exit-code-from` | `string` | | Return the exit code of the selected service container. Implies --abort-on-container-exit. | | `--exit-code-from` | `string` | | Return the exit code of the selected service container. Implies --abort-on-container-exit |
| `--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-attach` | `stringArray` | | Do not attach (stream logs) to the specified services | | `--no-attach` | `stringArray` | | Do not attach (stream logs) to the specified services. |
| `--no-build` | | | Don't build an image, even if it's policy | | `--no-build` | | | Don't build an image, even if it's policy. |
| `--no-color` | | | Produce monochrome output. | | `--no-color` | | | Produce monochrome output. |
| `--no-deps` | | | Don't start linked services | | `--no-deps` | | | Don't start linked services. |
| `--no-log-prefix` | | | Don't print prefix in logs. | | `--no-log-prefix` | | | Don't print prefix in logs. |
| `--no-recreate` | | | If containers already exist, don't recreate them. Incompatible with --force-recreate. | | `--no-recreate` | | | If containers already exist, don't recreate them. Incompatible with --force-recreate. |
| `--no-start` | | | Don't start the services after creating them | | `--no-start` | | | Don't start the services after creating them. |
| `--pull` | `string` | `policy` | Pull image before running ("always"\|"policy"\|"never") | | `--pull` | `string` | `policy` | Pull image before running ("always"\|"policy"\|"never") |
| `--quiet-pull` | | | Pull without printing progress information | | `--quiet-pull` | | | Pull without printing progress information. |
| `--remove-orphans` | | | Remove containers for services not defined in the Compose file | | `--remove-orphans` | | | Remove containers for services not defined in the Compose file. |
| `-V`, `--renew-anon-volumes` | | | Recreate anonymous volumes instead of retrieving data from the previous containers | | `-V`, `--renew-anon-volumes` | | | Recreate anonymous volumes instead of retrieving data from the previous containers. |
| `--scale` | `stringArray` | | Scale SERVICE to NUM instances. Overrides the `scale` setting in the Compose file if present. | | `--scale` | `stringArray` | | Scale SERVICE to NUM instances. Overrides the `scale` setting in the Compose file if present. |
| `-t`, `--timeout` | `int` | `0` | Use this timeout in seconds for container shutdown when attached or when containers are already running | | `-t`, `--timeout` | `int` | `0` | Use this timeout in seconds for container shutdown when attached or when containers are already running. |
| `--timestamps` | | | Show timestamps | | `--timestamps` | | | Show timestamps. |
| `--wait` | | | Wait for services to be running\|healthy. Implies detached mode. | | `--wait` | | | Wait for services to be running\|healthy. Implies detached mode. |
| `--wait-timeout` | `int` | `0` | Maximum duration to wait for the project to be running\|healthy | | `--wait-timeout` | `int` | `0` | Maximum duration to wait for the project to be running\|healthy. |
<!---MARKER_GEN_END--> <!---MARKER_GEN_END-->

4
docs/reference/compose_version.md
View File

@ -1,7 +1,7 @@
# docker compose version # docker compose version
<!---MARKER_GEN_START--> <!---MARKER_GEN_START-->
Show the Docker Compose version information. Show the Docker Compose version information
### Options ### Options
@ -9,7 +9,7 @@ Show the Docker Compose version information.
|:-----------------|:---------|:--------|:---------------------------------------------------------------| |:-----------------|:---------|:--------|:---------------------------------------------------------------|
| `--dry-run` | | | Execute command in dry run mode | | `--dry-run` | | | Execute command in dry run mode |
| `-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. |
<!---MARKER_GEN_END--> <!---MARKER_GEN_END-->

2
docs/reference/compose_wait.md
View File

@ -1,7 +1,7 @@
# docker compose wait # docker compose wait
<!---MARKER_GEN_START--> <!---MARKER_GEN_START-->
Block until the first service container stops. Block until the first service container stops
### Options ### Options

4
docs/reference/compose_watch.md
View File

@ -1,7 +1,7 @@
# docker compose watch # docker compose watch
<!---MARKER_GEN_START--> <!---MARKER_GEN_START-->
Watch build context for service and rebuild or refresh containers when files are updated. Watch build context for service and rebuild/refresh containers when files are updated
### Options ### Options
@ -9,7 +9,7 @@ Watch build context for service and rebuild or refresh containers when files are
|:------------|:-----|:--------|:----------------------------------------------| |:------------|:-----|:--------|:----------------------------------------------|
| `--dry-run` | | | Execute command in dry run mode | | `--dry-run` | | | Execute command in dry run mode |
| `--no-up` | | | Do not build & start services before watching | | `--no-up` | | | Do not build & start services before watching |
| `--quiet` | | | Hide build output | | `--quiet` | | | hide build output |
<!---MARKER_GEN_END--> <!---MARKER_GEN_END-->

10
docs/reference/docker_compose.yaml
View File

@ -1,7 +1,7 @@
command: docker compose command: docker compose
short: Docker Compose short: Docker Compose
long: |- long: |-
You can use compose subcommand, `docker compose [-f <arg>...] [options] [COMMAND] [ARGS...]`, to build and manage You can use the compose subcommand, `docker compose [-f <arg>...] [options] [COMMAND] [ARGS...]`, to build and manage
multiple services in Docker containers. multiple services in Docker containers.
### Use `-f` to specify the name and path of one or more Compose files ### Use `-f` to specify the name and path of one or more Compose files
@ -90,16 +90,16 @@ long: |-
### Use profiles to enable optional services ### Use profiles to enable optional services
Use `--profile` to specify one or more active profiles Use `--profile` to specify one or more active profiles
Calling `docker compose --profile frontend up` will start the services with the profile `frontend` and services Calling `docker compose --profile frontend up` starts the services with the profile `frontend` and services
without any specified profiles. without any specified profiles.
You can also enable multiple profiles, e.g. with `docker compose --profile frontend --profile debug up` the profiles `frontend` and `debug` will be enabled. You can also enable multiple profiles, e.g. with `docker compose --profile frontend --profile debug up` the profiles `frontend` and `debug` is enabled.
Profiles can also be set by `COMPOSE_PROFILES` environment variable. Profiles can also be set by `COMPOSE_PROFILES` environment variable.
### Configuring parallelism ### Configuring parallelism
Use `--parallel` to specify the maximum level of parallelism for concurrent engine calls. Use `--parallel` to specify the maximum level of parallelism for concurrent engine calls.
Calling `docker compose --parallel 1 pull` will pull the pullable images defined in the Compose file Calling `docker compose --parallel 1 pull` pulls the pullable images defined in the Compose file
one at a time. This can also be used to control build concurrency. one at a time. This can also be used to control build concurrency.
Parallelism can also be set by the `COMPOSE_PARALLEL_LIMIT` environment variable. Parallelism can also be set by the `COMPOSE_PARALLEL_LIMIT` environment variable.
@ -115,7 +115,7 @@ long: |-
If flags are explicitly set on the command line, the associated environment variable is ignored. If flags are explicitly set on the command line, the associated environment variable is ignored.
Setting the `COMPOSE_IGNORE_ORPHANS` environment variable to `true` will stop docker compose from detecting orphaned Setting the `COMPOSE_IGNORE_ORPHANS` environment variable to `true` stops docker compose from detecting orphaned
containers for the project. containers for the project.
### Use Dry Run mode to test your command ### Use Dry Run mode to test your command

4
docs/reference/docker_compose_config.yaml
View File

@ -2,8 +2,8 @@ command: docker compose config
aliases: docker compose config, docker compose convert aliases: docker compose config, docker compose convert
short: Parse, resolve and render compose file in canonical format short: Parse, resolve and render compose file in canonical format
long: |- long: |-
`docker compose config` renders the actual data model to be applied on the Docker engine. `docker compose config` renders the actual data model to be applied on the Docker Engine.
it merges the Compose files set by `-f` flags, resolves variables in the Compose file, and expands short-notation into It merges the Compose files set by `-f` flags, resolves variables in the Compose file, and expands short-notation into
the canonical format. the canonical format.
usage: docker compose config [OPTIONS] [SERVICE...] usage: docker compose config [OPTIONS] [SERVICE...]
pname: docker compose pname: docker compose

8
docs/reference/docker_compose_down.yaml
View File

@ -5,13 +5,13 @@ long: |-
By default, the only things removed are: By default, the only things removed are:
- Containers for services defined in the Compose file - Containers for services defined in the Compose file.
- Networks defined in the networks section of the Compose file - Networks defined in the networks section of the Compose file.
- The default network, if one is used - The default network, if one is used.
Networks and volumes defined as external are never removed. Networks and volumes defined as external are never removed.
Anonymous volumes are not removed by default. However, as they don’t have a stable name, they will not be automatically Anonymous volumes are not removed by default. However, as they don’t have a stable name, they are not automatically
mounted by a subsequent `up`. For data that needs to persist between updates, use explicit paths as bind mounts or mounted by a subsequent `up`. For data that needs to persist between updates, use explicit paths as bind mounts or
named volumes. named volumes.
usage: docker compose down [OPTIONS] [SERVICES] usage: docker compose down [OPTIONS] [SERVICES]

4
docs/reference/docker_compose_ps.yaml
View File

@ -9,7 +9,7 @@ long: |-
example-foo-1 alpine "/entrypoint.…" foo 4 seconds ago Up 2 seconds 0.0.0.0:8080->80/tcp example-foo-1 alpine "/entrypoint.…" foo 4 seconds ago Up 2 seconds 0.0.0.0:8080->80/tcp
``` ```
By default, only running containers are shown. `--all` flag can be used to include stopped containers By default, only running containers are shown. `--all` flag can be used to include stopped containers.
```console ```console
$ docker compose ps --all $ docker compose ps --all
@ -128,7 +128,7 @@ examples: |-
``` ```
The JSON output allows you to use the information in other tools for further The JSON output allows you to use the information in other tools for further
processing, for example, using the [`jq` utility](https://stedolan.github.io/jq/){:target="_blank" rel="noopener" class="_"} processing, for example, using the [`jq` utility](https://stedolan.github.io/jq/)
to pretty-print the JSON: to pretty-print the JSON:
```console ```console

5
docs/reference/docker_compose_pull.yaml
View File

@ -89,7 +89,7 @@ inherited_options:
kubernetes: false kubernetes: false
swarm: false swarm: false
examples: |- examples: |-
suppose you have this `compose.yaml`: Consider the following `compose.yaml`:
```yaml ```yaml
services: services:
@ -130,8 +130,7 @@ examples: |-
⠹ c8752d5b785c Waiting 9.3s ⠹ c8752d5b785c Waiting 9.3s
``` ```
`docker compose pull` will try to pull image for services with a build section. If pull fails, it will let `docker compose pull` tries to pull image for services with a build section. If pull fails, it lets you know this service image must be built. You can skip this by setting `--ignore-buildable` flag.
user know this service image MUST be built. You can skip this by setting `--ignore-buildable` flag
deprecated: false deprecated: false
hidden: false hidden: false
experimental: false experimental: false

2
docs/reference/docker_compose_restart.yaml
View File

@ -8,7 +8,7 @@ long: |-
after a container is built, but before the container's command is executed) are not updated after a container is built, but before the container's command is executed) are not updated
after restarting. after restarting.
If you are looking to configure a service's restart policy, please refer to If you are looking to configure a service's restart policy, refer to
[restart](https://github.com/compose-spec/compose-spec/blob/master/spec.md#restart) [restart](https://github.com/compose-spec/compose-spec/blob/master/spec.md#restart)
or [restart_policy](https://github.com/compose-spec/compose-spec/blob/master/deploy.md#restart_policy). or [restart_policy](https://github.com/compose-spec/compose-spec/blob/master/deploy.md#restart_policy).
usage: docker compose restart [OPTIONS] [SERVICE...] usage: docker compose restart [OPTIONS] [SERVICE...]