]> git.ipfire.org Git - thirdparty/curl.git/commitdiff
CURLOPT_PROXY.md: clarify the crendential support in proxy URLs
authorDaniel Stenberg <daniel@haxx.se>
Sun, 22 Dec 2024 21:56:52 +0000 (22:56 +0100)
committerDaniel Stenberg <daniel@haxx.se>
Mon, 23 Dec 2024 10:52:42 +0000 (11:52 +0100)
Ref: #15802
Closes #15805

docs/libcurl/opts/CURLOPT_PROXY.md

index 7c8455602452603d836258cdd942d73a98c19b08..e7c3d96ff96d738bdaac7505bd9cf2671618b321 100644 (file)
@@ -90,9 +90,6 @@ proxy. Such tunneling is activated with CURLOPT_HTTPPROXYTUNNEL(3).
 Setting the proxy string to "" (an empty string) explicitly disables the use
 of a proxy, even if there is an environment variable set for it.
 
-A proxy host string can also include protocol scheme (http://) and embedded
-user + password.
-
 Unix domain sockets are supported for socks proxies since 7.84.0. Set
 localhost for the host part. e.g. socks5h://localhost/path/to/socket.sock
 
@@ -106,6 +103,14 @@ Doing FTP over an HTTP proxy without CURLOPT_HTTPPROXYTUNNEL(3) set makes
 libcurl do HTTP with an FTP URL over the proxy. For such transfers, common FTP
 specific options do not work, for example CURLOPT_USE_SSL(3).
 
+# Authentication
+
+The proxy can also be specified with its associated credentials like for
+ordinary URLs in the style: `scheme://username:password@hostname`
+
+Alternatively, set them using CURLOPT_PROXYUSERNAME(3) and
+CURLOPT_PROXYPASSWORD(3).
+
 # Environment variables
 
 libcurl respects the proxy environment variables named **http_proxy**,