diff --git a/DOCS.md b/DOCS.md index c52138b..c41cd0f 100644 --- a/DOCS.md +++ b/DOCS.md @@ -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 |