actions/ssh-action
1
0
Fork 0
mirror of https://github.com/appleboy/ssh-action.git synced 2024-12-19 20:29:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: improve README clarity and completeness

Browse Source 
- 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

3
README.md
View File

@ -17,12 +17,13 @@ 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 | |
| protocol | SSH protocol version (tcp, tcp4, tcp6) | tcp |
| sync | Enable synchronous execution if multiple hosts | false | | sync | Enable synchronous execution if multiple hosts | 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, a sensible default | |