Skip to content

Commit

Permalink
docs(plugins): fix default SSH command timeout (#440)
Browse files Browse the repository at this point in the history
Signed-off-by: William Poussier <william.poussier@gmail.com>
  • Loading branch information
wI2L authored May 2, 2023
1 parent 25b0cea commit 0c55dbf
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion pkg/plugins/builtin/ssh/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The step will be considered successful if the script returns exit code 0, otherw
| `ssh_key` | private ssh key, preferably retrieved from {{.config}} |
| `ssh_key_passphrase` | passphrase for the key, if any |
| `exit_codes_unrecoverable` | a list of non-zero exit codes (1, 2, 3, ...) or ranges (1-10, ...) which should be considered unrecoverable and halt execution ; these will be returned to the main engine as a `CLIENT_ERROR` |
| `timeout` | defines the maximum duration of the SSH session (connection time not included). Default to `3600s` (5 minutes). |
| `timeout` | defines the maximum duration of the SSH session (connection time not included). Default to `5m`. |

## Example

Expand Down

0 comments on commit 0c55dbf

Please sign in to comment.