You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+17-57Lines changed: 17 additions & 57 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
# Docker Compose Gitops Action
2
-
A [GitHub Action](https://github.com/marketplace/actions/docker-compose-gitops) making GitOps with the simplicity of docker-compose possible, using SSH or optionally Tailscale SSH.
2
+
A [GitHub Action](https://github.com/marketplace/actions/docker-compose-gitops) making GitOps with the simplicity of docker-compose possible, using SSH or optionally Tailscale SSH, with support for docker swarm, uploading directory for bind mounts and other features!
3
3
4
4
The Action is adapted from work by [TapTap21](https://github.com/TapTap21/docker-remote-deployment-action) and [wshihadeh](https://github.com/marketplace/actions/docker-deployment)
5
5
@@ -24,62 +24,22 @@ Below is an example of how the action can be used
24
24
```
25
25
26
26
Use the latest tag to run the latest build or a specific version tag. The action pulls a docker image instead of building one to improve performance.
27
-
## Input
28
-
29
-
Below is a breakdown of the expected action inputs.
30
-
31
-
### `args`
32
-
33
-
Docker-compose runtime arguments and options. Below is a common usage example:
34
-
35
-
- `-p app_stack_name -d up`
36
-
37
-
### `remote_docker_host`
38
-
39
-
Specify Remote Docker host. The input value must be in the following format (user@host)
40
-
41
-
### `tailscale_ssh`
42
-
Enables Tailscale ssh mode, which uses managed ssh keys from tailscale.
43
-
When enabled, ssh_private_key and ssh_public_key aren't required
44
-
45
-
### `ssh_public_key`
46
-
47
-
Remote Docker SSH public key.
48
-
49
-
### `ssh_private_key`
50
-
51
-
SSH private key used to connect to the docker host.
52
-
53
-
SSH key must be in PEM format (begins with -----BEGIN RSA PRIVATE KEY-----)
54
-
55
-
### `ssh_port`
56
-
57
-
The SSH port to be used. Default is 22.
58
-
59
-
### `compose_file_path`
60
-
61
-
path for Docker compose file used. Default is `docker-compose.yml`(repo root), for example when it's inside a sub-directory `caddy/docker-compose.yml`
62
-
63
-
### `upload_directory`
64
-
Uploads docker compose directory, useful when extra files like Configs are needed for the compose project.
65
-
66
-
### `docker_compose_directory`
67
-
Specifies which directory in the repository to upload, needed for upload_directory
68
-
69
-
### `post_upload_command`
70
-
Optional input to execute a command post upload, when `upload_directory` is enabled. Useful for changing permissions before starting containers.
71
-
72
-
### `docker_login_user`
73
-
74
-
The username for the container repository user. (DockerHub, ECR, etc.)
75
-
76
-
### `docker_login_password`
77
-
78
-
The password for the container repository user.
79
-
80
-
### `docker_login_registry`
81
-
82
-
The docker container registry to authenticate against
- `upload_directory`Uploads docker compose directory, useful for extra files like Configs. Optional
37
+
- `docker_compose_directory`Specifies which directory in the repository to upload, needed for upload_directory
38
+
- `post_upload_command`Optional input to execute a command post upload, when `upload_directory` is enabled. Useful for things like changing permissions before starting containers.
39
+
- `docker_swarm` Uses docker swarm instead of compose by using the docker stack command, default: false
40
+
- `docker_login_user`The username for the container repository user. (DockerHub, ECR, etc.). Optional.
41
+
- `docker_login_password`The password for the container repository user.
42
+
- `docker_login_registry`The docker container registry to authenticate against Optional
0 commit comments