Skip to content

Commit a6af509

Browse files
author
HAProxy Community
committed
Update docs for dev
1 parent 5b74bda commit a6af509

3 files changed

Lines changed: 38 additions & 16 deletions

File tree

docs/dev/configuration.html

Lines changed: 30 additions & 8 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.3-dev10-56 - Configuration Manual</title>
5+
<title>HAProxy version 3.3-dev10-69 - 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" />
@@ -3745,6 +3745,8 @@
37453745

37463746
<a class="list-group-item" href="#ssl-mode-async">ssl-mode-async</a>
37473747

3748+
<a class="list-group-item" href="#ssl-passphrase-cmd">ssl-passphrase-cmd</a>
3749+
37483750
<a class="list-group-item" href="#ssl-propquery">ssl-propquery</a>
37493751

37503752
<a class="list-group-item" href="#ssl-provider">ssl-provider</a>
@@ -3891,6 +3893,8 @@
38913893

38923894
<a class="list-group-item" href="#ssl_fc_early_exporter_secret">ssl_fc_early_exporter_secret</a>
38933895

3896+
<a class="list-group-item" href="#ssl_fc_early_rcvd">ssl_fc_early_rcvd</a>
3897+
38943898
<a class="list-group-item" href="#ssl_fc_ecformats_bin">ssl_fc_ecformats_bin</a>
38953899

38963900
<a class="list-group-item" href="#ssl_fc_eclist_bin">ssl_fc_eclist_bin</a>
@@ -4683,7 +4687,7 @@
46834687
You can use <strong>left</strong> and <strong>right</strong> arrow keys to navigate between chapters.<br>
46844688
</p>
46854689
<p class="text-right">
4686-
<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/23</b></small>
4690+
<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/29</b></small>
46874691
</p>
46884692
</div>
46894693
<!-- /.sidebar -->
@@ -4694,7 +4698,7 @@
46944698
<div class="text-center">
46954699
<h1><a href="http://www.haproxy.org/" title="HAProxy"><img src="../img/HAProxyCommunityEdition_60px.png?0.4.2-15" /></a></h1>
46964700
<h2>Configuration Manual</h2>
4697-
<p><strong>version 3.3-dev10-56</strong></p>
4701+
<p><strong>version 3.3-dev10-69</strong></p>
46984702
<p>
46994703
2025/10/18<br>
47004704

@@ -8962,6 +8966,16 @@ <h2 id="chapter-3.1" data-target="3.1"><small><a class="small" href="#3.1">3.1.<
89628966
Custom DH parameters may be generated by using the OpenSSL command
89638967
&quot;openssl dhparam &lt;size&gt;&quot;, where size should be at least 2048, as 1024-bit DH
89648968
parameters should not be considered secure anymore.
8969+
</pre><a class="anchor" name="ssl-passphrase-cmd"></a><a class="anchor" name="3-ssl-passphrase-cmd"></a><a class="anchor" name="3.1-ssl-passphrase-cmd"></a><a class="anchor" name="ssl-passphrase-cmd (Global section)"></a><a class="anchor" name="ssl-passphrase-cmd (Process management and security)"></a><div class="keyword"><b><a class="anchor" name="ssl-passphrase-cmd"></a><a href="#3.1-ssl-passphrase-cmd">ssl-passphrase-cmd</a></b> <span style="color: #080">&lt;cmd&gt;</span> <span style="color: #080">&lt;args&gt;</span> ...</div><pre class="text">This settings is only available when support for OpenSSL was built in. It
8970+
allows to define a full command line that will be called when an encrypted
8971+
certificate is loaded during init. The command could be a script or any other
8972+
program. It will be provided with the encrypted private key path as first
8973+
parameter and the user-defined &quot;args&quot; parameters then and should dump the
8974+
passphrase that allows to decode the encrypted private key on the standard
8975+
output.
8976+
For every new encrypted private key loaded during init, HAProxy will first
8977+
try every other already known passphrase to decode the private key and will
8978+
ultimately call the passphrase command again if none works.
89658979
</pre><a class="anchor" name="ssl-propquery"></a><a class="anchor" name="3-ssl-propquery"></a><a class="anchor" name="3.1-ssl-propquery"></a><a class="anchor" name="ssl-propquery (Global section)"></a><a class="anchor" name="ssl-propquery (Process management and security)"></a><div class="keyword"><b><a class="anchor" name="ssl-propquery"></a><a href="#3.1-ssl-propquery">ssl-propquery</a></b> <span style="color: #080">&lt;query&gt;</span></div><pre class="text">This setting is only available when support for OpenSSL was built in and when
89668980
OpenSSL's version is at least 3.0. It allows to define a default property
89678981
string used when fetching algorithms in providers. It behave the same way as
@@ -23801,7 +23815,7 @@ <h2 id="chapter-7.1" data-target="7.1"><small><a class="small" href="#7.1">7.1.<
2380123815
that were not initially planned, or with sample fetch methods which return a
2380223816
string. The matching method also affects the way the patterns are parsed. So,
2380323817
it must not be used with sample fetches with a matching suffix (_beg, _end,
23804-
_sub...). In addition, specifying several &quot;-m&quot; pattern matching methods is now
23818+
_sub...). In addition, specifying several &quot;-m&quot; pattern matching methods is not
2380523819
allowed.
2380623820

2380723821
The &quot;-n&quot; flag forbids the dns resolutions. It is used with the load of ip files.
@@ -28233,6 +28247,13 @@ <h3 id="chapter-7.3.4" data-target="7.3.4"><small><a class="small" href="#7.3.4"
2823328247
</pre><a class="anchor" name="ssl_fc_curve"></a><a class="anchor" name="7-ssl_fc_curve"></a><a class="anchor" name="7.3.4-ssl_fc_curve"></a><a class="anchor" name="ssl_fc_curve (Using ACLs and fetching samples)"></a><a class="anchor" name="ssl_fc_curve (Fetching samples at Layer 5)"></a><div class="keyword"><b><a class="anchor" name="ssl_fc_curve"></a><a href="#7.3.4-ssl_fc_curve">ssl_fc_curve</a></b> : string</div><pre class="text">Returns the name of the curve used in the key agreement when the incoming
2823428248
connection was made over an SSL/TLS transport layer. This requires
2823528249
OpenSSL &gt;= 3.0.0.
28250+
</pre><a class="anchor" name="ssl_fc_early_rcvd"></a><a class="anchor" name="7-ssl_fc_early_rcvd"></a><a class="anchor" name="7.3.4-ssl_fc_early_rcvd"></a><a class="anchor" name="ssl_fc_early_rcvd (Using ACLs and fetching samples)"></a><a class="anchor" name="ssl_fc_early_rcvd (Fetching samples at Layer 5)"></a><div class="keyword"><b><a class="anchor" name="ssl_fc_early_rcvd"></a><a href="#7.3.4-ssl_fc_early_rcvd">ssl_fc_early_rcvd</a></b> : boolean</div><pre class="text">Returns true if early data were seen over that connection, regardless of the
28251+
fact that the handshake has since completed. It has no practical use case for
28252+
traffic processing, however it's about the only way to &quot;see&quot; that a client
28253+
used 0-RTT to send early data, and is sometimes useful when debugging, since
28254+
the only other alternatives are network traffic captures or logging the front
28255+
connection's flags and matching them in the code. It may also be useful to
28256+
get statistics on clients' capabilities. See also &quot;<a href="#ssl_fc_has_early">ssl_fc_has_early</a>&quot;.
2823628257
</pre><a class="anchor" name="ssl_fc_early_exporter_secret"></a><a class="anchor" name="7-ssl_fc_early_exporter_secret"></a><a class="anchor" name="7.3.4-ssl_fc_early_exporter_secret"></a><a class="anchor" name="ssl_fc_early_exporter_secret (Using ACLs and fetching samples)"></a><a class="anchor" name="ssl_fc_early_exporter_secret (Fetching samples at Layer 5)"></a><div class="keyword"><b><a class="anchor" name="ssl_fc_early_exporter_secret"></a><a href="#7.3.4-ssl_fc_early_exporter_secret">ssl_fc_early_exporter_secret</a></b> : string</div><pre class="text">Return the EARLY_EXPORTER_SECRET as an hexadecimal string for the
2823728258
front connection when the incoming connection was made over an TLS 1.3
2823828259
transport layer.
@@ -28325,9 +28346,10 @@ <h3 id="chapter-7.3.4" data-target="7.3.4"><small><a class="small" href="#7.3.4"
2832528346
certificate is not present in the current connection but may be retrieved
2832628347
from the cache or the ticket. So prefer &quot;<a href="#ssl_c_used">ssl_c_used</a>&quot; if you want to check if
2832728348
current SSL session uses a client certificate.
28328-
</pre><a class="anchor" name="ssl_fc_has_early"></a><a class="anchor" name="7-ssl_fc_has_early"></a><a class="anchor" name="7.3.4-ssl_fc_has_early"></a><a class="anchor" name="ssl_fc_has_early (Using ACLs and fetching samples)"></a><a class="anchor" name="ssl_fc_has_early (Fetching samples at Layer 5)"></a><div class="keyword"><b><a class="anchor" name="ssl_fc_has_early"></a><a href="#7.3.4-ssl_fc_has_early">ssl_fc_has_early</a></b> : boolean</div><pre class="text">Returns true if early data were sent, and the handshake didn't happen yet. As
28329-
it has security implications, it is useful to be able to refuse those, or
28330-
wait until the handshake happened.
28349+
</pre><a class="anchor" name="ssl_fc_has_early"></a><a class="anchor" name="7-ssl_fc_has_early"></a><a class="anchor" name="7.3.4-ssl_fc_has_early"></a><a class="anchor" name="ssl_fc_has_early (Using ACLs and fetching samples)"></a><a class="anchor" name="ssl_fc_has_early (Fetching samples at Layer 5)"></a><div class="keyword"><b><a class="anchor" name="ssl_fc_has_early"></a><a href="#7.3.4-ssl_fc_has_early">ssl_fc_has_early</a></b> : boolean</div><pre class="text">Returns true if early data were sent, and the handshake didn't complete yet.
28350+
As it has security implications, it is useful to be able to refuse those, or
28351+
wait until the handshake completes (via the &quot;<a href="#wait-for-handshake">wait-for-handshake</a>&quot; action). See
28352+
also &quot;<a href="#ssl_fc_early_rcvd">ssl_fc_early_rcvd</a>&quot;.
2833128353
</pre><a class="anchor" name="ssl_fc_has_sni"></a><a class="anchor" name="7-ssl_fc_has_sni"></a><a class="anchor" name="7.3.4-ssl_fc_has_sni"></a><a class="anchor" name="ssl_fc_has_sni (Using ACLs and fetching samples)"></a><a class="anchor" name="ssl_fc_has_sni (Fetching samples at Layer 5)"></a><div class="keyword"><b><a class="anchor" name="ssl_fc_has_sni"></a><a href="#7.3.4-ssl_fc_has_sni">ssl_fc_has_sni</a></b> : boolean</div><pre class="text">This checks for the presence of a Server Name Indication TLS extension (SNI)
2833228354
in an incoming connection was made over an SSL/TLS transport layer. Returns
2833328355
true when the incoming connection presents a TLS SNI field. This requires
@@ -33641,7 +33663,7 @@ <h2 id="chapter-12.8" data-target="12.8"><small><a class="small" href="#12.8">12
3364133663
<br>
3364233664
<hr>
3364333665
<div class="text-right">
33644-
HAProxy 3.3-dev10-56 &ndash; Configuration Manual<br>
33666+
HAProxy 3.3-dev10-69 &ndash; Configuration Manual<br>
3364533667
<small>, 2025/10/18</small>
3364633668
</div>
3364733669
</div>

docs/dev/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.3-dev10-56 - Starter Guide</title>
5+
<title>HAProxy version 3.3-dev10-69 - 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/10/23</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/29</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.3-dev10-56</strong></p>
498+
<p><strong>version 3.3-dev10-69</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.3-dev10-56 &ndash; Starter Guide<br>
2518+
HAProxy 3.3-dev10-69 &ndash; Starter Guide<br>
25192519
<small>, </small>
25202520
</div>
25212521
</div>

docs/dev/management.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.3-dev10-56 - Management Guide</title>
5+
<title>HAProxy version 3.3-dev10-69 - 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" />
@@ -668,7 +668,7 @@
668668
You can use <strong>left</strong> and <strong>right</strong> arrow keys to navigate between chapters.<br>
669669
</p>
670670
<p class="text-right">
671-
<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/23</b></small>
671+
<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/29</b></small>
672672
</p>
673673
</div>
674674
<!-- /.sidebar -->
@@ -679,7 +679,7 @@
679679
<div class="text-center">
680680
<h1><a href="http://www.haproxy.org/" title="HAProxy"><img src="../img/HAProxyCommunityEdition_60px.png?0.4.2-15" /></a></h1>
681681
<h2>Management Guide</h2>
682-
<p><strong>version 3.3-dev10-56</strong></p>
682+
<p><strong>version 3.3-dev10-69</strong></p>
683683
<p>
684684
<br>
685685

@@ -5649,7 +5649,7 @@ <h2 id="chapter-13.1" data-target="13.1"><small><a class="small" href="#13.1">13
56495649
<br>
56505650
<hr>
56515651
<div class="text-right">
5652-
HAProxy 3.3-dev10-56 &ndash; Management Guide<br>
5652+
HAProxy 3.3-dev10-69 &ndash; Management Guide<br>
56535653
<small>, </small>
56545654
</div>
56555655
</div>

0 commit comments

Comments
 (0)