Debian Codegraph @

docs/reference/docker_compose_up.yaml

raw
1 command: docker compose up
2 short: Create and start containers
3 long: |-
4 Builds, (re)creates, starts, and attaches to containers for a service.
5
6 Unless they are already running, this command also starts any linked services.
7
8 The `docker compose up` command aggregates the output of each container (like `docker compose logs --follow` does).
9 One can optionally select a subset of services to attach to using `--attach` flag, or exclude some services using
10 `--no-attach` to prevent output to be flooded by some verbose services.
11
12 When the command exits, all containers are stopped. Running `docker compose up --detach` starts the containers in the
13 background and leaves them running.
14
15 If there are existing containers for a service, and the service’s configuration or image was changed after the
16 container’s creation, `docker compose up` picks up the changes by stopping and recreating the containers
17 (preserving mounted volumes). To prevent Compose from picking up changes, use the `--no-recreate` flag.
18
19 If you want to force Compose to stop and recreate all containers, use the `--force-recreate` flag.
20
21 If the process encounters an error, the exit code for this command is `1`.
22 If the process is interrupted using `SIGINT` (ctrl + C) or `SIGTERM`, the containers are stopped, and the exit code is `0`.
23 usage: docker compose up [OPTIONS] [SERVICE...]
24 pname: docker compose
25 plink: docker_compose.yaml
26 options:
27 - option: abort-on-container-exit
28 value_type: bool
29 default_value: "false"
30 description: |
31 Stops all containers if any container was stopped. Incompatible with -d
32 deprecated: false
33 hidden: false
34 experimental: false
35 experimentalcli: false
36 kubernetes: false
37 swarm: false
38 - option: abort-on-container-failure
39 value_type: bool
40 default_value: "false"
41 description: |
42 Stops all containers if any container exited with failure. Incompatible with -d
43 deprecated: false
44 hidden: false
45 experimental: false
46 experimentalcli: false
47 kubernetes: false
48 swarm: false
49 - option: always-recreate-deps
50 value_type: bool
51 default_value: "false"
52 description: Recreate dependent containers. Incompatible with --no-recreate.
53 deprecated: false
54 hidden: false
55 experimental: false
56 experimentalcli: false
57 kubernetes: false
58 swarm: false
59 - option: attach
60 value_type: stringArray
61 default_value: '[]'
62 description: |
63 Restrict attaching to the specified services. Incompatible with --attach-dependencies.
64 deprecated: false
65 hidden: false
66 experimental: false
67 experimentalcli: false
68 kubernetes: false
69 swarm: false
70 - option: attach-dependencies
71 value_type: bool
72 default_value: "false"
73 description: Automatically attach to log output of dependent services
74 deprecated: false
75 hidden: false
76 experimental: false
77 experimentalcli: false
78 kubernetes: false
79 swarm: false
80 - option: build
81 value_type: bool
82 default_value: "false"
83 description: Build images before starting containers
84 deprecated: false
85 hidden: false
86 experimental: false
87 experimentalcli: false
88 kubernetes: false
89 swarm: false
90 - option: detach
91 shorthand: d
92 value_type: bool
93 default_value: "false"
94 description: 'Detached mode: Run containers in the background'
95 deprecated: false
96 hidden: false
97 experimental: false
98 experimentalcli: false
99 kubernetes: false
100 swarm: false
101 - option: exit-code-from
102 value_type: string
103 description: |
104 Return the exit code of the selected service container. Implies --abort-on-container-exit
105 deprecated: false
106 hidden: false
107 experimental: false
108 experimentalcli: false
109 kubernetes: false
110 swarm: false
111 - option: force-recreate
112 value_type: bool
113 default_value: "false"
114 description: |
115 Recreate containers even if their configuration and image haven't changed
116 deprecated: false
117 hidden: false
118 experimental: false
119 experimentalcli: false
120 kubernetes: false
121 swarm: false
122 - option: menu
123 value_type: bool
124 default_value: "false"
125 description: |
126 Enable interactive shortcuts when running attached. Incompatible with --detach. Can also be enable/disable by setting COMPOSE_MENU environment var.
127 deprecated: false
128 hidden: false
129 experimental: false
130 experimentalcli: false
131 kubernetes: false
132 swarm: false
133 - option: no-attach
134 value_type: stringArray
135 default_value: '[]'
136 description: Do not attach (stream logs) to the specified services
137 deprecated: false
138 hidden: false
139 experimental: false
140 experimentalcli: false
141 kubernetes: false
142 swarm: false
143 - option: no-build
144 value_type: bool
145 default_value: "false"
146 description: Don't build an image, even if it's policy
147 deprecated: false
148 hidden: false
149 experimental: false
150 experimentalcli: false
151 kubernetes: false
152 swarm: false
153 - option: no-color
154 value_type: bool
155 default_value: "false"
156 description: Produce monochrome output
157 deprecated: false
158 hidden: false
159 experimental: false
160 experimentalcli: false
161 kubernetes: false
162 swarm: false
163 - option: no-deps
164 value_type: bool
165 default_value: "false"
166 description: Don't start linked services
167 deprecated: false
168 hidden: false
169 experimental: false
170 experimentalcli: false
171 kubernetes: false
172 swarm: false
173 - option: no-log-prefix
174 value_type: bool
175 default_value: "false"
176 description: Don't print prefix in logs
177 deprecated: false
178 hidden: false
179 experimental: false
180 experimentalcli: false
181 kubernetes: false
182 swarm: false
183 - option: no-recreate
184 value_type: bool
185 default_value: "false"
186 description: |
187 If containers already exist, don't recreate them. Incompatible with --force-recreate.
188 deprecated: false
189 hidden: false
190 experimental: false
191 experimentalcli: false
192 kubernetes: false
193 swarm: false
194 - option: no-start
195 value_type: bool
196 default_value: "false"
197 description: Don't start the services after creating them
198 deprecated: false
199 hidden: false
200 experimental: false
201 experimentalcli: false
202 kubernetes: false
203 swarm: false
204 - option: pull
205 value_type: string
206 default_value: policy
207 description: Pull image before running ("always"|"missing"|"never")
208 deprecated: false
209 hidden: false
210 experimental: false
211 experimentalcli: false
212 kubernetes: false
213 swarm: false
214 - option: quiet-build
215 value_type: bool
216 default_value: "false"
217 description: Suppress the build output
218 deprecated: false
219 hidden: false
220 experimental: false
221 experimentalcli: false
222 kubernetes: false
223 swarm: false
224 - option: quiet-pull
225 value_type: bool
226 default_value: "false"
227 description: Pull without printing progress information
228 deprecated: false
229 hidden: false
230 experimental: false
231 experimentalcli: false
232 kubernetes: false
233 swarm: false
234 - option: remove-orphans
235 value_type: bool
236 default_value: "false"
237 description: Remove containers for services not defined in the Compose file
238 deprecated: false
239 hidden: false
240 experimental: false
241 experimentalcli: false
242 kubernetes: false
243 swarm: false
244 - option: renew-anon-volumes
245 shorthand: V
246 value_type: bool
247 default_value: "false"
248 description: |
249 Recreate anonymous volumes instead of retrieving data from the previous containers
250 deprecated: false
251 hidden: false
252 experimental: false
253 experimentalcli: false
254 kubernetes: false
255 swarm: false
256 - option: scale
257 value_type: stringArray
258 default_value: '[]'
259 description: |
260 Scale SERVICE to NUM instances. Overrides the `scale` setting in the Compose file if present.
261 deprecated: false
262 hidden: false
263 experimental: false
264 experimentalcli: false
265 kubernetes: false
266 swarm: false
267 - option: timeout
268 shorthand: t
269 value_type: int
270 default_value: "0"
271 description: |
272 Use this timeout in seconds for container shutdown when attached or when containers are already running
273 deprecated: false
274 hidden: false
275 experimental: false
276 experimentalcli: false
277 kubernetes: false
278 swarm: false
279 - option: timestamps
280 value_type: bool
281 default_value: "false"
282 description: Show timestamps
283 deprecated: false
284 hidden: false
285 experimental: false
286 experimentalcli: false
287 kubernetes: false
288 swarm: false
289 - option: wait
290 value_type: bool
291 default_value: "false"
292 description: Wait for services to be running|healthy. Implies detached mode.
293 deprecated: false
294 hidden: false
295 experimental: false
296 experimentalcli: false
297 kubernetes: false
298 swarm: false
299 - option: wait-timeout
300 value_type: int
301 default_value: "0"
302 description: |
303 Maximum duration in seconds to wait for the project to be running|healthy
304 deprecated: false
305 hidden: false
306 experimental: false
307 experimentalcli: false
308 kubernetes: false
309 swarm: false
310 - option: watch
311 shorthand: w
312 value_type: bool
313 default_value: "false"
314 description: |
315 Watch source code and rebuild/refresh containers when files are updated.
316 deprecated: false
317 hidden: false
318 experimental: false
319 experimentalcli: false
320 kubernetes: false
321 swarm: false
322 - option: "yes"
323 shorthand: "y"
324 value_type: bool
325 default_value: "false"
326 description: Assume "yes" as answer to all prompts and run non-interactively
327 deprecated: false
328 hidden: false
329 experimental: false
330 experimentalcli: false
331 kubernetes: false
332 swarm: false
333 inherited_options:
334 - option: dry-run
335 value_type: bool
336 default_value: "false"
337 description: Execute command in dry run mode
338 deprecated: false
339 hidden: false
340 experimental: false
341 experimentalcli: false
342 kubernetes: false
343 swarm: false
344 deprecated: false
345 hidden: false
346 experimental: false
347 experimentalcli: false
348 kubernetes: false
349 swarm: false
350