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 table

Browse Source
This commit is contained in:
Albert Wang 2023-01-14 19:19:05 -08:00
parent d9493e4563
commit a101cb940a
1 changed files with 29 additions and 73 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

102
DOCS.md
View File

@ -179,79 +179,35 @@ Example configuration for passphrase which protecting a private key:
## Secret Reference ## Secret Reference
ssh_username | Key | Description |
: account for target host user |-----|-------------|
| ssh_username | account for target host user |
ssh_password | ssh_password | password for target host user | |
: 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 |
ssh_passphrase | proxy_ssh_username | account for user of proxy server |
: The purpose of the passphrase is usually to encrypt the private key. | proxy_ssh_password | password for user of proxy server |
| proxy_ssh_passphrase | The purpose of the passphrase is usually to encrypt the private key. |
ssh_key | proxy_ssh_key | plain text of user private key for proxy server |
: 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 ## Parameter Reference
host | Key | Description |
: target hostname or IP |-----|-------------|
| host | target hostname or IP |
port | port | ssh port of target host |
: ssh port of target host | username | account for target host user |
| password | password for target host user |
username | key | plain text of user private key |
: account for target host user | key_path | key path of user private key |
| envs | custom secrets which are made available in the script section |
password | script | execute commands on a remote server |
: password for target host user | 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. |
key | command_timeout | Command timeout is the maximum amount of time for the execute commands, default is 10 minutes. |
: plain text of user private key | proxy_host | proxy hostname or IP |
| proxy_port | ssh port of proxy host |
key_path | proxy_username | account for proxy host user |
: key path of user private key | proxy_password | password for proxy host user |
| proxy_key | plain text of proxy private key |
envs | proxy_key_path | key path of proxy private key |
: 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