From ad9a378b7f4bbcd1987e09397c03ce91e770d162 Mon Sep 17 00:00:00 2001 From: appleboy Date: Mon, 28 Oct 2024 22:38:25 +0800 Subject: [PATCH] docs(readme): enhance IP protocol configuration options - Add protocol option description for IP protocol usage in the main configuration - Add proxy_protocol option description for IP protocol usage in the SSH Proxy Setting Signed-off-by: appleboy --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index eec6d6b..b510a2d 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,7 @@ See the [action.yml](./action.yml) file for more detail information. * username - scp username * password - scp password * passphrase - the passphrase is usually to encrypt the private key +* protocol - The IP protocol to use. Valid values are `tcp`. `tcp4` or `tcp6`. Default to `tcp`. * fingerprint - fingerprint SHA256 of the host public key, default is to skip verification * timeout - timeout for ssh to remote host, default is `30s` * command_timeout - timeout for scp command, default is `10m` @@ -61,6 +62,7 @@ SSH Proxy Setting: * proxy_port - proxy port, default is `22` * proxy_username - proxy username * proxy_password - proxy password +* proxy_protocol - The IP protocol to use. Valid values are `tcp`. `tcp4` or `tcp6`. Default to `tcp`. * proxy_passphrase - the passphrase is usually to encrypt the private key * proxy_timeout - timeout for ssh to proxy host, default is `30s` * proxy_key - content of ssh proxy private key.