diff options
| author | Frank Lichtenheld | 2024-01-18 17:49:03 +0100 |
|---|---|---|
| committer | Gert Doering | 2024-01-18 17:58:33 +0100 |
| commit | 7b1f2009ce9670e2e0ffea0c01b1c4922a2d4369 (patch) | |
| tree | 7ba01c92e7587e042a83c4e08c03f4745c3fe940 | |
| parent | 20bc8bd5af9d1ee0489d0ee58ae9c2c2f9b0cf9f (diff) | |
| download | openvpn-7b1f2009ce9670e2e0ffea0c01b1c4922a2d4369.zip openvpn-7b1f2009ce9670e2e0ffea0c01b1c4922a2d4369.tar.gz | |
proxy-options.rst: Add proper documentation for --http-proxy-user-pass
And extend examples section for authenticated HTTP proxies because
is was misleading.
Change-Id: I7a754d0b4a76a9227bf922f65176cd9ec4d7670c
Signed-off-by: Frank Lichtenheld <frank@lichtenheld.com>
Acked-by: Gert Doering <gert@greenie.muc.de>
Message-Id: <20240118164903.22519-1-gert@greenie.muc.de>
URL: https://www.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg28083.html
Signed-off-by: Gert Doering <gert@greenie.muc.de>
(cherry picked from commit d3f84afedd33734416704d5d92e8d3ac639ef491)
| -rw-r--r-- | doc/man-sections/proxy-options.rst | 35 |
1 files changed, 32 insertions, 3 deletions
diff --git a/doc/man-sections/proxy-options.rst b/doc/man-sections/proxy-options.rst index 548d1c0..1b87033 100644 --- a/doc/man-sections/proxy-options.rst +++ b/doc/man-sections/proxy-options.rst @@ -4,7 +4,7 @@ is required, a file name to an ``authfile`` file containing a username and password on 2 lines can be given, or :code:`stdin` to prompt from console. Its content can also be specified in the config file with the - ``--http-proxy-user-pass`` option. (See section on inline files) + ``--http-proxy-user-pass`` option (See `INLINE FILE SUPPORT`_). The last optional argument is an ``auth-method`` which should be one of :code:`none`, :code:`basic`, or :code:`ntlm`. @@ -25,11 +25,40 @@ Examples: :: + # no authentication http-proxy proxy.example.net 3128 + # basic authentication, load credentials from file http-proxy proxy.example.net 3128 authfile.txt + # basic authentication, ask user for credentials http-proxy proxy.example.net 3128 stdin - http-proxy proxy.example.net 3128 auto basic - http-proxy proxy.example.net 3128 auto-nct ntlm + # NTLM authentication, load credentials from file + http-proxy proxy.example.net 3128 authfile.txt ntlm2 + # determine which authentication is required, ask user for credentials + http-proxy proxy.example.net 3128 auto + # determine which authentication is required, but reject basic + http-proxy proxy.example.net 3128 auto-nct + # determine which authentication is required, but set credentials + http-proxy proxy.example.net 3128 auto + http-proxy-user-pass authfile.txt + # basic authentication, specify credentials inline + http-proxy proxy.example.net 3128 "" basic + <http-proxy-user-pass> + username + password + </http-proxy-user-pass> + +--http-proxy-user-pass userpass + Overwrite the username/password information for ``--http-proxy``. If specified + as an inline option (see `INLINE FILE SUPPORT`_), it will be interpreted as + username/password separated by a newline. When specified on the command line + it is interpreted as a filename same as the third argument to ``--http-proxy``. + + Example:: + + <http-proxy-user-pass> + username + password + </http-proxy-user-pass> --http-proxy-option args Set extended HTTP proxy options. Requires an option ``type`` as argument |