@@ -22,7 +22,7 @@ The inputs are organized in a table for quick [reference](#reference) with addit
2222| [ detach] ( #detach ) ** ²** | ` true ` | Detach Flag, ` false ` , to disable |
2323| [ prune] ( #prune ) ** ²** | ` false ` | Prune Flag, ` true ` , to enable |
2424| [ resolve_image] ( #resolve_image ) ** ²** | ` always ` | Resolve [ ` always ` , ` changed ` , ` never ` ] |
25- | [ registry_auth] ( #registry_auth ) ** ²** | - | Enable Registry Authentication |
25+ | [ registry_auth] ( #registry_auth ) ** ²** | ` false ` | Enable Registry Authentication |
2626| [ registry_host] ( #registry_host ) | - | Registry Authentication Host |
2727| [ registry_user] ( #registry_user ) | - | Registry Authentication Username |
2828| [ registry_pass] ( #registry_pass ) | - | Registry Authentication Password |
@@ -44,22 +44,21 @@ Example: `cool-stack`
4444
4545Stack file or Compose file(s).
4646
47- _ Swarm._ Only supports 1 file per stack.
48-
4947_ Compose._ [ Multiple files] ( https://docs.docker.com/compose/how-tos/multiple-compose-files/ ) can be provided, ** space seperated** ,
5048and the ` -f ` flag will be automatically prepended to each file.
5149
5250Example: ` web.yaml db.yaml `
5351Output: ` -f web.yaml -f db.yaml `
5452
55- ### mode < Badge type = " tip " text = " Compose Only " />
53+ _ Swarm. _ Only supports 1 file per stack.
5654
57- Enable Docker Compose mode by setting this to ` compose ` .
55+ Default: ` docker- compose.yaml `
5856
59- Ths deploy will use [ compose up] ( https://docs.docker.com/reference/cli/docker/compose/up/ )
60- instead of [ stack deploy] ( https://docs.docker.com/reference/cli/docker/stack/deploy/ ) for non-swarm hosts.
57+ ### mode <Badge type =" tip " text =" Compose Only " />
58+
59+ Set this to ` compose ` to use [ compose up] ( https://docs.docker.com/reference/cli/docker/compose/up/ ) for non-swarm hosts.
6160
62- Example : ` compose `
61+ Default : ` swarm `
6362
6463### args <Badge type =" tip " text =" Compose Only " />
6564
@@ -68,14 +67,14 @@ The `detach` flag defaults to false for compose. With no args the default is `--
6867Use an empty string to override. For more details, see the compose
6968[ docs] ( https://docs.docker.com/reference/cli/docker/compose/up/ ) .
7069
71- Example : ` --remove-orphans --force-recreate `
70+ Default : ` --remove-orphans --force-recreate `
7271
7372### host <Badge type =" warning " text =" Required " />
7473
7574The hostname or IP address of the remote docker server to deploy too.
7675If your hostname is behind a proxy like Cloudflare you will need to use the IP address.
7776
78- If you don't know your Public IP, you may be able to find it using one of these commands.
77+ You may be able to find your Public IP with one of these commands.
7978
8079::: code-group
8180
@@ -99,11 +98,9 @@ dig TXT +short o-o.myaddr.l.google.com @ns1.google.com
9998
10099### port
101100
102- SSH Port. The default is 22 .
101+ SSH Port. Only set this if using a non-standard port .
103102
104- Only set this if using a non-standard port.
105-
106- Example: ` 2222 `
103+ Default: ` 22 `
107104
108105### user <Badge type =" warning " text =" Required " />
109106
@@ -133,7 +130,7 @@ The authorized_keys file entry is [cleaned up](https://github.com/cssnr/stack-de
133130
134131You must provide either a ` ssh_key ` or [ pass] ( #pass ) , but ** not** both.
135132
136- To generate an SSH key, run the following as the [ user] ( #user ) you are using :
133+ To generate an SSH key, run the following as the deployment [ user] ( #user ) :
137134
138135::: code-group
139136
@@ -153,6 +150,10 @@ cat ~/.ssh/id_ed25519
153150
154151This will disable the [ ssh-keyscan] ( https://linux.die.net/man/1/ssh-keyscan ) command. ** Advanced usage only.**
155152
153+ Enabling this will ** break** deployments unless you know what you are doing.
154+
155+ Default: ` false `
156+
156157### env_file {#env_file}
157158
158159Variables in this file are exported before running stack deploy.
@@ -170,29 +171,39 @@ That is set in your compose file as normal.
170171Set this to ` false ` to not exit immediately and wait for the services to converge.
171172This will generate extra output in the logs and is useful for debugging deployments.
172173
173- Defaults to ` false ` in ` mode: compose ` .
174+ _ Compose_ . The detach flag is implied in compose.
175+
176+ _ See the [ stack deploy Options] ( https://docs.docker.com/reference/cli/docker/stack/deploy/#options ) for more details._
174177
175- See the [ stack deploy Options ] ( https://docs.docker.com/reference/cli/docker/stack/deploy/#options ) for more details.
178+ Default: ` true `
176179
177180### prune
178181
179182Prune dangling images. Set to ` true ` to enable.
180183
181- See the [ stack deploy Options] ( https://docs.docker.com/reference/cli/docker/stack/deploy/#options ) for more details.
184+ _ See the [ stack deploy Options] ( https://docs.docker.com/reference/cli/docker/stack/deploy/#options ) for more details._
185+
186+ Default: ` false `
182187
183188### resolve_image <Badge type =" tip " text =" Swarm Only " /> {#resolve_image}
184189
190+ Can be one of: [ ` always ` , ` changed ` , ` never ` ]
191+
185192When the default ` always ` is used, this argument is omitted.
186193
187- See the [ stack deploy Options] ( https://docs.docker.com/reference/cli/docker/stack/deploy/#options ) for more details.
194+ _ See the [ stack deploy Options] ( https://docs.docker.com/reference/cli/docker/stack/deploy/#options ) for more details._
195+
196+ Default: ` always `
188197
189198### registry_auth <Badge type =" tip " text =" Swarm Only " /> {#registry_auth}
190199
191200Set to ` true ` to deploy with ` --with-registry-auth ` .
192201
193202If setting [ registry_user] ( #registry_user ) /[ registry_pass] ( #registry_pass ) this is implied.
194203
195- See the [ stack deploy Options] ( https://docs.docker.com/reference/cli/docker/stack/deploy/#options ) for more details.
204+ _ See the [ stack deploy Options] ( https://docs.docker.com/reference/cli/docker/stack/deploy/#options ) for more details._
205+
206+ Default: ` false `
196207
197208### registry_host {#registry_host}
198209
@@ -212,4 +223,6 @@ Required to run [docker login](https://docs.docker.com/reference/cli/docker/logi
212223
213224Write a Summary for the job. To disable this set to ` false ` .
214225
215- For more information see [ Job Summary] ( ../guides/features.md#job-summary ) .
226+ _ For more information see [ Job Summary] ( ../guides/features.md#job-summary ) ._
227+
228+ Default: ` true `
0 commit comments