infrastructure/docker-remote-deployment-action
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
smf
2024-03-08 18:46:09 +08:00
parent 3ec54a128a
commit 83c611bb20
2 changed files with 10 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@@ -25,25 +25,23 @@ Below is a brief example on how the action can be used:
## Input Configurations
### `remote_docker_host`
Remote Docker host ie (user@host).
Remote Docker host.
### `remote_docker_user`
Remote Docker user.
### `remote_docker_port`
Remote Docker ssh port ie (22).
### `ssh_public_key`
Remote Docker SSH public key eg (~/.ssh/rsa_id.pub).
### `ssh_private_key`
SSH private key used to connect to the docker host eg (~/.ssh/rsa_id).
### `ssh_proxy_cmd`
SSH ProxyCommand used to connect to the docker host.
### `args`
Deployment command args.
### `deployment_mode`
Deployment mode either docker-swarm or docker-compose. Default is docker-compose.
### `copy_stack_file`
Copy stack file to remote server and deploy from the server. Default is false.
### `deploy_path`
The path where the stack files will be copied to. Default ~/docker-deployment.
The absolute path on remote docker host to deploy, default rely on repo working directory.
### `stack_file_name`
Docker stack file used. Default is docker-compose.yml.
### `keep_files`
Number of the files to be kept on the server. Default is 3.
Compose configuration files.
### `env_file_name`
Specify an alternate environment file.
### `docker_prune`
A boolean input to trigger docker prune command. Default is false.
### `pre_deployment_command_args`