docker_compose_up.yaml 6.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238
  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. Unless they are already running, this command also starts any linked services.
  6. The `docker compose up` command aggregates the output of each container (like `docker compose logs --follow` does).
  7. When the command exits, all containers are stopped. Running `docker compose up --detach` starts the containers in the
  8. background and leaves them running.
  9. If there are existing containers for a service, and the service’s configuration or image was changed after the
  10. container’s creation, `docker compose up` picks up the changes by stopping and recreating the containers
  11. (preserving mounted volumes). To prevent Compose from picking up changes, use the `--no-recreate` flag.
  12. If you want to force Compose to stop and recreate all containers, use the `--force-recreate` flag.
  13. If the process encounters an error, the exit code for this command is `1`.
  14. If the process is interrupted using `SIGINT` (ctrl + C) or `SIGTERM`, the containers are stopped, and the exit code is `0`.
  15. usage: docker compose up [SERVICE...]
  16. pname: docker compose
  17. plink: docker_compose.yaml
  18. options:
  19. - option: abort-on-container-exit
  20. value_type: bool
  21. default_value: "false"
  22. description: |
  23. Stops all containers if any container was stopped. Incompatible with -d
  24. deprecated: false
  25. hidden: false
  26. experimental: false
  27. experimentalcli: false
  28. kubernetes: false
  29. swarm: false
  30. - option: always-recreate-deps
  31. value_type: bool
  32. default_value: "false"
  33. description: Recreate dependent containers. Incompatible with --no-recreate.
  34. deprecated: false
  35. hidden: false
  36. experimental: false
  37. experimentalcli: false
  38. kubernetes: false
  39. swarm: false
  40. - option: attach
  41. value_type: stringArray
  42. default_value: '[]'
  43. description: Attach to service output.
  44. deprecated: false
  45. hidden: false
  46. experimental: false
  47. experimentalcli: false
  48. kubernetes: false
  49. swarm: false
  50. - option: attach-dependencies
  51. value_type: bool
  52. default_value: "false"
  53. description: Attach to dependent containers.
  54. deprecated: false
  55. hidden: false
  56. experimental: false
  57. experimentalcli: false
  58. kubernetes: false
  59. swarm: false
  60. - option: build
  61. value_type: bool
  62. default_value: "false"
  63. description: Build images before starting containers.
  64. deprecated: false
  65. hidden: false
  66. experimental: false
  67. experimentalcli: false
  68. kubernetes: false
  69. swarm: false
  70. - option: detach
  71. shorthand: d
  72. value_type: bool
  73. default_value: "false"
  74. description: 'Detached mode: Run containers in the background'
  75. deprecated: false
  76. hidden: false
  77. experimental: false
  78. experimentalcli: false
  79. kubernetes: false
  80. swarm: false
  81. - option: exit-code-from
  82. value_type: string
  83. description: |
  84. Return the exit code of the selected service container. Implies --abort-on-container-exit
  85. deprecated: false
  86. hidden: false
  87. experimental: false
  88. experimentalcli: false
  89. kubernetes: false
  90. swarm: false
  91. - option: force-recreate
  92. value_type: bool
  93. default_value: "false"
  94. description: |
  95. Recreate containers even if their configuration and image haven't changed.
  96. deprecated: false
  97. hidden: false
  98. experimental: false
  99. experimentalcli: false
  100. kubernetes: false
  101. swarm: false
  102. - option: no-build
  103. value_type: bool
  104. default_value: "false"
  105. description: Don't build an image, even if it's missing.
  106. deprecated: false
  107. hidden: false
  108. experimental: false
  109. experimentalcli: false
  110. kubernetes: false
  111. swarm: false
  112. - option: no-color
  113. value_type: bool
  114. default_value: "false"
  115. description: Produce monochrome output.
  116. deprecated: false
  117. hidden: false
  118. experimental: false
  119. experimentalcli: false
  120. kubernetes: false
  121. swarm: false
  122. - option: no-deps
  123. value_type: bool
  124. default_value: "false"
  125. description: Don't start linked services.
  126. deprecated: false
  127. hidden: false
  128. experimental: false
  129. experimentalcli: false
  130. kubernetes: false
  131. swarm: false
  132. - option: no-log-prefix
  133. value_type: bool
  134. default_value: "false"
  135. description: Don't print prefix in logs.
  136. deprecated: false
  137. hidden: false
  138. experimental: false
  139. experimentalcli: false
  140. kubernetes: false
  141. swarm: false
  142. - option: no-recreate
  143. value_type: bool
  144. default_value: "false"
  145. description: |
  146. If containers already exist, don't recreate them. Incompatible with --force-recreate.
  147. deprecated: false
  148. hidden: false
  149. experimental: false
  150. experimentalcli: false
  151. kubernetes: false
  152. swarm: false
  153. - option: no-start
  154. value_type: bool
  155. default_value: "false"
  156. description: Don't start the services after creating them.
  157. deprecated: false
  158. hidden: false
  159. experimental: false
  160. experimentalcli: false
  161. kubernetes: false
  162. swarm: false
  163. - option: quiet-pull
  164. value_type: bool
  165. default_value: "false"
  166. description: Pull without printing progress information.
  167. deprecated: false
  168. hidden: false
  169. experimental: false
  170. experimentalcli: false
  171. kubernetes: false
  172. swarm: false
  173. - option: remove-orphans
  174. value_type: bool
  175. default_value: "false"
  176. description: Remove containers for services not defined in the Compose file.
  177. deprecated: false
  178. hidden: false
  179. experimental: false
  180. experimentalcli: false
  181. kubernetes: false
  182. swarm: false
  183. - option: renew-anon-volumes
  184. shorthand: V
  185. value_type: bool
  186. default_value: "false"
  187. description: |
  188. Recreate anonymous volumes instead of retrieving data from the previous containers.
  189. deprecated: false
  190. hidden: false
  191. experimental: false
  192. experimentalcli: false
  193. kubernetes: false
  194. swarm: false
  195. - option: scale
  196. value_type: stringArray
  197. default_value: '[]'
  198. description: |
  199. Scale SERVICE to NUM instances. Overrides the `scale` setting in the Compose file if present.
  200. deprecated: false
  201. hidden: false
  202. experimental: false
  203. experimentalcli: false
  204. kubernetes: false
  205. swarm: false
  206. - option: timeout
  207. shorthand: t
  208. value_type: int
  209. default_value: "10"
  210. description: |
  211. Use this timeout in seconds for container shutdown when attached or when containers are already running.
  212. deprecated: false
  213. hidden: false
  214. experimental: false
  215. experimentalcli: false
  216. kubernetes: false
  217. swarm: false
  218. - option: wait
  219. value_type: bool
  220. default_value: "false"
  221. description: Wait for services to be running|healthy. Implies detached mode.
  222. deprecated: false
  223. hidden: false
  224. experimental: false
  225. experimentalcli: false
  226. kubernetes: false
  227. swarm: false
  228. deprecated: false
  229. experimental: false
  230. experimentalcli: false
  231. kubernetes: false
  232. swarm: false