luo980/curl
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: mention HAproxy protocol "version 1"

Browse Source 
...as there's also a version 2.

Closes #2579
This commit is contained in:
Aleks 2018-05-18 17:47:47 +02:00 committed by Daniel Stenberg
parent ccf85d4c2b
commit e05ad5dd99
No known key found for this signature in database
GPG Key ID: 5CC908FDB71E12C2
6 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/cmdline-opts/haproxy-protocol.d
View File

@ -1,9 +1,9 @@
Long: haproxy-protocol Long: haproxy-protocol
Help: Send HAProxy PROXY protocol header Help: Send HAProxy PROXY protocol v1 header
Protocols: HTTP Protocols: HTTP
Added: 7.60.0 Added: 7.60.0
--- ---
Send a HAProxy PROXY protocol header at the beginning of the connection. This Send a HAProxy PROXY protocol v1 header at the beginning of the connection. This
is used by some load balancers and reverse proxies to indicate the client's is used by some load balancers and reverse proxies to indicate the client's
true IP address and port. true IP address and port.

2
docs/libcurl/curl_easy_setopt.3
View File

@ -186,7 +186,7 @@ Socks5 GSSAPI NEC mode. See \fICURLOPT_SOCKS5_GSSAPI_NEC(3)\fP
.IP CURLOPT_PROXY_SERVICE_NAME .IP CURLOPT_PROXY_SERVICE_NAME
Proxy authentication service name. \fICURLOPT_PROXY_SERVICE_NAME(3)\fP Proxy authentication service name. \fICURLOPT_PROXY_SERVICE_NAME(3)\fP
.IP CURLOPT_HAPROXYPROTOCOL .IP CURLOPT_HAPROXYPROTOCOL
Send an HAProxy PROXY protocol header. See \fICURLOPT_HAPROXYPROTOCOL(3)\fP Send an HAProxy PROXY protocol v1 header. See \fICURLOPT_HAPROXYPROTOCOL(3)\fP
.IP CURLOPT_SERVICE_NAME .IP CURLOPT_SERVICE_NAME
Authentication service name. \fICURLOPT_SERVICE_NAME(3)\fP Authentication service name. \fICURLOPT_SERVICE_NAME(3)\fP
.IP CURLOPT_INTERFACE .IP CURLOPT_INTERFACE

8
docs/libcurl/opts/CURLOPT_HAPROXYPROTOCOL.3
View File

@ -5,7 +5,7 @@
.\" * | (__| |_| | _ <| |___ .\" * | (__| |_| | _ <| |___
.\" * \___|\___/|_| \_\_____| .\" * \___|\___/|_| \_\_____|
.\" * .\" *
.\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al. .\" * Copyright (C) 1998 - 2018, Daniel Stenberg, <daniel@haxx.se>, et al.
.\" * .\" *
.\" * This software is licensed as described in the file COPYING, which .\" * This software is licensed as described in the file COPYING, which
.\" * you should have received as part of this distribution. The terms .\" * you should have received as part of this distribution. The terms
@ -22,7 +22,7 @@
.\" .\"
.TH CURLOPT_HAPROXYPROTOCOL 3 "5 Feb 2018" "libcurl 7.60.0" "curl_easy_setopt options" .TH CURLOPT_HAPROXYPROTOCOL 3 "5 Feb 2018" "libcurl 7.60.0" "curl_easy_setopt options"
.SH NAME .SH NAME
CURLOPT_HAPROXYPROTOCOL \- send HAProxy PROXY protocol header CURLOPT_HAPROXYPROTOCOL \- send HAProxy PROXY protocol v1 header
.SH SYNOPSIS .SH SYNOPSIS
#include <curl/curl.h> #include <curl/curl.h>
@ -30,7 +30,7 @@ CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HAPROXYPROTOCOL,
long haproxy_protocol); long haproxy_protocol);
.SH DESCRIPTION .SH DESCRIPTION
A long parameter set to 1 tells the library to send an HAProxy PROXY A long parameter set to 1 tells the library to send an HAProxy PROXY
protocol header at beginning of the connection. The default action is not to protocol v1 header at beginning of the connection. The default action is not to
send this header. send this header.
This option is primarily useful when sending test requests to a service that This option is primarily useful when sending test requests to a service that
@ -38,7 +38,7 @@ expects this header.
Most applications do not need this option. Most applications do not need this option.
.SH DEFAULT .SH DEFAULT
0, do not send HAProxy PROXY protocol header 0, do not send any HAProxy PROXY protocol header
.SH PROTOCOLS .SH PROTOCOLS
HTTP HTTP
.SH EXAMPLE .SH EXAMPLE

2
lib/urldata.h
View File

@ -1676,7 +1676,7 @@ struct UserDefined {
bool stream_depends_e; /* set or don't set the Exclusive bit */ bool stream_depends_e; /* set or don't set the Exclusive bit */
int stream_weight; int stream_weight;
bool haproxyprotocol; /* whether to send HAProxy PROXY protocol header */ bool haproxyprotocol; /* whether to send HAProxy PROXY protocol v1 header */
struct Curl_http2_dep *stream_dependents; struct Curl_http2_dep *stream_dependents;

2
src/tool_cfgable.h
View File

@ -252,7 +252,7 @@ struct OperationConfig {
bool ssh_compression; /* enable/disable SSH compression */ bool ssh_compression; /* enable/disable SSH compression */
long happy_eyeballs_timeout_ms; /* happy eyeballs timeout in milliseconds. long happy_eyeballs_timeout_ms; /* happy eyeballs timeout in milliseconds.
0 is valid. default: CURL_HET_DEFAULT. */ 0 is valid. default: CURL_HET_DEFAULT. */
bool haproxy_protocol; /* whether to send HAProxy PROXY protocol */ bool haproxy_protocol; /* whether to send HAProxy PROXY protocol v1 */
struct GlobalConfig *global; struct GlobalConfig *global;
struct OperationConfig *prev; struct OperationConfig *prev;
struct OperationConfig *next; /* Always last in the struct */ struct OperationConfig *next; /* Always last in the struct */

2
src/tool_help.c
View File

@ -165,7 +165,7 @@ static const struct helptxt helptext[] = {
{"-I, --head", {"-I, --head",
"Show document info only"}, "Show document info only"},
{" --haproxy-protocol", {" --haproxy-protocol",
"Send HAProxy PROXY protocol header"}, "Send HAProxy PROXY protocol v1 header"},
{"-H, --header <header/@file>", {"-H, --header <header/@file>",
"Pass custom header(s) to server"}, "Pass custom header(s) to server"},
{"-h, --help", {"-h, --help",