1---
2c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
3SPDX-License-Identifier: curl
4Long: haproxy-clientip
5Arg: <ip>
6Help: Set address in HAProxy PROXY
7Protocols: HTTP
8Added: 8.2.0
9Category: http proxy
10Multi: single
11See-also:
12  - proxy
13Example:
14  - --haproxy-clientip $IP
15---
16
17# `--haproxy-clientip`
18
19Sets a client IP in HAProxy PROXY protocol v1 header at the beginning of the
20connection.
21
22For valid requests, IPv4 addresses must be indicated as a series of exactly
234 integers in the range [0..255] inclusive written in decimal representation
24separated by exactly one dot between each other. Heading zeroes are not
25permitted in front of numbers in order to avoid any possible confusion
26with octal numbers. IPv6 addresses must be indicated as series of 4 hexadecimal
27digits (upper or lower case) delimited by colons between each other, with the
28acceptance of one double colon sequence to replace the largest acceptable range
29of consecutive zeroes. The total number of decoded bits must exactly be 128.
30
31Otherwise, any string can be accepted for the client IP and get sent.
32
33It replaces --haproxy-protocol if used, it is not necessary to specify both flags.
34