Skip to content

Commit 11cddaf

Browse files
author
HAProxy Community
committed
Update docs for 3.1
1 parent b36fc23 commit 11cddaf

3 files changed

Lines changed: 54 additions & 18 deletions

File tree

‎docs/3.1/configuration.html‎

Lines changed: 22 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<html lang="en">
33
<head>
44
<meta charset="utf-8" />
5-
<title>HAProxy version 3.1.8-86 - Configuration Manual</title>
5+
<title>HAProxy version 3.1.8-145 - Configuration Manual</title>
66
<link href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet" />
77
<link href="https://raw.githubusercontent.com/thomaspark/bootswatch/v3.3.7/cerulean/bootstrap.min.css" rel="stylesheet" />
88
<link href="../css/page.css?0.4.2-15" rel="stylesheet" />
@@ -3646,6 +3646,8 @@
36463646

36473647
<a class="list-group-item" href="#ssl_bc_session_key">ssl_bc_session_key</a>
36483648

3649+
<a class="list-group-item" href="#ssl_bc_sni">ssl_bc_sni</a>
3650+
36493651
<a class="list-group-item" href="#ssl_bc_unique_id">ssl_bc_unique_id</a>
36503652

36513653
<a class="list-group-item" href="#ssl_bc_use_keysize">ssl_bc_use_keysize</a>
@@ -4430,7 +4432,7 @@
44304432
You can use <strong>left</strong> and <strong>right</strong> arrow keys to navigate between chapters.<br>
44314433
</p>
44324434
<p class="text-right">
4433-
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2025/08/26</b></small>
4435+
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2025/10/01</b></small>
44344436
</p>
44354437
</div>
44364438
<!-- /.sidebar -->
@@ -4441,7 +4443,7 @@
44414443
<div class="text-center">
44424444
<h1><a href="http://www.haproxy.org/" title="HAProxy"><img src="../img/HAProxyCommunityEdition_60px.png?0.4.2-15" /></a></h1>
44434445
<h2>Configuration Manual</h2>
4444-
<p><strong>version 3.1.8-86</strong></p>
4446+
<p><strong>version 3.1.8-145</strong></p>
44454447
<p>
44464448
2025/06/02<br>
44474449

@@ -6806,8 +6808,8 @@ <h2 id="chapter-2.4" data-target="2.4"><small><a class="small" href="#2.4">2.4.<
68066808
- .warning &quot;message&quot; : emit this message at level WARNING
68076809
- .alert &quot;message&quot; : emit this message at level ALERT
68086810

6809-
Messages emitted at level WARNING may cause the process to fail to start if the
6810-
&quot;<a href="#strict-mode">strict-mode</a>&quot; is enabled. Messages emitted at level ALERT will always cause a
6811+
Messages emitted at level WARNING may cause the process to fail to start if
6812+
&quot;<a href="#zero-warning">zero-warning</a>&quot; is enabled. Messages emitted at level ALERT will always cause a
68116813
fatal error. These can be used to detect some inappropriate conditions and
68126814
provide advice to the user.
68136815
</pre><div class="separator">
@@ -27181,6 +27183,7 @@ <h3 id="chapter-7.3.4" data-target="7.3.4"><small><a class="small" href="#7.3.4"
2718127183
<tr><td ><a href="#7-ssl_bc_server_random">ssl_bc_server_random</a></td><td >binary</td></tr>
2718227184
<tr><td ><a href="#7-ssl_bc_session_id">ssl_bc_session_id</a></td><td >binary</td></tr>
2718327185
<tr><td ><a href="#7-ssl_bc_session_key">ssl_bc_session_key</a></td><td >binary</td></tr>
27186+
<tr><td ><a href="#7-ssl_bc_sni">ssl_bc_sni</a></td><td >string</td></tr>
2718427187
<tr><td ><a href="#7-ssl_bc_use_keysize">ssl_bc_use_keysize</a></td><td >integer</td></tr>
2718527188
<tr><td ><a href="#7-ssl_c_ca_err">ssl_c_ca_err</a></td><td >integer</td></tr>
2718627189
<tr><td ><a href="#7-ssl_c_ca_err_depth">ssl_c_ca_err_depth</a></td><td >integer</td></tr>
@@ -27189,8 +27192,8 @@ <h3 id="chapter-7.3.4" data-target="7.3.4"><small><a class="small" href="#7.3.4"
2718927192
<tr><td ><a href="#7-ssl_c_err">ssl_c_err</a></td><td >integer</td></tr>
2719027193
<tr><td ><a href="#7-ssl_c_i_dn">ssl_c_i_dn([&lt;entry&gt;[,&lt;occ&gt;[,&lt;format&gt;]]])</a></td><td >string</td></tr>
2719127194
<tr><td ><a href="#7-ssl_c_key_alg">ssl_c_key_alg</a></td><td >string</td></tr>
27192-
<tr><td ><a href="#7-ssl_c_notafter">ssl_c_notafter</a></td><td >string</td></tr>
2719327195
<thead><tr><th>keyword</th><th>output type</th></tr></thead>
27196+
<tr><td ><a href="#7-ssl_c_notafter">ssl_c_notafter</a></td><td >string</td></tr>
2719427197
<tr><td ><a href="#7-ssl_c_notbefore">ssl_c_notbefore</a></td><td >string</td></tr>
2719527198
<tr><td ><a href="#7-ssl_c_r_dn">ssl_c_r_dn([&lt;entry&gt;[,&lt;occ&gt;[,&lt;format&gt;]]])</a></td><td >string</td></tr>
2719627199
<tr><td ><a href="#7-ssl_c_s_dn">ssl_c_s_dn([&lt;entry&gt;[,&lt;occ&gt;[,&lt;format&gt;]]])</a></td><td >string</td></tr>
@@ -27210,8 +27213,8 @@ <h3 id="chapter-7.3.4" data-target="7.3.4"><small><a class="small" href="#7.3.4"
2721027213
<tr><td ><a href="#7-ssl_f_serial">ssl_f_serial</a></td><td >binary</td></tr>
2721127214
<tr><td ><a href="#7-ssl_f_sha1">ssl_f_sha1</a></td><td >binary</td></tr>
2721227215
<tr><td ><a href="#7-ssl_f_sig_alg">ssl_f_sig_alg</a></td><td >string</td></tr>
27213-
<tr><td ><a href="#7-ssl_f_version">ssl_f_version</a></td><td >integer</td></tr>
2721427216
<thead><tr><th>keyword</th><th>output type</th></tr></thead>
27217+
<tr><td ><a href="#7-ssl_f_version">ssl_f_version</a></td><td >integer</td></tr>
2721527218
<tr><td ><a href="#7-ssl_fc">ssl_fc</a></td><td >boolean</td></tr>
2721627219
<tr><td ><a href="#7-ssl_fc_alg_keysize">ssl_fc_alg_keysize</a></td><td >integer</td></tr>
2721727220
<tr><td ><a href="#7-ssl_fc_alpn">ssl_fc_alpn</a></td><td >string</td></tr>
@@ -27231,8 +27234,8 @@ <h3 id="chapter-7.3.4" data-target="7.3.4"><small><a class="small" href="#7.3.4"
2723127234
<tr><td ><a href="#7-ssl_fc_exporter_secret">ssl_fc_exporter_secret</a></td><td >string</td></tr>
2723227235
<tr><td ><a href="#7-ssl_fc_early_exporter_secret">ssl_fc_early_exporter_secret</a></td><td >string</td></tr>
2723327236
<tr><td ><a href="#7-ssl_fc_err">ssl_fc_err</a></td><td >integer</td></tr>
27234-
<tr><td ><a href="#7-ssl_fc_err_str">ssl_fc_err_str</a></td><td >string</td></tr>
2723527237
<thead><tr><th>keyword</th><th>output type</th></tr></thead>
27238+
<tr><td ><a href="#7-ssl_fc_err_str">ssl_fc_err_str</a></td><td >string</td></tr>
2723627239
<tr><td ><a href="#7-ssl_fc_has_crt">ssl_fc_has_crt</a></td><td >boolean</td></tr>
2723727240
<tr><td ><a href="#7-ssl_fc_has_early">ssl_fc_has_early</a></td><td >boolean</td></tr>
2723827241
<tr><td ><a href="#7-ssl_fc_has_sni">ssl_fc_has_sni</a></td><td >boolean</td></tr>
@@ -27252,8 +27255,8 @@ <h3 id="chapter-7.3.4" data-target="7.3.4"><small><a class="small" href="#7.3.4"
2725227255
<tr><td ><a href="#7-ssl_fc_use_keysize">ssl_fc_use_keysize</a></td><td >integer</td></tr>
2725327256
<tr><td ><a href="#7-ssl_s_der">ssl_s_der</a></td><td >binary</td></tr>
2725427257
<tr><td ><a href="#7-ssl_s_chain_der">ssl_s_chain_der</a></td><td >binary</td></tr>
27255-
<tr><td ><a href="#7-ssl_s_key_alg">ssl_s_key_alg</a></td><td >string</td></tr>
2725627258
<thead><tr><th>keyword</th><th>output type</th></tr></thead>
27259+
<tr><td ><a href="#7-ssl_s_key_alg">ssl_s_key_alg</a></td><td >string</td></tr>
2725727260
<tr><td ><a href="#7-ssl_s_notafter">ssl_s_notafter</a></td><td >string</td></tr>
2725827261
<tr><td ><a href="#7-ssl_s_notbefore">ssl_s_notbefore</a></td><td >string</td></tr>
2725927262
<tr><td ><a href="#7-ssl_s_i_dn">ssl_s_i_dn([&lt;entry&gt;[,&lt;occ&gt;[,&lt;format&gt;]]])</a></td><td >string</td></tr>
@@ -27458,6 +27461,11 @@ <h3 id="chapter-7.3.4" data-target="7.3.4"><small><a class="small" href="#7.3.4"
2745827461
connection was made over an SSL/TLS transport layer. It is useful to decrypt
2745927462
traffic sent using ephemeral ciphers. This requires OpenSSL &gt;= 1.1.0, or
2746027463
BoringSSL. It can be used in a tcp-check or an http-check ruleset.
27464+
</pre><a class="anchor" name="ssl_bc_sni"></a><a class="anchor" name="7-ssl_bc_sni"></a><a class="anchor" name="7.3.4-ssl_bc_sni"></a><a class="anchor" name="ssl_bc_sni (Using ACLs and fetching samples)"></a><a class="anchor" name="ssl_bc_sni (Fetching samples at Layer 5)"></a><div class="keyword"><b><a class="anchor" name="ssl_bc_sni"></a><a href="#7.3.4-ssl_bc_sni">ssl_bc_sni</a></b> : string</div><pre class="text">This retrieves the Server Name Indication TLS extension (SNI) field that was
27465+
used on the connection to the server. The result (when present) typically is
27466+
a string matching the HTTPS host name (253 chars or less). The main use case
27467+
is for logging and debugging purposes (e.g. figure what SNI was used when the
27468+
connection was established to match it against what the server has seen).
2746127469
</pre><a class="anchor" name="ssl_bc_use_keysize"></a><a class="anchor" name="7-ssl_bc_use_keysize"></a><a class="anchor" name="7.3.4-ssl_bc_use_keysize"></a><a class="anchor" name="ssl_bc_use_keysize (Using ACLs and fetching samples)"></a><a class="anchor" name="ssl_bc_use_keysize (Fetching samples at Layer 5)"></a><div class="keyword"><b><a class="anchor" name="ssl_bc_use_keysize"></a><a href="#7.3.4-ssl_bc_use_keysize">ssl_bc_use_keysize</a></b> : integer</div><pre class="text">Returns the symmetric cipher key size used in bits when the outgoing
2746227470
connection was made over an SSL/TLS transport layer. It can be used in a
2746327471
tcp-check or an http-check ruleset.
@@ -31688,6 +31696,10 @@ <h2 id="chapter-11.1" data-target="11.1"><small><a class="small" href="#11.1">11
3168831696
the FD from the unix socket and uses it as if it were the FD
3168931697
of an accept(). Should be used carefully.
3169031698

31699+
Bugs: This protocol is known to be unreliable on macOS because
31700+
of an issue in the macOS sendmsg(2) implementation. The
31701+
connection might not be accepted correctly.
31702+
3169131703
'unix@&lt;path&gt;' following string is considered as a UNIX socket &lt;path&gt;. this
3169231704
prefix is useful to declare an UNIX socket path which don't
3169331705
start by slash '/'.
@@ -31818,7 +31830,7 @@ <h2 id="chapter-11.3" data-target="11.3"><small><a class="small" href="#11.3">11
3181831830
<br>
3181931831
<hr>
3182031832
<div class="text-right">
31821-
HAProxy 3.1.8-86 &ndash; Configuration Manual<br>
31833+
HAProxy 3.1.8-145 &ndash; Configuration Manual<br>
3182231834
<small>, 2025/06/02</small>
3182331835
</div>
3182431836
</div>

‎docs/3.1/intro.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<html lang="en">
33
<head>
44
<meta charset="utf-8" />
5-
<title>HAProxy version 3.1.8-86 - Starter Guide</title>
5+
<title>HAProxy version 3.1.8-145 - Starter Guide</title>
66
<link href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet" />
77
<link href="https://raw.githubusercontent.com/thomaspark/bootswatch/v3.3.7/cerulean/bootstrap.min.css" rel="stylesheet" />
88
<link href="../css/page.css?0.4.2-15" rel="stylesheet" />
@@ -484,7 +484,7 @@
484484
You can use <strong>left</strong> and <strong>right</strong> arrow keys to navigate between chapters.<br>
485485
</p>
486486
<p class="text-right">
487-
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2025/08/26</b></small>
487+
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2025/10/01</b></small>
488488
</p>
489489
</div>
490490
<!-- /.sidebar -->
@@ -495,7 +495,7 @@
495495
<div class="text-center">
496496
<h1><a href="http://www.haproxy.org/" title="HAProxy"><img src="../img/HAProxyCommunityEdition_60px.png?0.4.2-15" /></a></h1>
497497
<h2>Starter Guide</h2>
498-
<p><strong>version 3.1.8-86</strong></p>
498+
<p><strong>version 3.1.8-145</strong></p>
499499
<p>
500500
<br>
501501

@@ -2515,7 +2515,7 @@ <h2 id="chapter-4.4" data-target="4.4"><small><a class="small" href="#4.4">4.4.<
25152515
<br>
25162516
<hr>
25172517
<div class="text-right">
2518-
HAProxy 3.1.8-86 &ndash; Starter Guide<br>
2518+
HAProxy 3.1.8-145 &ndash; Starter Guide<br>
25192519
<small>, </small>
25202520
</div>
25212521
</div>

‎docs/3.1/management.html‎

Lines changed: 28 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<html lang="en">
33
<head>
44
<meta charset="utf-8" />
5-
<title>HAProxy version 3.1.8-86 - Management Guide</title>
5+
<title>HAProxy version 3.1.8-145 - Management Guide</title>
66
<link href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet" />
77
<link href="https://raw.githubusercontent.com/thomaspark/bootswatch/v3.3.7/cerulean/bootstrap.min.css" rel="stylesheet" />
88
<link href="../css/page.css?0.4.2-15" rel="stylesheet" />
@@ -652,7 +652,7 @@
652652
You can use <strong>left</strong> and <strong>right</strong> arrow keys to navigate between chapters.<br>
653653
</p>
654654
<p class="text-right">
655-
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2025/08/26</b></small>
655+
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2025/10/01</b></small>
656656
</p>
657657
</div>
658658
<!-- /.sidebar -->
@@ -663,7 +663,7 @@
663663
<div class="text-center">
664664
<h1><a href="http://www.haproxy.org/" title="HAProxy"><img src="../img/HAProxyCommunityEdition_60px.png?0.4.2-15" /></a></h1>
665665
<h2>Management Guide</h2>
666-
<p><strong>version 3.1.8-86</strong></p>
666+
<p><strong>version 3.1.8-145</strong></p>
667667
<p>
668668
<br>
669669

@@ -2139,6 +2139,25 @@ <h2 id="chapter-9.1" data-target="9.1"><small><a class="small" href="#9.1">9.1.<
21392139
97. used_conn_cur [...S]: current number of connections in use
21402140
98. need_conn_est [...S]: estimated needed number of connections
21412141
99. uweight [..BS]: total user weight (backend), server user weight (server)
2142+
100. agg_server_status [..B.]: backend aggregated gauge of server's status
2143+
101. agg_server_status_check [..B.]: (deprecated)
2144+
102. agg_check_status [..B.]: backend aggregated gauge of server's state check
2145+
status
2146+
103. srid [...S]: server id revision
2147+
104. sess_other [.F..]: total number of sessions other than HTTP since process
2148+
started
2149+
105. h1_sess [.F..]: total number of HTTP/1 sessions since process started
2150+
106. h2_sess [.F..]: total number of HTTP/2 sessions since process started
2151+
107. h3_sess [.F..]: total number of HTTP/3 sessions since process started
2152+
108. req_other [.F..]: total number of sessions other than HTTP processed by
2153+
this object since the worker process started
2154+
109. h1req [.F..]: total number of HTTP/1 sessions processed by this object
2155+
since the worker process started
2156+
110. h2req [.F..]: total number of hTTP/2 sessions processed by this object
2157+
since the worker process started
2158+
111. h3req [.F..]: total number of HTTP/3 sessions processed by this object
2159+
since the worker process started
2160+
112. proto [L...]: protocol
21422161

21432162
For all other statistics domains, the presence or the order of the fields are
21442163
not guaranteed. In this case, the header line should always be used to parse
@@ -4836,6 +4855,11 @@ <h3 id="chapter-9.4.1" data-target="9.4.1"><small><a class="small" href="#9.4.1"
48364855
point and a PID. (e.g. @1 or @!1271). A @ alone could be use to specify the
48374856
master. Leaving processes are only accessible with the PID as relative process
48384857
number are only usable with the current processes.
4858+
4859+
Bugs: the sockpair@ protocol used to implement communication between the
4860+
master and the worker is known to not be reliable on macOS because of an
4861+
issue in the macOS sendmsg(2) implementation. A command might end up without
4862+
response because of that.
48394863
</pre><div class="separator">
48404864
<span class="label label-success">Examples:</span>
48414865
<pre class="prettyprint">
@@ -5411,7 +5435,7 @@ <h2 id="chapter-13.1" data-target="13.1"><small><a class="small" href="#13.1">13
54115435
<br>
54125436
<hr>
54135437
<div class="text-right">
5414-
HAProxy 3.1.8-86 &ndash; Management Guide<br>
5438+
HAProxy 3.1.8-145 &ndash; Management Guide<br>
54155439
<small>, </small>
54165440
</div>
54175441
</div>

0 commit comments

Comments
 (0)