cicd/drone-ssh
1
0
Fork 0
mirror of https://github.com/appleboy/drone-ssh.git synced 2025-07-02 21:52:51 +08:00
Code Issues Packages Projects Releases 1 Wiki Activity

Format parameter keys as code

Browse Source
This commit is contained in:
Albert Wang 2023-01-14 19:24:36 -08:00
parent a101cb940a
commit 4047dfa98d
1 changed files with 25 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
DOCS.md
View File

@ -181,33 +181,33 @@ Example configuration for passphrase which protecting a private key:
| Key | Description |
|-----|-------------|
| ssh_username | account for target host user |
| ssh_password | password for target host user | |
| ssh_passphrase | The purpose of the passphrase is usually to encrypt the private key. |
| ssh_key | plain text of user private key |
| proxy_ssh_username | account for user of proxy server |
| proxy_ssh_password | password for user of proxy server |
| proxy_ssh_passphrase | The purpose of the passphrase is usually to encrypt the private key. |
| proxy_ssh_key | plain text of user private key for proxy server |
| `ssh_username` | account for target host user |
| `ssh_password` | password for target host user | |
| `ssh_passphrase` | The purpose of the passphrase is usually to encrypt the private key. |
| `ssh_key` | plain text of user private key |
| `proxy_ssh_username` | account for user of proxy server |
| `proxy_ssh_password` | password for user of proxy server |
| `proxy_ssh_passphrase` | The purpose of the passphrase is usually to encrypt the private key. |
| `proxy_ssh_key` | plain text of user private key for proxy server |
## Parameter Reference
| Key | Description |
|-----|-------------|
| host | target hostname or IP |
| port | ssh port of target host |
| username | account for target host user |
| password | password for target host user |
| key | plain text of user private key |
| key_path | key path of user private key |
| envs | custom secrets which are made available in the script section |
| script | execute commands on a remote server |
| script_stop | stop script after first failure |
| timeout | Timeout is the maximum amount of time for the ssh connection to establish, default is 30 seconds. |
| command_timeout | Command timeout is the maximum amount of time for the execute commands, default is 10 minutes. |
| proxy_host | proxy hostname or IP |
| proxy_port | ssh port of proxy host |
| proxy_username | account for proxy host user |
| proxy_password | password for proxy host user |
| proxy_key | plain text of proxy private key |
| proxy_key_path | key path of proxy private key |
| `host` | target hostname or IP |
| `port` | ssh port of target host |
| `username` | account for target host user |
| `password` | password for target host user |
| `key` | plain text of user private key |
| `key_path` | key path of user private key |
| `envs` | custom secrets which are made available in the script section |
| `script` | execute commands on a remote server |
| `script_stop` | stop script after first failure |
| `timeout` | Timeout is the maximum amount of time for the ssh connection to establish, default is 30 seconds. |
| `command_timeout` | Command timeout is the maximum amount of time for the execute commands, default is 10 minutes. |
| `proxy_host` | proxy hostname or IP |
| `proxy_port` | ssh port of proxy host |
| `proxy_username` | account for proxy host user |
| `proxy_password` | password for proxy host user |
| `proxy_key` | plain text of proxy private key |
| `proxy_key_path` | key path of proxy private key |