Skip to content

Commit 34650a1

Browse files
author
HAProxy Community
committed
Update docs for dev
1 parent c057659 commit 34650a1

File tree

3 files changed

+86
-40
lines changed

3 files changed

+86
-40
lines changed

docs/dev/configuration.html

Lines changed: 78 additions & 32 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-dev12-30 - Configuration Manual</title>
5+
<title>HAProxy version 3.3-dev13 - 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" />
@@ -4699,7 +4699,7 @@
46994699
You can use <strong>left</strong> and <strong>right</strong> arrow keys to navigate between chapters.<br>
47004700
</p>
47014701
<p class="text-right">
4702-
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2025/11/13</b></small>
4702+
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2025/11/14</b></small>
47034703
</p>
47044704
</div>
47054705
<!-- /.sidebar -->
@@ -4710,9 +4710,9 @@
47104710
<div class="text-center">
47114711
<h1><a href="http://www.haproxy.org/" title="HAProxy"><img src="../img/HAProxyCommunityEdition_60px.png?0.4.2-15" /></a></h1>
47124712
<h2>Configuration Manual</h2>
4713-
<p><strong>version 3.3-dev12-30</strong></p>
4713+
<p><strong>version 3.3-dev13</strong></p>
47144714
<p>
4715-
2025/11/08<br>
4715+
2025/11/14<br>
47164716

47174717
</p>
47184718
</div>
@@ -7013,33 +7013,70 @@ <h2 id="chapter-2.4" data-target="2.4"><small><a class="small" href="#2.4">2.4.<
70137013

70147014
The list of currently supported predicates is the following:
70157015

7016-
- defined(&lt;name&gt;) : returns true if an environment variable &lt;name&gt;
7017-
exists, regardless of its contents
7016+
- awslc_api_atleast(&lt;ver&gt;): returns true if the current awslc API number
7017+
is at least as recent as &lt;ver&gt; otherwise false.
7018+
</pre><div class="separator">
7019+
<span class="label label-success">Example:</span>
7020+
<pre class="prettyprint">
7021+
<div class="example-desc">awslc_api_atleast(35)</div><code></code></pre>
7022+
</div><pre class="text">- awslc_api_before(&lt;ver&gt;): returns true if the current awslc API number
7023+
is strictly older than &lt;ver&gt; otherwise false.
7024+
</pre><div class="separator">
7025+
<span class="label label-success">Example:</span>
7026+
<pre class="prettyprint">
7027+
<div class="example-desc">awslc_api_before(26)</div><code></code></pre>
7028+
</div><pre class="text">- defined(&lt;name&gt;) : returns true if an environment variable &lt;name&gt;
7029+
exists, regardless of its contents
70187030

7019-
- feature(&lt;name&gt;) : returns true if feature &lt;name&gt; is listed as present
7020-
in the features list reported by &quot;haproxy -vv&quot;
7021-
(which means a &lt;name&gt; appears after a '+')
7031+
- feature(&lt;name&gt;) : returns true if feature &lt;name&gt; is listed as present
7032+
in the features list reported by &quot;haproxy -vv&quot;
7033+
(which means a &lt;name&gt; appears after a '+')
70227034

7023-
- streq(&lt;str1&gt;,&lt;str2&gt;) : returns true only if the two strings are equal
7024-
- strneq(&lt;str1&gt;,&lt;str2&gt;) : returns true only if the two strings differ
7025-
- strstr(&lt;str1&gt;,&lt;str2&gt;) : returns true only if the second string is found in
7026-
the first one.
7035+
- openssl_version_atleast(&lt;ver&gt;) : returns true if the current openssl
7036+
version is at least as recent as &lt;ver&gt; otherwise
7037+
false.
7038+
Libraries like LibreSSL, AWS-LC and WolfSSL also
7039+
provide a pseudo OpenSSL version.
7040+
</pre><div class="separator">
7041+
<span class="label label-success">Example:</span>
7042+
<pre class="prettyprint">
7043+
<code>ssllib_name_startswith(OpenSSL) &amp;&amp; openssl_version_atleast(1.1.1)
7044+
</code></pre>
7045+
</div><pre class="text">- openssl_version_before(&lt;ver&gt;) : returns true if the current openssl
7046+
version is strictly older than &lt;ver&gt; otherwise
7047+
false.
7048+
Libraries like LibreSSL, AWS-LC and WolfSSL also
7049+
provide a pseudo OpenSSL version.
7050+
</pre><div class="separator">
7051+
<span class="label label-success">Example:</span>
7052+
<pre class="prettyprint">
7053+
<div class="example-desc">openssl_version_before(3.5.0)</div><code></code></pre>
7054+
</div><pre class="text">- ssllib_name_startswith(&lt;name&gt;) : return true if the SSL library name
7055+
HAProxy was linked with, starts with &lt;name&gt;.
7056+
</pre><div class="separator">
7057+
<span class="label label-success">Example:</span>
7058+
<pre class="prettyprint">
7059+
<div class="example-desc">ssllib_name_startswith(wolfSSL)</div><code></code></pre>
7060+
</div><pre class="text">- streq(&lt;str1&gt;,&lt;str2&gt;) : returns true only if the two strings are equal
7061+
- strneq(&lt;str1&gt;,&lt;str2&gt;) : returns true only if the two strings differ
7062+
- strstr(&lt;str1&gt;,&lt;str2&gt;) : returns true only if the second string is found in
7063+
the first one.
70277064

7028-
- version_atleast(&lt;ver&gt;): returns true if the current haproxy version is
7029-
at least as recent as &lt;ver&gt; otherwise false. The
7030-
version syntax is the same as shown by &quot;haproxy -v&quot;
7031-
and missing components are assumed as being zero.
7065+
- version_atleast(&lt;ver&gt;): returns true if the current haproxy version is
7066+
at least as recent as &lt;ver&gt; otherwise false. The
7067+
version syntax is the same as shown by &quot;haproxy -v&quot;
7068+
and missing components are assumed as being zero.
70327069

7033-
- version_before(&lt;ver&gt;) : returns true if the current haproxy version is
7034-
strictly older than &lt;ver&gt; otherwise false. The
7035-
version syntax is the same as shown by &quot;haproxy -v&quot;
7036-
and missing components are assumed as being zero.
7070+
- version_before(&lt;ver&gt;) : returns true if the current haproxy version is
7071+
strictly older than &lt;ver&gt; otherwise false. The
7072+
version syntax is the same as shown by &quot;haproxy -v&quot;
7073+
and missing components are assumed as being zero.
70377074

7038-
- enabled(&lt;opt&gt;) : returns true if the option &lt;opt&gt; is enabled at
7039-
run-time. Only a subset of options are supported:
7040-
POLL, EPOLL, KQUEUE, EVPORTS, SPLICE,
7041-
GETADDRINFO, REUSEPORT, FAST-FORWARD,
7042-
SERVER-SSL-VERIFY-NONE
7075+
- enabled(&lt;opt&gt;) : returns true if the option &lt;opt&gt; is enabled at
7076+
run-time. Only a subset of options are supported:
7077+
POLL, EPOLL, KQUEUE, EVPORTS, SPLICE,
7078+
GETADDRINFO, REUSEPORT, FAST-FORWARD,
7079+
SERVER-SSL-VERIFY-NONE
70437080
</pre><div class="separator">
70447081
<span class="label label-success">Example:</span>
70457082
<pre class="prettyprint">
@@ -22144,11 +22181,14 @@ <h2 id="chapter-5.2" data-target="5.2"><small><a class="small" href="#5.2">5.2.<
2214422181
This option permits checks to reuse idle connections if available instead of
2214522182
opening a dedicated one. The connection is reinserted in the pool on check
2214622183
completion. The main objective is to limit the number of connections opening
22147-
and closure on a specific server.
22184+
and closure on a specific server. This feature is compatible only with
22185+
http-check rulesets. It is silently ignored for other check types.
22186+
Furthermore, reuse policy should be set to aggressive on the backend as each
22187+
check attempt is performed over a dedicated session.
2214822188

22149-
Note that for configuration simplicity, this option is silently ignored if
22150-
any specific check connect option is defined, either on the server line or
22151-
via a custom tcp-check connect rule.
22189+
For configuration simplicity, this option is silently ignored if any specific
22190+
check connect option is defined, either on the server line or via a custom
22191+
tcp-check connect rule.
2215222192

2215322193
This option is automatically enabled for servers acting as passive reverse
2215422194
HTTP gateway, as for those servers connect is only supported through reuse.
@@ -22193,10 +22233,16 @@ <h2 id="chapter-5.2" data-target="5.2"><small><a class="small" href="#5.2">5.2.<
2219322233
fcgi : mode=HTTP side=BE mux=FCGI flags=HTX|HOL_RISK|NO_UPG
2219422234
h1 : mode=HTTP side=FE|BE mux=H1 flags=HTX|NO_UPG
2219522235
none : mode=TCP side=FE|BE mux=PASS flags=NO_UPG
22236+
quic : mode=HTTP side=FE|BE mux=QUIC flags=HTX|NO_UPG|FRAMED
2219622237

2219722238
Idea behind this option is to bypass the selection of the best multiplexer's
2219822239
protocol for health-check connections established to this server.
2219922240
If not defined, the server one will be used, if set.
22241+
22242+
QUIC check configuration is not fully implemented yet. First, QUIC checks may
22243+
only be performed for QUIC servers. Second, if one or more check specific
22244+
connection parameters is specified on a QUIC server, check protocol will
22245+
fallback to TCP usage.
2220022246
</pre><a class="anchor" name="check-sni-auto"></a><a class="anchor" name="5-check-sni-auto"></a><a class="anchor" name="5.2-check-sni-auto"></a><a class="anchor" name="check-sni-auto (Bind and server options)"></a><a class="anchor" name="check-sni-auto (Server and default-server options)"></a><div class="keyword"><b><a class="anchor" name="check-sni-auto"></a><a href="#5.2-check-sni-auto">check-sni-auto</a></b></div><pre class="text">May be used in the following contexts: tcp, http, log
2220122247

2220222248
This option enables the automatic SNI selection when doing health checks over
@@ -33737,8 +33783,8 @@ <h2 id="chapter-12.8" data-target="12.8"><small><a class="small" href="#12.8">12
3373733783
<br>
3373833784
<hr>
3373933785
<div class="text-right">
33740-
HAProxy 3.3-dev12-30 &ndash; Configuration Manual<br>
33741-
<small>, 2025/11/08</small>
33786+
HAProxy 3.3-dev13 &ndash; Configuration Manual<br>
33787+
<small>, 2025/11/14</small>
3374233788
</div>
3374333789
</div>
3374433790
<!-- /.col-lg-12 -->

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-dev12-30 - Starter Guide</title>
5+
<title>HAProxy version 3.3-dev13 - 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/11/13</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/11/14</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-dev12-30</strong></p>
498+
<p><strong>version 3.3-dev13</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-dev12-30 &ndash; Starter Guide<br>
2518+
HAProxy 3.3-dev13 &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-dev12-30 - Management Guide</title>
5+
<title>HAProxy version 3.3-dev13 - 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" />
@@ -680,7 +680,7 @@
680680
You can use <strong>left</strong> and <strong>right</strong> arrow keys to navigate between chapters.<br>
681681
</p>
682682
<p class="text-right">
683-
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2025/11/13</b></small>
683+
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2025/11/14</b></small>
684684
</p>
685685
</div>
686686
<!-- /.sidebar -->
@@ -691,7 +691,7 @@
691691
<div class="text-center">
692692
<h1><a href="http://www.haproxy.org/" title="HAProxy"><img src="../img/HAProxyCommunityEdition_60px.png?0.4.2-15" /></a></h1>
693693
<h2>Management Guide</h2>
694-
<p><strong>version 3.3-dev12-30</strong></p>
694+
<p><strong>version 3.3-dev13</strong></p>
695695
<p>
696696
<br>
697697

@@ -5768,7 +5768,7 @@ <h2 id="chapter-13.1" data-target="13.1"><small><a class="small" href="#13.1">13
57685768
<br>
57695769
<hr>
57705770
<div class="text-right">
5771-
HAProxy 3.3-dev12-30 &ndash; Management Guide<br>
5771+
HAProxy 3.3-dev13 &ndash; Management Guide<br>
57725772
<small>, </small>
57735773
</div>
57745774
</div>

0 commit comments

Comments
 (0)