Skip to content

Commit b33cc6c

Browse files
author
HAProxy Community
committed
Update docs for dev
1 parent 784e1cb commit b33cc6c

3 files changed

Lines changed: 66 additions & 21 deletions

File tree

docs/dev/configuration.html

Lines changed: 48 additions & 13 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.5-dev2-2 - Configuration Manual</title>
5+
<title>HAProxy version 3.5-dev2-34 - 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" />
@@ -1908,6 +1908,8 @@
19081908

19091909
<a class="list-group-item" href="#early-hint">early-hint</a>
19101910

1911+
<a class="list-group-item" href="#early-hints">early-hints</a>
1912+
19111913
<a class="list-group-item" href="#ecdhe">ecdhe</a>
19121914

19131915
<a class="list-group-item" href="#ech">ech</a>
@@ -4890,7 +4892,7 @@
48904892
You can use <strong>left</strong> and <strong>right</strong> arrow keys to navigate between chapters.<br>
48914893
</p>
48924894
<p class="text-right">
4893-
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2026/07/08</b></small>
4895+
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2026/07/10</b></small>
48944896
</p>
48954897
</div>
48964898
<!-- /.sidebar -->
@@ -4901,7 +4903,7 @@
49014903
<div class="text-center">
49024904
<h1><a href="http://www.haproxy.org/" title="HAProxy"><img src="../img/HAProxyCommunityEdition_60px.png?0.4.2-15" /></a></h1>
49034905
<h2>Configuration Manual</h2>
4904-
<p><strong>version 3.5-dev2-2</strong></p>
4906+
<p><strong>version 3.5-dev2-34</strong></p>
49054907
<p>
49064908
2026/07/08<br>
49074909

@@ -17704,7 +17706,9 @@ <h2 id="chapter-4.2" data-target="4.2"><small><a class="small" href="#4.2">4.2.<
1770417706
matched.
1770517707

1770617708
The admin level allows to enable/disable servers from the web interface. By
17707-
default, statistics page is read-only for security reasons.
17709+
default, statistics page is read-only for security reasons. If &quot;<a href="#stats%20scope">stats scope</a>&quot;
17710+
directives are set in the section, then only proxies designated by these
17711+
directives will accept state changes; access to other ones will be denied.
1770817712

1770917713
Currently, the POST request is limited to the buffer size minus the reserved
1771017714
buffer space, which means that if the list of servers is too long, the
@@ -17744,7 +17748,7 @@ <h2 id="chapter-4.2" data-target="4.2"><small><a class="small" href="#4.2">4.2.<
1774417748
stats http-request auth unless AUTH
1774517749
stats admin if AUTH_ADMIN
1774617750
</code></pre>
17747-
</div><div class="page-header"><b>See also :</b> &quot;<a href="#stats%20enable">stats enable</a>&quot;, &quot;<a href="#stats%20auth">stats auth</a>&quot;, &quot;<a href="#stats%20http-request">stats http-request</a>&quot;, <a href="#12.2">section 12.2</a> about userlists and <a href="#7">section 7</a> about ACL usage.</div>
17751+
</div><div class="page-header"><b>See also :</b> &quot;<a href="#stats%20enable">stats enable</a>&quot;, &quot;<a href="#stats%20auth">stats auth</a>&quot;, &quot;<a href="#stats%20http-request">stats http-request</a>&quot;, &quot;<a href="#stats%20scope">stats scope</a>&quot;, <a href="#12.2">section 12.2</a> about userlists and <a href="#7">section 7</a> about ACL usage.</div>
1774817752
<a class="anchor" name="ssl-f-use"></a><a class="anchor" name="4-ssl-f-use"></a><a class="anchor" name="4.2-ssl-f-use"></a><a class="anchor" name="ssl-f-use (Proxies)"></a><a class="anchor" name="ssl-f-use (Alphabetically sorted keywords reference)"></a><div class="keyword"><b><a class="anchor" name="ssl-f-use"></a><a href="#4.2-ssl-f-use">ssl-f-use</a></b> <span style="color: #008">[<span style="color: #080">&lt;sslbindconf&gt;</span> ...]</span>*</div><pre class="text">Assignate a certificate to the current frontend.
1774917753

1775017754
May be used in the following contexts: tcp, http
@@ -18054,11 +18058,11 @@ <h2 id="chapter-4.2" data-target="4.2"><small><a class="small" href="#4.2">4.2.<
1805418058
section in which the statement appears.</pre>
1805518059
</div>
1805618060
<pre class="text">When this statement is specified, only the sections enumerated with this
18057-
statement will appear in the report. All other ones will be hidden. This
18058-
statement may appear as many times as needed if multiple sections need to be
18059-
reported. Please note that the name checking is performed as simple string
18060-
comparisons, and that it is never checked that a give section name really
18061-
exists.
18061+
statement will appear in the report. All other ones will be hidden, and
18062+
attempts to change their state in admin mode will be rejected. This statement
18063+
may appear as many times as needed if multiple sections need to be reported.
18064+
Please note that the name checking is performed as simple string comparisons,
18065+
and that it is never checked that a give section name really exists.
1806218066

1806318067
Though this statement alone is enough to enable statistics reporting, it is
1806418068
recommended to set all other settings in order to avoid relying on default
@@ -18083,7 +18087,7 @@ <h2 id="chapter-4.2" data-target="4.2"><small><a class="small" href="#4.2">4.2.<
1808318087
stats uri /admin?stats
1808418088
stats refresh 5s
1808518089
</code></pre>
18086-
</div><div class="page-header"><b>See also :</b> &quot;<a href="#stats%20auth">stats auth</a>&quot;, &quot;<a href="#stats%20enable">stats enable</a>&quot;, &quot;<a href="#stats%20realm">stats realm</a>&quot;, &quot;<a href="#stats%20uri">stats uri</a>&quot;</div>
18090+
</div><div class="page-header"><b>See also :</b> &quot;<a href="#stats%20auth">stats auth</a>&quot;, &quot;<a href="#stats%20enable">stats enable</a>&quot;, &quot;<a href="#stats%20realm">stats realm</a>&quot;, &quot;<a href="#stats%20uri">stats uri</a>&quot; and &quot;<a href="#stats%20admin">stats admin</a>&quot;</div>
1808718091
<a class="anchor" name="stats"></a><a class="anchor" name="4-stats"></a><a class="anchor" name="4.2-stats"></a><a class="anchor" name="stats (Proxies)"></a><a class="anchor" name="stats (Alphabetically sorted keywords reference)"></a><a class="anchor" name="stats show-desc"></a><a class="anchor" name="4-stats show-desc"></a><a class="anchor" name="4.2-stats show-desc"></a><a class="anchor" name="stats show-desc (Proxies)"></a><a class="anchor" name="stats show-desc (Alphabetically sorted keywords reference)"></a><div class="keyword"><b><a class="anchor" name="stats show-desc"></a><a href="#4.2-stats%20show-desc">stats show-desc</a></b> <span style="color: #008">[ <span style="color: #080">&lt;desc&gt;</span> ]</span></div><pre class="text">Enable reporting of a description on the statistics page.
1808818092

1808918093
May be used in the following contexts: http
@@ -20200,7 +20204,7 @@ <h2 id="chapter-4.4" data-target="4.4"><small><a class="small" href="#4.4">4.4.<
2020020204
is responsible for the setup of the cache storage filter.
2020120205

2020220206
See <a href="#6.2">section 6.2</a> about cache setup.
20203-
</pre><a class="anchor" name="cache-use"></a><a class="anchor" name="4-cache-use"></a><a class="anchor" name="4.4-cache-use"></a><a class="anchor" name="cache-use (Proxies)"></a><a class="anchor" name="cache-use (Alphabetically sorted actions reference)"></a><div class="keyword"><b><a class="anchor" name="cache-use"></a><a href="#4.4-cache-use">cache-use</a></b> <span style="color: #080">&lt;name&gt;</span></div><div><p> Usable in :</p><table class="table table-bordered" border="0" cellspacing="0" cellpadding="0">
20207+
</pre><a class="anchor" name="cache-use"></a><a class="anchor" name="4-cache-use"></a><a class="anchor" name="4.4-cache-use"></a><a class="anchor" name="cache-use (Proxies)"></a><a class="anchor" name="cache-use (Alphabetically sorted actions reference)"></a><div class="keyword"><b><a class="anchor" name="cache-use"></a><a href="#4.4-cache-use">cache-use</a></b> <span style="color: #080">&lt;name&gt;</span> <span style="color: #008">[no-early-hints]</span></div><div><p> Usable in :</p><table class="table table-bordered" border="0" cellspacing="0" cellpadding="0">
2020420208
<thead><tr><th>QUIC Ini</th><th>TCP RqCon</th><th>RqSes</th><th>RqCnt</th><th>RsCnt</th><th>HTTP Req</th><th>Res</th><th>Aft</th></tr></thead>
2020520209
<tr><td class="pagination-centered">&nbsp;</td><td class="pagination-centered">&nbsp;</td><td class="pagination-centered">&nbsp;</td><td class="pagination-centered">&nbsp;</td><td class="pagination-centered">&nbsp;</td><td class="pagination-centered"><img src="../css/check.png" alt="X" title="yes" /></td><td class="pagination-centered">&nbsp;</td><td class="pagination-centered">&nbsp;</td></tr>
2020620210
</table></div>
@@ -20209,6 +20213,12 @@ <h2 id="chapter-4.4" data-target="4.4"><small><a class="small" href="#4.4">4.4.<
2020920213
use a condition for both storage and delivering that's a good idea to put it
2021020214
after this one.
2021120215

20216+
When the named cache has &quot;<a href="#early-hints">early-hints</a>&quot; enabled, lookups handled by this
20217+
rule may emit a 103 Early Hints response if the requested URL has known
20218+
&quot;Link&quot; hints in the cache. The optional &quot;no-early-hints&quot; keyword
20219+
suppresses 103 emission for requests handled by this rule, regardless of
20220+
the cache-level setting.
20221+
2021220222
See <a href="#6.2">section 6.2</a> about cache setup.
2021320223
</pre><a class="anchor" name="capture"></a><a class="anchor" name="4-capture"></a><a class="anchor" name="4.4-capture"></a><a class="anchor" name="capture (Proxies)"></a><a class="anchor" name="capture (Alphabetically sorted actions reference)"></a><div class="keyword"><b><a class="anchor" name="capture"></a><a href="#4.4-capture">capture</a></b> <span style="color: #080">&lt;sample&gt;</span> <span style="color: #008">[ len <span style="color: #080">&lt;length&gt;</span> | id <span style="color: #080">&lt;id&gt;</span> ]</span></div><div><p> Usable in :</p><table class="table table-bordered" border="0" cellspacing="0" cellpadding="0">
2021420224
<thead><tr><th>QUIC Ini</th><th>TCP RqCon</th><th>RqSes</th><th>RqCnt</th><th>RsCnt</th><th>HTTP Req</th><th>Res</th><th>Aft</th></tr></thead>
@@ -24502,6 +24512,31 @@ <h2 id="chapter-6.2" data-target="6.2"><small><a class="small" href="#6.2">6.2.<
2450224512
<h3 id="chapter-6.2.1" data-target="6.2.1"><small><a class="small" href="#6.2.1">6.2.1.</a></small> Cache section</h3>
2450324513
<div><a class="anchor" name="cache"></a><a class="anchor" name="6-cache"></a><a class="anchor" name="6.2.1-cache"></a><a class="anchor" name="cache (Cache)"></a><a class="anchor" name="cache (Cache section)"></a><div class="keyword"><b><a class="anchor" name="cache"></a><a href="#6.2.1-cache">cache</a></b> <span style="color: #080">&lt;name&gt;</span></div><pre class="text">Declare a cache section, allocate a shared cache memory named &lt;name&gt;, the
2450424514
size of cache is mandatory (see keyword &quot;<a href="#total-max-size">total-max-size</a>&quot; below).
24515+
</pre><a class="anchor" name="early-hints"></a><a class="anchor" name="6-early-hints"></a><a class="anchor" name="6.2.1-early-hints"></a><a class="anchor" name="early-hints (Cache)"></a><a class="anchor" name="early-hints (Cache section)"></a><div class="keyword"><b><a class="anchor" name="early-hints"></a><a href="#6.2.1-early-hints">early-hints</a></b> <span style="color: #080">&lt;on/off/only&gt;</span> <span style="color: #008">[ratio <span style="color: #080">&lt;integer&gt;</span>]</span></div><pre class="text">Enable or disable support for HTTP 103 Early Hints responses (see RFC 8297).
24516+
When enabled, the cache remembers relevant &quot;Link&quot; response headers (with a
24517+
&quot;rel&quot; parameter of preload, preconnect, dns-prefetch, modulepreload or
24518+
prefetch) seen on cached responses. When a subsequent &quot;<a href="#cache-use">cache-use</a>&quot; lookup
24519+
cannot serve the full response from the cache but the URL's &quot;Link&quot; hints
24520+
are still known, the cache emits a 103 Early Hints response carrying those
24521+
hints before forwarding the request to the backend, giving the client a
24522+
head start on fetching subresources while the backend produces the body.
24523+
Individual &quot;<a href="#cache-use">cache-use</a>&quot; rules may opt out of this behavior with the
24524+
&quot;no-early-hints&quot; keyword. The default value is off (disabled).
24525+
24526+
When &quot;<a href="#early-hints">early-hints</a>&quot; is set to &quot;only&quot;, no responses are stored in the cache.
24527+
Instead, if a backend response contains relevant &quot;Link&quot; headers as defined
24528+
above, the cache stores those in order to emit a 103 Early Hints response if
24529+
that same URL is accessed later. Since the response body is never stored in
24530+
this mode, the &quot;<a href="#max-object-size">max-object-size</a>&quot; limit does not apply: hints are extracted
24531+
and stored regardless of the response's size.
24532+
24533+
The optional &quot;ratio&quot; argument sets the percentage of total cache blocks
24534+
that may be reserved for hints-only entries (1 to 99, default 25). Higher
24535+
values keep hints alive longer at the cost of less space for full responses;
24536+
lower values prioritize full responses. This argument only makes sense when
24537+
&quot;<a href="#early-hints">early-hints</a>&quot; is set to on, and is ignored otherwise. In &quot;only&quot; mode every
24538+
stored entry is a hints entry, so the whole cache is available to them and
24539+
this ratio has no practical effect.
2450524540
</pre><a class="anchor" name="max-age"></a><a class="anchor" name="6-max-age"></a><a class="anchor" name="6.2.1-max-age"></a><a class="anchor" name="max-age (Cache)"></a><a class="anchor" name="max-age (Cache section)"></a><div class="keyword"><b><a class="anchor" name="max-age"></a><a href="#6.2.1-max-age">max-age</a></b> <span style="color: #080">&lt;seconds&gt;</span></div><pre class="text">Define the maximum expiration duration. The expiration is set as the lowest
2450624541
value between the s-maxage or max-age (in this order) directive in the
2450724542
Cache-Control response header and this value. The default value is 60
@@ -35460,7 +35495,7 @@ <h2 id="chapter-12.9" data-target="12.9"><small><a class="small" href="#12.9">12
3546035495
<br>
3546135496
<hr>
3546235497
<div class="text-right">
35463-
HAProxy 3.5-dev2-2 &ndash; Configuration Manual<br>
35498+
HAProxy 3.5-dev2-34 &ndash; Configuration Manual<br>
3546435499
<small>, 2026/07/08</small>
3546535500
</div>
3546635501
</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.5-dev2-2 - Starter Guide</title>
5+
<title>HAProxy version 3.5-dev2-34 - 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>2026/07/08</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>2026/07/10</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.5-dev2-2</strong></p>
498+
<p><strong>version 3.5-dev2-34</strong></p>
499499
<p>
500500
<br>
501501

@@ -2510,7 +2510,7 @@ <h2 id="chapter-4.4" data-target="4.4"><small><a class="small" href="#4.4">4.4.<
25102510
<br>
25112511
<hr>
25122512
<div class="text-right">
2513-
HAProxy 3.5-dev2-2 &ndash; Starter Guide<br>
2513+
HAProxy 3.5-dev2-34 &ndash; Starter Guide<br>
25142514
<small>, </small>
25152515
</div>
25162516
</div>

docs/dev/management.html

Lines changed: 14 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.5-dev2-2 - Management Guide</title>
5+
<title>HAProxy version 3.5-dev2-34 - 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" />
@@ -696,7 +696,7 @@
696696
You can use <strong>left</strong> and <strong>right</strong> arrow keys to navigate between chapters.<br>
697697
</p>
698698
<p class="text-right">
699-
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2026/07/08</b></small>
699+
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2026/07/10</b></small>
700700
</p>
701701
</div>
702702
<!-- /.sidebar -->
@@ -707,7 +707,7 @@
707707
<div class="text-center">
708708
<h1><a href="http://www.haproxy.org/" title="HAProxy"><img src="../img/HAProxyCommunityEdition_60px.png?0.4.2-15" /></a></h1>
709709
<h2>Management Guide</h2>
710-
<p><strong>version 3.5-dev2-2</strong></p>
710+
<p><strong>version 3.5-dev2-34</strong></p>
711711
<p>
712712
<br>
713713

@@ -2235,6 +2235,16 @@ <h2 id="chapter-9.1" data-target="9.1"><small><a class="small" href="#9.1">9.1.<
22352235
since the worker process started
22362236
112. proto [L...]: protocol
22372237
113. priv_idle_cur [...S]: current number of private idle connections
2238+
114. reqbin [LFBS]: total number of request bytes received since the worker
2239+
process started
2240+
115. reqbout [LFBS]: total number of request bytes sent since the worker
2241+
process started
2242+
116. resbin [LFBS]: total number of response bytes received since the worker
2243+
process started
2244+
117. resbout [LFBS]: total number of response bytes sent since the worker
2245+
process started
2246+
118. cache_hint_hits [.FB.]: cumulative number of cache hits having served
2247+
early hints
22382248

22392249
For all other statistics domains, the presence or the order of the fields are
22402250
not guaranteed. In this case, the header line should always be used to parse
@@ -5906,7 +5916,7 @@ <h2 id="chapter-13.1" data-target="13.1"><small><a class="small" href="#13.1">13
59065916
<br>
59075917
<hr>
59085918
<div class="text-right">
5909-
HAProxy 3.5-dev2-2 &ndash; Management Guide<br>
5919+
HAProxy 3.5-dev2-34 &ndash; Management Guide<br>
59105920
<small>, </small>
59115921
</div>
59125922
</div>

0 commit comments

Comments
 (0)