proxy.md (2191B)
1 --- 2 c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. 3 SPDX-License-Identifier: curl 4 Long: proxy 5 Short: x 6 Arg: <[protocol://]host[:port]> 7 Help: Use this proxy 8 Category: proxy 9 Added: 4.0 10 Multi: single 11 See-also: 12 - socks5 13 - proxy-basic 14 Example: 15 - --proxy http://proxy.example $URL 16 --- 17 18 # `--proxy` 19 20 Use the specified proxy. 21 22 The proxy string can be specified with a protocol:// prefix. No protocol 23 specified or http:// it is treated as an HTTP proxy. Use socks4://, 24 socks4a://, socks5:// or socks5h:// to request a specific SOCKS version to be 25 used. (Added in 7.21.7) 26 27 Unix domain sockets are supported for socks proxy. Set localhost for the host 28 part. e.g. socks5h://localhost/path/to/socket.sock 29 30 HTTPS proxy support works with the https:// protocol prefix for OpenSSL and 31 GnuTLS (added in 7.52.0). It also works for mbedTLS, Rustls, Schannel and 32 wolfSSL (added in 7.87.0). 33 34 Unrecognized and unsupported proxy protocols cause an error (added in 7.52.0). 35 Ancient curl versions ignored unknown schemes and used http:// instead. 36 37 If the port number is not specified in the proxy string, it is assumed to be 38 1080. 39 40 This option overrides existing environment variables that set the proxy to 41 use. If there is an environment variable setting a proxy, you can set proxy to 42 "" to override it. 43 44 All operations that are performed over an HTTP proxy are transparently 45 converted to HTTP. It means that certain protocol specific operations might 46 not be available. This is not the case if you can tunnel through the proxy, as 47 one with the --proxytunnel option. 48 49 User and password that might be provided in the proxy string are URL decoded 50 by curl. This allows you to pass in special characters such as @ by using %40 51 or pass in a colon with %3a. 52 53 The proxy host can be specified the same way as the proxy environment 54 variables, including the protocol prefix (http://) and the embedded user + 55 password. 56 57 When a proxy is used, the active FTP mode as set with --ftp-port, cannot be 58 used. 59 60 Doing FTP over an HTTP proxy without --proxytunnel makes curl do HTTP with an 61 FTP URL over the proxy. For such transfers, common FTP specific options do not 62 work, including --ssl-reqd and --ftp-ssl-control.