2022-03-09 12:57:07 +01:00
|
|
|
|
# docker compose up
|
|
|
|
|
|
|
|
|
|
|
|
<!---MARKER_GEN_START-->
|
|
|
|
|
|
Create and start containers
|
|
|
|
|
|
|
|
|
|
|
|
### Options
|
|
|
|
|
|
|
2022-12-29 14:32:16 +01:00
|
|
|
|
| Name | Type | Default | Description |
|
|
|
|
|
|
|:-----------------------------|:--------------|:----------|:---------------------------------------------------------------------------------------------------------|
|
|
|
|
|
|
| `--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. |
|
|
|
|
|
|
| `--attach` | `stringArray` | | Attach to service output. |
|
|
|
|
|
|
| `--attach-dependencies` | | | Attach to dependent containers. |
|
|
|
|
|
|
| `--build` | | | Build images before starting containers. |
|
|
|
|
|
|
| `-d`, `--detach` | | | Detached mode: Run containers in the background |
|
|
|
|
|
|
| `--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. |
|
2023-01-03 15:35:24 +01:00
|
|
|
|
| `--no-attach` | `stringArray` | | Don't attach to specified service. |
|
2022-12-29 14:32:16 +01:00
|
|
|
|
| `--no-build` | | | Don't build an image, even if it's missing. |
|
|
|
|
|
|
| `--no-color` | | | Produce monochrome output. |
|
|
|
|
|
|
| `--no-deps` | | | Don't start linked services. |
|
|
|
|
|
|
| `--no-log-prefix` | | | Don't print prefix in logs. |
|
|
|
|
|
|
| `--no-recreate` | | | If containers already exist, don't recreate them. Incompatible with --force-recreate. |
|
|
|
|
|
|
| `--no-start` | | | Don't start the services after creating them. |
|
|
|
|
|
|
| `--pull` | `string` | `missing` | Pull image before running ("always"\|"missing"\|"never") |
|
|
|
|
|
|
| `--quiet-pull` | | | Pull without printing progress information. |
|
|
|
|
|
|
| `--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. |
|
|
|
|
|
|
| `--scale` | `stringArray` | | Scale SERVICE to NUM instances. Overrides the `scale` setting in the Compose file if present. |
|
|
|
|
|
|
| `-t`, `--timeout` | `int` | `10` | Use this timeout in seconds for container shutdown when attached or when containers are already running. |
|
|
|
|
|
|
| `--timestamps` | | | Show timestamps. |
|
|
|
|
|
|
| `--wait` | | | Wait for services to be running\|healthy. Implies detached mode. |
|
2022-03-09 12:57:07 +01:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!---MARKER_GEN_END-->
|
2021-03-11 16:20:30 +01:00
|
|
|
|
|
|
|
|
|
|
## Description
|
|
|
|
|
|
|
|
|
|
|
|
Builds, (re)creates, starts, and attaches to containers for a service.
|
|
|
|
|
|
|
|
|
|
|
|
Unless they are already running, this command also starts any linked services.
|
|
|
|
|
|
|
2022-03-09 13:24:09 +01:00
|
|
|
|
The `docker compose up` command aggregates the output of each container (like `docker compose logs --follow` does).
|
2023-01-03 15:35:24 +01:00
|
|
|
|
One can optionally select a subset of services to attach to using `--attach` flag, or exclude some services using
|
|
|
|
|
|
`--no-attach` to prevent output to be flooded by some verbose services.
|
|
|
|
|
|
|
2022-03-09 13:24:09 +01:00
|
|
|
|
When the command exits, all containers are stopped. Running `docker compose up --detach` starts the containers in the
|
2021-03-11 16:20:30 +01:00
|
|
|
|
background and leaves them running.
|
|
|
|
|
|
|
2022-03-09 13:24:09 +01:00
|
|
|
|
If there are existing containers for a service, and the service’s configuration or image was changed after the
|
|
|
|
|
|
container’s creation, `docker compose up` picks up the changes by stopping and recreating the containers
|
2021-03-11 16:20:30 +01:00
|
|
|
|
(preserving mounted volumes). To prevent Compose from picking up changes, use the `--no-recreate` flag.
|
|
|
|
|
|
|
|
|
|
|
|
If you want to force Compose to stop and recreate all containers, use the `--force-recreate` flag.
|
|
|
|
|
|
|
|
|
|
|
|
If the process encounters an error, the exit code for this command is `1`.
|
|
|
|
|
|
If the process is interrupted using `SIGINT` (ctrl + C) or `SIGTERM`, the containers are stopped, and the exit code is `0`.
|
