actions
/
appleboy-ssh-action
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: improve README clarity and completeness 

- Update the README table formatting to include an additional column separator
- Add documentation for the SSH protocol version option in the README table

Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>
This commit is contained in:
Bo-Yi Wu 2024-03-16 16:04:59 +08:00
parent 1991c553ec
commit dd0f09ca07
No known key found for this signature in database
1 changed files with 34 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

67
README.md
View File

@ -16,39 +16,40 @@ This thing is built using [Golang](https://go.dev) and [drone-ssh](https://githu
See [action.yml](./action.yml) for more detailed information. See [action.yml](./action.yml) for more detailed information.
| Input Parameter | Description | Default Value | | Input Parameter | Description | Default Value |
|-------------------------|-----------------------------------------------------------------|---------------| |---------------------------|------------------------------------------------------------------------------------------|---------------|
| host | SSH host address | | | host | SSH host address | |
| port | SSH port number | 22 | | port | SSH port number | 22 |
| passphrase | SSH key passphrase | | | passphrase | SSH key passphrase | |
| username | SSH username | | | username | SSH username | |
| password | SSH password | | | password | SSH password | |
| sync | Enable synchronous execution if multiple hosts | false | | protocol | SSH protocol version (tcp, tcp4, tcp6) | tcp |
| use_insecure_cipher | Include more ciphers with use_insecure_cipher | false | | sync | Enable synchronous execution if multiple hosts | false |
| cipher | Allowed cipher algorithms. If unspecified, a sensible default | | | use_insecure_cipher | Include more ciphers with use_insecure_cipher | false |
| timeout | Timeout duration for SSH to host | 30s | | cipher | Allowed cipher algorithms. If unspecified, a sensible default | |
| command_timeout | Timeout duration for SSH command | 10m | | timeout | Timeout duration for SSH to host | 30s |
| key | Content of SSH private key. e.g., raw content of ~/.ssh/id_rsa | | | command_timeout | Timeout duration for SSH command | 10m |
| key_path | Path of SSH private key | | | key | Content of SSH private key. e.g., raw content of ~/.ssh/id_rsa | |
| fingerprint | SHA256 fingerprint of the host public key | | | key_path | Path of SSH private key | |
| proxy_host | SSH proxy host | | | fingerprint | SHA256 fingerprint of the host public key | |
| proxy_port | SSH proxy port | 22 | | proxy_host | SSH proxy host | |
| proxy_username | SSH proxy username | | | proxy_port | SSH proxy port | 22 |
| proxy_password | SSH proxy password | | | proxy_username | SSH proxy username | |
| proxy_passphrase | SSH proxy key passphrase | | | proxy_password | SSH proxy password | |
| proxy_timeout | Timeout for SSH to proxy host | 30s | | proxy_passphrase | SSH proxy key passphrase | |
| proxy_key | Content of SSH proxy private key | | | proxy_timeout | Timeout for SSH to proxy host | 30s |
| proxy_key_path | Path of SSH proxy private key | | | proxy_key | Content of SSH proxy private key | |
| proxy_fingerprint | SHA256 fingerprint of the proxy host public key | | | proxy_key_path | Path of SSH proxy private key | |
| proxy_cipher | Allowed cipher algorithms for the proxy | | | proxy_fingerprint | SHA256 fingerprint of the proxy host public key | |
| proxy_use_insecure_cipher | Include more ciphers with use_insecure_cipher for the proxy | false | | proxy_cipher | Allowed cipher algorithms for the proxy | |
| script | Execute commands | | | proxy_use_insecure_cipher | Include more ciphers with use_insecure_cipher for the proxy | false |
| script_stop | Stop script after first failure | false | | script | Execute commands | |
| envs | Pass environment variables to shell script | | | script_stop | Stop script after first failure | false |
| envs_format | Flexible configuration of environment value transfer | | | envs | Pass environment variables to shell script | |
| debug | Enable debug mode | false | | envs_format | Flexible configuration of environment value transfer | |
| allenvs | pass the environment variables with prefix value of `GITHUB_` and `INPUT_` to the script | false | | debug | Enable debug mode | false |
| request_pty | Request a pseudo-terminal from the server | false | | allenvs | pass the environment variables with prefix value of `GITHUB_` and `INPUT_` to the script | false |
| request_pty | Request a pseudo-terminal from the server | false |
## Usage ## Usage