summaryrefslogtreecommitdiff
path: root/devdocs/docker/compose%2Freference%2Fup%2Findex.html
blob: 77a979391d9e52886d471257909f9fe27de9652b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
<h1>docker-compose up</h1>

<pre data-language="">Usage: docker-compose up [options] [--scale SERVICE=NUM...] [SERVICE...]

Options:
    -d, --detach               Detached mode: Run containers in the background,
                               print new container names. Incompatible with
                               --abort-on-container-exit.
    --no-color                 Produce monochrome output.
    --quiet-pull               Pull without printing progress information
    --no-deps                  Don't start linked services.
    --force-recreate           Recreate containers even if their configuration
                               and image haven't changed.
    --always-recreate-deps     Recreate dependent containers.
                               Incompatible with --no-recreate.
    --no-recreate              If containers already exist, don't recreate
                               them. Incompatible with --force-recreate and 
                               --renew-anon-volumes.
    --no-build                 Don't build an image, even if it's missing.
    --no-start                 Don't start the services after creating them.
    --build                    Build images before starting containers.
    --abort-on-container-exit  Stops all containers if any container was
                               stopped. Incompatible with --detach.
    --attach-dependencies      Attach to dependent containers.
    -t, --timeout TIMEOUT      Use this timeout in seconds for container
                               shutdown when attached or when containers are
                               already running. (default: 10)
    -V, --renew-anon-volumes   Recreate anonymous volumes instead of retrieving
                               data from the previous containers.
    --remove-orphans           Remove containers for services not defined
                               in the Compose file.
    --exit-code-from SERVICE   Return the exit code of the selected service
                               container. Implies --abort-on-container-exit.
    --scale SERVICE=NUM        Scale SERVICE to NUM instances. Overrides the
                               `scale` setting in the Compose file if present.
</pre> <p>Builds, (re)creates, starts, and attaches to containers for a service.</p> <p>Unless they are already running, this command also starts any linked services.</p> <p>The <code class="language-plaintext highlighter-rouge">docker-compose up</code> command aggregates the output of each container (essentially running <code class="language-plaintext highlighter-rouge">docker-compose logs --follow</code>). When the command exits, all containers are stopped. Running <code class="language-plaintext highlighter-rouge">docker-compose up --detach</code> starts the containers in the background and leaves them running.</p> <p>If there are existing containers for a service, and the service’s configuration or image was changed after the container’s creation, <code class="language-plaintext highlighter-rouge">docker-compose up</code> picks up the changes by stopping and recreating the containers (preserving mounted volumes). To prevent Compose from picking up changes, use the <code class="language-plaintext highlighter-rouge">--no-recreate</code> flag.</p> <p>If you want to force Compose to stop and recreate all containers, use the <code class="language-plaintext highlighter-rouge">--force-recreate</code> flag.</p> <p>If the process encounters an error, the exit code for this command is <code class="language-plaintext highlighter-rouge">1</code>.<br> If the process is interrupted using <code class="language-plaintext highlighter-rouge">SIGINT</code> (<code class="language-plaintext highlighter-rouge">ctrl</code> + <code class="language-plaintext highlighter-rouge">C</code>) or <code class="language-plaintext highlighter-rouge">SIGTERM</code>, the containers are stopped, and the exit code is <code class="language-plaintext highlighter-rouge">0</code>.<br> If <code class="language-plaintext highlighter-rouge">SIGINT</code> or <code class="language-plaintext highlighter-rouge">SIGTERM</code> is sent again during this shutdown phase, the running containers are killed, and the exit code is <code class="language-plaintext highlighter-rouge">2</code>.</p> 
<p><a href="https://docs.docker.com/search/?q=fig">fig</a>, <a href="https://docs.docker.com/search/?q=composition">composition</a>, <a href="https://docs.docker.com/search/?q=compose">compose</a>, <a href="https://docs.docker.com/search/?q=docker">docker</a>, <a href="https://docs.docker.com/search/?q=orchestration">orchestration</a>, <a href="https://docs.docker.com/search/?q=cli">cli</a>, <a href="https://docs.docker.com/search/?q=up">up</a></p>
<div class="_attribution">
  <p class="_attribution-p">
    &copy; 2019 Docker, Inc.<br>Licensed under the Apache License, Version 2.0.<br>Docker and the Docker logo are trademarks or registered trademarks of Docker, Inc. in the United States and/or other countries.<br>Docker, Inc. and other parties may also have trademark rights in other terms used herein.<br>
    <a href="https://docs.docker.com/compose/reference/up/" class="_attribution-link">https://docs.docker.com/compose/reference/up/</a>
  </p>
</div>