Sfoglia il codice sorgente

Add documentation for COMPOSE_IGNORE_ORPHANS

Signed-off-by: Zixuan James Li <[email protected]>
Zixuan James Li 3 anni fa
parent
commit
fcff39631a
2 ha cambiato i file con 6 aggiunte e 0 eliminazioni
  1. 3 0
      docs/reference/compose.md
  2. 3 0
      docs/reference/docker_compose.yaml

+ 3 - 0
docs/reference/compose.md

@@ -99,3 +99,6 @@ Setting the `COMPOSE_FILE` environment variable is equivalent to passing the `-f
 and so does `COMPOSE_PROFILES` environment variable for to the `--profiles` flag.
 
 If flags are explicitly set on command line, associated environment variable is ignored
+
+Setting the `COMPOSE_IGNORE_ORPHANS` environment variable to `true` will stop docker compose from detecting orphaned 
+containers for the project.

+ 3 - 0
docs/reference/docker_compose.yaml

@@ -98,6 +98,9 @@ long: |-
   and so does `COMPOSE_PROFILES` environment variable for to the `--profiles` flag.
 
   If flags are explicitly set on command line, associated environment variable is ignored
+  
+  Setting the `COMPOSE_IGNORE_ORPHANS` environment variable to `true` will stop docker compose from detecting orphaned
+  containers for the project.
 usage: docker compose
 pname: docker
 plink: docker.yaml