From 97d2f516ff75ba53272dc935ae4ecc0977a09ae6 Mon Sep 17 00:00:00 2001 From: "yuri@FreeBSD" Date: Fri, 5 May 2023 15:48:07 -0700 Subject: [PATCH] Add practically important option descriptions to the example in README 1. nginx with the http_proxy module doesn't by default (or ever) accept CONNECT through http, so https should be used. -E is added for this. 2. Many/most users would use self-signed certificates. -z is described for this. This README change would potentially simplify the setup process for users. --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index bd2f72d..95dc5f7 100644 --- a/README.md +++ b/README.md @@ -71,14 +71,14 @@ a $HOME/.ssh/config file with the following content: ``` Host foobar ProtocolKeepAlives 30 - ProxyCommand /path/to/proxytunnel -p proxy:8080 -P username --d mybox.athome.nl:443 + ProxyCommand /path/to/proxytunnel -E -p proxy:8080 -P username -d mybox.athome.nl:443 ``` With: ``` - foobar The symbolic name of the host you want to connect to +- -E Option to use encryption to communicate to the proxy (use https) - proxy The host name of the proxy you want to connect through - 8080 The port number where the proxy software listens to - username Your proxy userid (password will be prompted) @@ -86,6 +86,11 @@ With: - 443 The port number of the SSH daemon on mybox.athome.nl ``` +Optional arguments: +``` +- -z Don't verify server SSL certificate (for example in case of self-signed certificate) +``` + If your proxy doesn't require the username and password for using it, you can skip these options. If you don't provide the password on the command-line (which is recommended) you will be prompted for it by