actions/ssh-action
1
0
Fork 0
mirror of https://github.com/appleboy/ssh-action.git synced 2025-03-10 08:35:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: improve documentation and defaults for execution and security

Browse Source 
- Clarify that synchronous execution is enabled if multiple hosts are specified
- Specify that sensible defaults are used for allowed cipher algorithms if unspecified
- Clarify that environment variables are passed to the shell script

Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>
This commit is contained in:
Bo-Yi Wu 2025-03-07 08:10:39 +08:00
parent 9817ef4a17
commit 92737056c0
No known key found for this signature in database
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -22,9 +22,9 @@ See [action.yml](./action.yml) for more detailed information.
| username | SSH username | | | username | SSH username | |
| password | SSH password | | | password | SSH password | |
| protocol | SSH protocol version (tcp, tcp4, tcp6) | tcp | | protocol | SSH protocol version (tcp, tcp4, tcp6) | tcp |
| sync | Enable synchronous execution if multiple hosts | false | | sync | Enable synchronous execution if multiple hosts are specified | false |
| use_insecure_cipher | Include more ciphers with use_insecure_cipher | false | | use_insecure_cipher | Include more ciphers with use_insecure_cipher | false |
| cipher | Allowed cipher algorithms. If unspecified, a sensible default | | | cipher | Allowed cipher algorithms. If unspecified, sensible defaults are used | |
| timeout | Timeout duration for SSH to host | 30s | | timeout | Timeout duration for SSH to host | 30s |
| command_timeout | Timeout duration for SSH command | 10m | | command_timeout | Timeout duration for SSH command | 10m |
| key | Content of SSH private key. e.g., raw content of ~/.ssh/id_rsa | | | key | Content of SSH private key. e.g., raw content of ~/.ssh/id_rsa | |
@ -44,7 +44,7 @@ See [action.yml](./action.yml) for more detailed information.
| proxy_use_insecure_cipher | Include more ciphers with use_insecure_cipher for the proxy | false | | proxy_use_insecure_cipher | Include more ciphers with use_insecure_cipher for the proxy | false |
| script | Execute commands | | | script | Execute commands | |
| script_path | Execute commands from a file | | | script_path | Execute commands from a file | |
| envs | Pass environment variables to shell script | | | envs | Pass environment variables to the shell script | |
| envs_format | Flexible configuration of environment value transfer | | | envs_format | Flexible configuration of environment value transfer | |
| debug | Enable debug mode | false | | debug | Enable debug mode | false |
| allenvs | Pass the environment variables with prefix value of `GITHUB_` and `INPUT_` to the script | false | | allenvs | Pass the environment variables with prefix value of `GITHUB_` and `INPUT_` to the script | false |