Skip to content

Commit 2f43d22

Browse files
author
HAProxy Community
committed
Update docs for dev
1 parent d89025d commit 2f43d22

3 files changed

Lines changed: 29 additions & 26 deletions

File tree

docs/dev/configuration.html

Lines changed: 21 additions & 18 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.4-dev7-56 - Configuration Manual</title>
5+
<title>HAProxy version 3.4-dev7-63 - 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" />
@@ -4829,7 +4829,7 @@
48294829
You can use <strong>left</strong> and <strong>right</strong> arrow keys to navigate between chapters.<br>
48304830
</p>
48314831
<p class="text-right">
4832-
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2026/03/23</b></small>
4832+
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2026/03/27</b></small>
48334833
</p>
48344834
</div>
48354835
<!-- /.sidebar -->
@@ -4840,7 +4840,7 @@
48404840
<div class="text-center">
48414841
<h1><a href="http://www.haproxy.org/" title="HAProxy"><img src="../img/HAProxyCommunityEdition_60px.png?0.4.2-15" /></a></h1>
48424842
<h2>Configuration Manual</h2>
4843-
<p><strong>version 3.4-dev7-56</strong></p>
4843+
<p><strong>version 3.4-dev7-63</strong></p>
48444844
<p>
48454845
2026/03/20<br>
48464846

@@ -10201,21 +10201,21 @@ <h2 id="chapter-3.2" data-target="3.2"><small><a class="small" href="#3.2">3.2.<
1020110201
too when headers are encoded to comply to limitation imposed by the
1020210202
protocols. This limit is large enough but not documented on purpose. The same
1020310203
limit is applied on the first steps of the decoding for the same reason.
10204-
</pre><a class="anchor" name="tune.idle-pool.shared"></a><a class="anchor" name="3-tune.idle-pool.shared"></a><a class="anchor" name="3.2-tune.idle-pool.shared"></a><a class="anchor" name="tune.idle-pool.shared (Global section)"></a><a class="anchor" name="tune.idle-pool.shared (Performance tuning)"></a><div class="keyword"><b><a class="anchor" name="tune.idle-pool.shared"></a><a href="#3.2-tune.idle-pool.shared">tune.idle-pool.shared</a></b> <span style="color: #800">{ on | off }</span></div><pre class="text">Enables ('on') or disables ('off') sharing of idle connection pools between
10205-
threads for a same server. The default is to share them between threads in
10206-
order to minimize the number of persistent connections to a server, and to
10207-
optimize the connection reuse rate. But to help with debugging or when
10204+
</pre><a class="anchor" name="tune.idle-pool.shared"></a><a class="anchor" name="3-tune.idle-pool.shared"></a><a class="anchor" name="3.2-tune.idle-pool.shared"></a><a class="anchor" name="tune.idle-pool.shared (Global section)"></a><a class="anchor" name="tune.idle-pool.shared (Performance tuning)"></a><div class="keyword"><b><a class="anchor" name="tune.idle-pool.shared"></a><a href="#3.2-tune.idle-pool.shared">tune.idle-pool.shared</a></b> <span style="color: #800">{ auto | on | off }</span></div><pre class="text">Controls sharing idle connection pools between threads for a same server.
10205+
It can be enabled for all threads in a same thread group ('on'), enabled for
10206+
all threads ('full') or disabled ('off'). The default is to share them
10207+
between threads in the same thread group ('on'), in order to minimize the
10208+
number of persistent connections to a server, and to optimize the connection
10209+
reuse rate. Sharing with threads from other thread groups can have a
10210+
performance impact, and is not enabled by default, but can be useful if
10211+
maximizing connection reuse is a priority. To help with debugging or when
1020810212
suspecting a bug in HAProxy around connection reuse, it can be convenient to
10209-
forcefully disable this idle pool sharing between multiple threads, and force
10210-
this option to &quot;off&quot;. The default is on. It is strongly recommended against
10211-
disabling this option without setting a conservative value on &quot;<a href="#pool-low-conn">pool-low-conn</a>&quot;
10212-
for all servers relying on connection reuse to achieve a high performance
10213-
level, otherwise connections might be closed very often as the thread count
10214-
increases. Note that in any case, connections are only shared between threads
10215-
of the same thread group. This means that systems with many NUMA nodes may
10216-
show slightly more persistent connections while machines with unified caches
10217-
and many CPU cores per node may experience higher CPU usage. In the latter
10218-
case, the &quot;max-thread-per-group&quot; tunable may be used to improve the behavior.
10213+
forcefully disable this idle pool sharing between multiple threads,
10214+
and force this option to &quot;off&quot;. It is strongly recommended against disabling
10215+
this option without setting a conservative value on &quot;<a href="#pool-low-conn">pool-low-conn</a>&quot; for all
10216+
servers relying on connection reuse to achieve a high performance level,
10217+
otherwise connections might be closed very often as the thread count
10218+
increases.
1021910219
</pre><a class="anchor" name="tune.idletimer"></a><a class="anchor" name="3-tune.idletimer"></a><a class="anchor" name="3.2-tune.idletimer"></a><a class="anchor" name="tune.idletimer (Global section)"></a><a class="anchor" name="tune.idletimer (Performance tuning)"></a><div class="keyword"><b><a class="anchor" name="tune.idletimer"></a><a href="#3.2-tune.idletimer">tune.idletimer</a></b> <span style="color: #080">&lt;timeout&gt;</span></div><pre class="text">Sets the duration after which HAProxy will consider that an empty buffer is
1022010220
probably associated with an idle stream. This is used to optimally adjust
1022110221
some packet sizes while forwarding large and small data alternatively. The
@@ -10961,6 +10961,9 @@ <h2 id="chapter-3.2" data-target="3.2"><small><a class="small" href="#3.2">3.2.<
1096110961
connections.
1096210962
Note that using connections from other thread groups can occur performance
1096310963
penalties, so it should not be used unless really needed.
10964+
Note that this behavior is now controlled by tune.idle-pool.shared, and
10965+
this keyword is just there for compatibility with older configurations, and
10966+
will be deprecated.
1096410967
</pre><a class="anchor" name="tune.vars.global-max-size"></a><a class="anchor" name="3-tune.vars.global-max-size"></a><a class="anchor" name="3.2-tune.vars.global-max-size"></a><a class="anchor" name="tune.vars.global-max-size (Global section)"></a><a class="anchor" name="tune.vars.global-max-size (Performance tuning)"></a><div class="keyword"><b><a class="anchor" name="tune.vars.global-max-size"></a><a href="#3.2-tune.vars.global-max-size">tune.vars.global-max-size</a></b> <span style="color: #080">&lt;size&gt;</span></div><a class="anchor" name="tune.vars.proc-max-size"></a><a class="anchor" name="3-tune.vars.proc-max-size"></a><a class="anchor" name="3.2-tune.vars.proc-max-size"></a><a class="anchor" name="tune.vars.proc-max-size (Global section)"></a><a class="anchor" name="tune.vars.proc-max-size (Performance tuning)"></a><div class="keyword"><b><a class="anchor" name="tune.vars.proc-max-size"></a><a href="#3.2-tune.vars.proc-max-size">tune.vars.proc-max-size</a></b> <span style="color: #080">&lt;size&gt;</span></div><a class="anchor" name="tune.vars.reqres-max-size"></a><a class="anchor" name="3-tune.vars.reqres-max-size"></a><a class="anchor" name="3.2-tune.vars.reqres-max-size"></a><a class="anchor" name="tune.vars.reqres-max-size (Global section)"></a><a class="anchor" name="tune.vars.reqres-max-size (Performance tuning)"></a><div class="keyword"><b><a class="anchor" name="tune.vars.reqres-max-size"></a><a href="#3.2-tune.vars.reqres-max-size">tune.vars.reqres-max-size</a></b> <span style="color: #080">&lt;size&gt;</span></div><a class="anchor" name="tune.vars.sess-max-size"></a><a class="anchor" name="3-tune.vars.sess-max-size"></a><a class="anchor" name="3.2-tune.vars.sess-max-size"></a><a class="anchor" name="tune.vars.sess-max-size (Global section)"></a><a class="anchor" name="tune.vars.sess-max-size (Performance tuning)"></a><div class="keyword"><b><a class="anchor" name="tune.vars.sess-max-size"></a><a href="#3.2-tune.vars.sess-max-size">tune.vars.sess-max-size</a></b> <span style="color: #080">&lt;size&gt;</span></div><a class="anchor" name="tune.vars.txn-max-size"></a><a class="anchor" name="3-tune.vars.txn-max-size"></a><a class="anchor" name="3.2-tune.vars.txn-max-size"></a><a class="anchor" name="tune.vars.txn-max-size (Global section)"></a><a class="anchor" name="tune.vars.txn-max-size (Performance tuning)"></a><div class="keyword"><b><a class="anchor" name="tune.vars.txn-max-size"></a><a href="#3.2-tune.vars.txn-max-size">tune.vars.txn-max-size</a></b> <span style="color: #080">&lt;size&gt;</span></div><pre class="text">These five tunes help to manage the maximum amount of memory used by the
1096510968
variables system. &quot;global&quot; limits the overall amount of memory available for
1096610969
all scopes. &quot;<a href="#proc">proc</a>&quot; limits the memory for the process scope, &quot;sess&quot; limits the
@@ -34871,7 +34874,7 @@ <h2 id="chapter-12.8" data-target="12.8"><small><a class="small" href="#12.8">12
3487134874
<br>
3487234875
<hr>
3487334876
<div class="text-right">
34874-
HAProxy 3.4-dev7-56 &ndash; Configuration Manual<br>
34877+
HAProxy 3.4-dev7-63 &ndash; Configuration Manual<br>
3487534878
<small>, 2026/03/20</small>
3487634879
</div>
3487734880
</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.4-dev7-56 - Starter Guide</title>
5+
<title>HAProxy version 3.4-dev7-63 - 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/03/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>2026/03/27</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.4-dev7-56</strong></p>
498+
<p><strong>version 3.4-dev7-63</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.4-dev7-56 &ndash; Starter Guide<br>
2518+
HAProxy 3.4-dev7-63 &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.4-dev7-56 - Management Guide</title>
5+
<title>HAProxy version 3.4-dev7-63 - 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/03/23</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/03/27</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.4-dev7-56</strong></p>
710+
<p><strong>version 3.4-dev7-63</strong></p>
711711
<p>
712712
<br>
713713

@@ -5849,7 +5849,7 @@ <h2 id="chapter-13.1" data-target="13.1"><small><a class="small" href="#13.1">13
58495849
<br>
58505850
<hr>
58515851
<div class="text-right">
5852-
HAProxy 3.4-dev7-56 &ndash; Management Guide<br>
5852+
HAProxy 3.4-dev7-63 &ndash; Management Guide<br>
58535853
<small>, </small>
58545854
</div>
58555855
</div>

0 commit comments

Comments
 (0)