@@ -16,38 +16,37 @@ This thing is built using [Golang](https://go.dev) and [drone-ssh](https://githu
1616
1717See [ action.yml] ( ./action.yml ) for more detailed information.
1818
19- * ` host ` - ssh host
20- * ` port ` - ssh port, default is ` 22 `
21- * ` username ` - ssh username
22- * ` password ` - ssh password
23- * ` passphrase ` - the passphrase is usually to encrypt the private key
24- * ` sync ` - synchronous execution if multiple hosts, default is false
25- * ` timeout ` - timeout for ssh to remote host, default is ` 30s `
26- * ` command_timeout ` - timeout for ssh command, default is ` 10m `
27- * ` key ` - content of ssh private key. ex raw content of ~ /.ssh/id_rsa, remember include the BEGIN and END lines
28- * ` key_path ` - path of ssh private key
29- * ` fingerprint ` - fingerprint SHA256 of the host public key, default is to skip verification
30- * ` script ` - execute commands
31- * ` script_stop ` - stop script after first failure
32- * ` envs ` - pass environment variable to shell script
33- * ` debug ` - enable debug mode
34- * ` use_insecure_cipher ` - include more ciphers with use_insecure_cipher (see [ #56 ] ( https://github.com/appleboy/ssh-action/issues/56 ) )
35- * ` cipher ` - the allowed cipher algorithms. If unspecified then a sensible
36- * ` envs_format ` - flexible configuration of environment value transfer. default is ` export {NAME}={VALUE} `
37-
38- SSH Proxy Setting:
39-
40- * ` proxy_host ` - proxy host
41- * ` proxy_port ` - proxy port, default is ` 22 `
42- * ` proxy_username ` - proxy username
43- * ` proxy_password ` - proxy password
44- * ` proxy_passphrase ` - the passphrase is usually to encrypt the private key
45- * ` proxy_timeout ` - timeout for ssh to proxy host, default is ` 30s `
46- * ` proxy_key ` - content of ssh proxy private key.
47- * ` proxy_key_path ` - path of ssh proxy private key
48- * ` proxy_fingerprint ` - fingerprint SHA256 of the proxy host public key, default is to skip verification
49- * ` proxy_use_insecure_cipher ` - include more ciphers with use_insecure_cipher (see [ #56 ] ( https://github.com/appleboy/ssh-action/issues/56 ) )
50- * ` proxy_cipher ` - the allowed cipher algorithms. If unspecified then a sensible
19+ | Input Parameter | Description | Default Value |
20+ | -------------------------| -----------------------------------------------------------------| ---------------|
21+ | host | SSH host address | |
22+ | port | SSH port number | 22 |
23+ | passphrase | SSH key passphrase | |
24+ | username | SSH username | |
25+ | password | SSH password | |
26+ | sync | Enable synchronous execution if multiple hosts | false |
27+ | use_insecure_cipher | Include more ciphers with use_insecure_cipher | false |
28+ | cipher | Allowed cipher algorithms. If unspecified, a sensible default | |
29+ | timeout | Timeout duration for SSH to host | 30s |
30+ | command_timeout | Timeout duration for SSH command | 10m |
31+ | key | Content of SSH private key. e.g., raw content of ~ /.ssh/id_rsa | |
32+ | key_path | Path of SSH private key | |
33+ | fingerprint | SHA256 fingerprint of the host public key | |
34+ | proxy_host | SSH proxy host | |
35+ | proxy_port | SSH proxy port | 22 |
36+ | proxy_username | SSH proxy username | |
37+ | proxy_password | SSH proxy password | |
38+ | proxy_passphrase | SSH proxy key passphrase | |
39+ | proxy_timeout | Timeout for SSH to proxy host | 30s |
40+ | proxy_key | Content of SSH proxy private key | |
41+ | proxy_key_path | Path of SSH proxy private key | |
42+ | proxy_fingerprint | SHA256 fingerprint of the proxy host public key | |
43+ | proxy_cipher | Allowed cipher algorithms for the proxy | |
44+ | proxy_use_insecure_cipher | Include more ciphers with use_insecure_cipher for the proxy | false |
45+ | script | Execute commands | |
46+ | script_stop | Stop script after first failure | false |
47+ | envs | Pass environment variables to shell script | |
48+ | envs_format | Flexible configuration of environment value transfer | |
49+ | debug | Enable debug mode | false |
5150
5251## Usage
5352
0 commit comments