Skip to content

Commit 0eed88d

Browse files
smashedrsmashedr
committed
Update README.md
1 parent 85e345f commit 0eed88d

1 file changed

Lines changed: 63 additions & 35 deletions

File tree

‎README.md‎

Lines changed: 63 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -98,27 +98,27 @@ Don't see your feature here? Please help by submitting a [Feature Request](https
9898
> [!IMPORTANT]
9999
> View the [Inputs Documentation](https://docker-deploy.cssnr.com/docs/inputs) for comprehensive, up-to-date documentation.
100100

101-
| Input Name | Required | Default Value | Short Description of the Input Value |
102-
| :------------------- | :----------: | :---------------------------------- | :------------------------------------------------------------ |
103-
| `name` | **Yes** | - | Docker Stack/Project Name \* |
104-
| `file` | - | `docker-compose.yaml` | Docker Stack/Compose File(s) \* |
105-
| `mode`**¹** | - | `swarm` | Deploy Mode [`swarm`, `compose`] \* |
106-
| `args`**¹** | - | `--remove-orphans --force-recreate` | Additional **Compose** Arguments \* |
107-
| `host` | **Yes** | - | Remote Docker Hostname or IP \* |
108-
| `port` | - | `22` | Remote Docker Port |
109-
| `user` | **Yes** | - | Remote Docker Username |
110-
| `pass` | or `ssh_key` | - | Remote Docker Password \* |
111-
| `ssh_key` | or `pass` | - | Remote SSH Key File \* |
112-
| `disable_keyscan` | - | `false` | Disable SSH Keyscan `ssh-keyscan` \* |
113-
| `env_file` | - | - | Docker Environment File \* |
114-
| `detach`**²** | - | `true` | Detach Flag, `false`, to disable \* |
115-
| `prune`**²** | - | `false` | Prune Flag, `true`, to enable |
116-
| `resolve_image`**²** | - | `always` | Resolve [`always`, `changed`, `never`] \* |
117-
| `registry_auth`**²** | - | `false` | Enable Registry Authentication \* |
118-
| `registry_host` | - | - | Registry Authentication Host \* |
119-
| `registry_user` | - | - | Registry Authentication Username \* |
120-
| `registry_pass` | - | - | Registry Authentication Password \* |
121-
| `summary` | - | `true` | Add Job Summary \* |
101+
| Input Name | Default Value | Short Description of the Input Value |
102+
| :------------------- | :---------------------------------- | :----------------------------------------------------------------- |
103+
| `name` | _Required_ | Docker Stack/Project Name [⤵️](#name) |
104+
| `file` | `docker-compose.yaml` | Docker Stack/Compose File(s) [⤵️](#file) |
105+
| `mode`**¹** | `swarm` | Deploy Mode [`swarm`, `compose`] [⤵️](#mode) |
106+
| `args`**¹** | `--remove-orphans --force-recreate` | Additional **Compose** Arguments [⤵️](#args) |
107+
| `host` | _Required_ | Remote Docker Hostname or IP [⤵️](#host) |
108+
| `port` | `22` | Remote Docker Port **port** |
109+
| `user` | _Required_ | Remote Docker Username **user** |
110+
| `pass` | _or ssh_key_ | Remote Docker Password [⤵️](#passssh_key) |
111+
| `ssh_key` | _or pass_ | Remote SSH Key File [⤵️](#passssh_key) |
112+
| `disable_keyscan` | `false` | Disable SSH Keyscan `ssh-keyscan` [⤵️](#disable_keyscan) |
113+
| `env_file` | - | Docker Environment File [⤵️](#env_file) |
114+
| `detach`**²** | `true` | Detach Flag, `false`, to disable [⤵️](#detach) |
115+
| `prune`**²** | `false` | Prune Flag, `true`, to enable prune |
116+
| `resolve_image`**²** | `always` | Resolve [`always`, `changed`, `never`] [⤵️](#resolve_image) |
117+
| `registry_auth`**²** | `false` | Enable Registry Authentication [⤵️](#registry_auth) |
118+
| `registry_host` | - | Registry Authentication Host [⤵️](#registry_host) |
119+
| `registry_user` | - | Registry Authentication Username [⤵️](#registry_userregistry_pass) |
120+
| `registry_pass` | - | Registry Authentication Password [⤵️](#registry_userregistry_pass) |
121+
| `summary` | `true` | Add Job Summary [⤵️](#summary) |
122122

123123
> **¹** Compose Only, view the [Docs](https://docs.docker.com/reference/cli/docker/compose/up/).
124124
> **²** Swarm Only, view the [Docs](https://docs.docker.com/reference/cli/docker/stack/deploy/).
@@ -142,43 +142,71 @@ Compose Note: `"${STACK_FILES[@]}"` is an array of `-f docker-compose.yaml` for
142142

143143
</details>
144144

145-
**name:** Stack name for Swarm and project name for Compose.
145+
#### name
146146

147-
**file:** Stack file or Compose file(s). Multiple files can be provided, space seperated, and a `-f` will be prepended to each.
147+
Stack name for Swarm and project name for Compose.
148+
149+
#### file
150+
151+
Stack file or Compose file(s). Multiple files can be provided, space seperated, and a `-f` will be prepended to each.
148152
Example: `web.yaml db.yaml`.
149153

150-
**mode:** _Compose only._ Set this to `compose` to use `compose up` instead of `stack deploy` for non-swarm hosts.
154+
#### mode
155+
156+
_Compose only._ Set this to `compose` to use `compose up` instead of `stack deploy` for non-swarm hosts.
157+
158+
#### args
151159

152-
**args:** _Compose only._ Compose arguments to pass to the `compose up` command. Only used for `mode: compose` deployments.
160+
_Compose only._ Compose arguments to pass to the `compose up` command. Only used for `mode: compose` deployments.
153161
The `detach` flag defaults to false for compose. With no args the default is `--remove-orphans --force-recreate`.
154162
Use an empty string to override. For more details, see the compose
155163
[docs](https://docs.docker.com/reference/cli/docker/compose/up/).
156164

157-
**host:** The hostname or IP address of the remote docker server to deploy too.
165+
#### host
166+
167+
The hostname or IP address of the remote docker server to deploy too.
158168
If your hostname is behind a proxy like Cloudflare you will need to use the IP address.
159169

160-
**pass/ssh_key:** You must provide either a `pass` or `ssh_key`, not both.
170+
#### pass/ssh_key
171+
172+
You must provide either a `pass` or `ssh_key`, not both.
173+
174+
#### disable_keyscan
161175

162-
**disable_keyscan:** This will disable the `ssh-keyscan` command. Advanced use only.
176+
This will disable the `ssh-keyscan` command. Advanced use only.
163177

164-
**env_file:** Variables in this file are exported before running stack deploy.
178+
#### env_file
179+
180+
Variables in this file are exported before running stack deploy.
165181
To use a docker `env_file` specify it in your compose file and make it available in a previous step.
166182
If you need compose file templating this can also be done in a previous step.
167183
If using `mode: compose` you can also add the `compose_arg: --env-file stringArray`.
168184

169-
**detach:** _Swarm only._ Set this to `false` to not exit immediately and wait for the services to converge.
185+
#### detach
186+
187+
_Swarm only._ Set this to `false` to not exit immediately and wait for the services to converge.
170188
This will generate extra output in the logs and is useful for debugging deployments.
171189
Defaults to `false` in `mode: compose`.
172190

173-
**resolve_image:** _Swarm only._ When the default `always` is used, this argument is omitted.
191+
#### resolve_image
192+
193+
_Swarm only._ When the default `always` is used, this argument is omitted.
194+
195+
#### registry_auth
196+
197+
_Swarm only._ Set to `true` to deploy with `--with-registry-auth`.
198+
199+
#### registry_host
200+
201+
To run `docker login` on another registry. Example: `ghcr.io`.
174202

175-
**registry_auth:** _Swarm only._ Set to `true` to deploy with `--with-registry-auth`.
203+
#### registry_user/registry_pass
176204

177-
**registry_host:** To run `docker login` on another registry. Example: `ghcr.io`.
205+
Required to run `docker login` before stack deploy.
178206

179-
**registry_user/registry_pass:** Required to run `docker login` before stack deploy.
207+
#### summary
180208

181-
**summary:** Write a Summary for the job. To disable this set to `false`.
209+
Write a Summary for the job. To disable this set to `false`.
182210

183211
To view a workflow run, click on a recent [Test](https://github.com/cssnr/stack-deploy-action/actions/workflows/test.yaml) job _(requires login)_.
184212

0 commit comments

Comments
 (0)