|
1 | 1 | [](https://github.com/cssnr/stack-deploy-action/actions/workflows/tags.yaml) |
2 | 2 | [](https://github.com/cssnr/stack-deploy-action/actions/workflows/test.yaml) |
| 3 | +[](https://github.com/cssnr/stack-deploy-action/actions/workflows/lint.yaml) |
3 | 4 | [](https://github.com/cssnr/stack-deploy-action/releases/latest) |
4 | 5 | [](https://github.com/cssnr/parse-issue-form-action/graphs/commit-activity) |
5 | 6 | [](https://codeberg.org/cssnr/parse-issue-form-action) |
6 | 7 | [](https://github.com/cssnr/stack-deploy-action) |
| 8 | +[](https://github.com/cssnr/stack-deploy-action/stargazers) |
7 | 9 | [](https://cssnr.github.io/) |
8 | 10 | [](https://discord.gg/wXy6m2X8wY) |
9 | 11 |
|
10 | 12 | # Docker Stack Deploy Action |
11 | 13 |
|
| 14 | +- [Inputs](#Inputs) |
| 15 | +- [Examples](#Examples) |
| 16 | +- [Support](#Support) |
| 17 | +- [Contributing](#Contributing) |
| 18 | + |
12 | 19 | This action deploys a docker stack from a compose file to a remote docker host using SSH Password or Key File Authentication. |
13 | 20 | You can also optionally authenticate against a private registry using a username and password. |
14 | 21 |
|
15 | 22 | For more details see [action.yaml](action.yaml) and [src/main.sh](src/main.sh). |
16 | 23 |
|
17 | 24 | _Portainer Users_: You can deploy directly to Portainer with: [cssnr/portainer-stack-deploy-action](https://github.com/cssnr/portainer-stack-deploy-action) |
18 | 25 |
|
19 | | -- [Inputs](#Inputs) |
20 | | -- [Examples](#Examples) |
21 | | -- [Support](#Support) |
22 | | -- [Contributing](#Contributing) |
23 | | - |
24 | 26 | ## Inputs |
25 | 27 |
|
26 | | -| input | required | default | description | |
27 | | -| ------------- | ---------------- | --------------------- | --------------------------------- | |
28 | | -| host | **Yes** | - | Remote Docker hostname | |
29 | | -| port | No | `22` | Remote Docker port | |
30 | | -| user | **Yes** | - | Remote Docker username | |
| 28 | +| input | required | default | description | |
| 29 | +| ------------- | :--------------: | --------------------- | --------------------------------- | |
| 30 | +| host | **Yes** | - | Remote Docker hostname | |
| 31 | +| port | - | `22` | Remote Docker port | |
| 32 | +| user | **Yes** | - | Remote Docker username | |
31 | 33 | | pass | Not w/ `ssh_key` | - | Remote Docker password \* | |
32 | | -| ssh_key | Not w/ `pass` | - | Remote SSH Key file \* | |
33 | | -| file | No | `docker-compose.yaml` | Docker Compose file | |
34 | | -| name | **Yes** | - | Docker Stack name | |
35 | | -| env_file | No | - | Docker Environment file | |
36 | | -| registry_auth | No | - | Enable Registry Authentication \* | |
37 | | -| registry_host | No | - | Registry Authentication Host \* | |
38 | | -| registry_user | No | - | Registry Authentication User \* | |
39 | | -| registry_pass | No | - | Registry Authentication Pass \* | |
| 34 | +| ssh_key | Not w/ `pass` | - | Remote SSH Key file \* | |
| 35 | +| file | - | `docker-compose.yaml` | Docker Compose file | |
| 36 | +| name | **Yes** | - | Docker Stack name | |
| 37 | +| env_file | - | - | Docker Environment file | |
| 38 | +| registry_auth | - | - | Enable Registry Authentication \* | |
| 39 | +| registry_host | - | - | Registry Authentication Host \* | |
| 40 | +| registry_user | - | - | Registry Authentication User \* | |
| 41 | +| registry_pass | - | - | Registry Authentication Pass \* | |
40 | 42 |
|
41 | 43 | **pass/ssh_key** - You must provide either a `pass` or `ssh_key` |
42 | 44 |
|
@@ -181,22 +183,23 @@ If you are experiencing an issue/bug or getting unexpected results you can: |
181 | 183 |
|
182 | 184 | - Report an Issue: https://github.com/cssnr/stack-deploy-action/issues |
183 | 185 | - Chat with us on Discord: https://discord.gg/wXy6m2X8wY |
184 | | -- Provide General |
185 | | - Feedback: [https://cssnr.github.io/feedback/](https://cssnr.github.io/feedback/?app=Stack%20Deploy) |
| 186 | +- Provide General Feedback: [https://cssnr.github.io/feedback/](https://cssnr.github.io/feedback/?app=Stack%20Deploy) |
186 | 187 |
|
187 | 188 | # Contributing |
188 | 189 |
|
189 | 190 | Currently, the best way to contribute to this project is to star this project on GitHub. |
190 | 191 |
|
191 | 192 | Additionally, you can support other GitHub Actions I have published: |
192 | 193 |
|
193 | | -- [VirusTotal Action](https://github.com/cssnr/virustotal-action) |
194 | | -- [Update Version Tags Action](https://github.com/cssnr/update-version-tags-action) |
195 | | -- [Update JSON Value Action](https://github.com/cssnr/update-json-value-action) |
196 | | -- [Parse Issue Form Action](https://github.com/cssnr/parse-issue-form-action) |
197 | | -- [Mirror Repository Action](https://github.com/cssnr/mirror-repository-action) |
198 | | -- [Stack Deploy Action](https://github.com/cssnr/stack-deploy-action) |
199 | | -- [Portainer Stack Deploy](https://github.com/cssnr/portainer-stack-deploy-action) |
200 | | -- [Mozilla Addon Update Action](https://github.com/cssnr/mozilla-addon-update-action) |
| 194 | +- [Stack Deploy Action](https://github.com/cssnr/stack-deploy-action?tab=readme-ov-file#readme) |
| 195 | +- [Portainer Stack Deploy](https://github.com/cssnr/portainer-stack-deploy-action?tab=readme-ov-file#readme) |
| 196 | +- [VirusTotal Action](https://github.com/cssnr/virustotal-action?tab=readme-ov-file#readme) |
| 197 | +- [Mirror Repository Action](https://github.com/cssnr/mirror-repository-action?tab=readme-ov-file#readme) |
| 198 | +- [Update Version Tags Action](https://github.com/cssnr/update-version-tags-action?tab=readme-ov-file#readme) |
| 199 | +- [Update JSON Value Action](https://github.com/cssnr/update-json-value-action?tab=readme-ov-file#readme) |
| 200 | +- [Parse Issue Form Action](https://github.com/cssnr/parse-issue-form-action?tab=readme-ov-file#readme) |
| 201 | +- [Cloudflare Purge Cache Action](https://github.com/cssnr/cloudflare-purge-cache-action?tab=readme-ov-file#readme) |
| 202 | +- [Mozilla Addon Update Action](https://github.com/cssnr/mozilla-addon-update-action?tab=readme-ov-file#readme) |
| 203 | +- [Docker Tags Action](https://github.com/cssnr/docker-tags-action?tab=readme-ov-file#readme) |
201 | 204 |
|
202 | 205 | For a full list of current projects to support visit: [https://cssnr.github.io/](https://cssnr.github.io/) |
0 commit comments