Skip to content

Commit 0c01ffb

Browse files
author
HAProxy Community
committed
Update docs for 3.2
1 parent 3a43d49 commit 0c01ffb

3 files changed

Lines changed: 24 additions & 23 deletions

File tree

docs/3.2/configuration.html

Lines changed: 16 additions & 15 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.2.9-1 - Configuration Manual</title>
5+
<title>HAProxy version 3.2.9-21 - 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" />
@@ -4622,7 +4622,7 @@
46224622
You can use <strong>left</strong> and <strong>right</strong> arrow keys to navigate between chapters.<br>
46234623
</p>
46244624
<p class="text-right">
4625-
<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/21</b></small>
4625+
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2025/12/12</b></small>
46264626
</p>
46274627
</div>
46284628
<!-- /.sidebar -->
@@ -4633,7 +4633,7 @@
46334633
<div class="text-center">
46344634
<h1><a href="http://www.haproxy.org/" title="HAProxy"><img src="../img/HAProxyCommunityEdition_60px.png?0.4.2-15" /></a></h1>
46354635
<h2>Configuration Manual</h2>
4636-
<p><strong>version 3.2.9-1</strong></p>
4636+
<p><strong>version 3.2.9-21</strong></p>
46374637
<p>
46384638
2025/11/21<br>
46394639

@@ -13921,8 +13921,9 @@ <h2 id="chapter-4.2" data-target="4.2"><small><a class="small" href="#4.2">4.2.<
1392113921
server features are supported, but not TCP or HTTP specific ones.
1392213922

1392313923
spop When used in a backend section, it will turn the backend into a
13924-
log backend. This mode is mandatory and automatically set, if
13925-
necessary, for backends referenced by SPOE engines.</pre>
13924+
spop backend. This mode is mandatory if the backend contains
13925+
SPOA servers, but when mode is tcp, it will automatically be
13926+
converted to mode spop if such servers are detected.</pre>
1392613927
</div>
1392713928
<pre class="text">When doing content switching, it is mandatory that the frontend and the
1392813929
backend are in the same mode (generally HTTP), otherwise the configuration
@@ -23263,27 +23264,27 @@ <h2 id="chapter-6.2" data-target="6.2"><small><a class="small" href="#6.2">6.2.<
2326323264
<a class="anchor" id="6.2.1" name="6.2.1"></a>
2326423265
<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>
2326523266
<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
23266-
size of cache is mandatory.
23267-
</pre><a class="anchor" name="total-max-size"></a><a class="anchor" name="6-total-max-size"></a><a class="anchor" name="6.2.1-total-max-size"></a><a class="anchor" name="total-max-size (Cache)"></a><a class="anchor" name="total-max-size (Cache section)"></a><div class="keyword"><b><a class="anchor" name="total-max-size"></a><a href="#6.2.1-total-max-size">total-max-size</a></b> <span style="color: #080">&lt;megabytes&gt;</span></div><pre class="text">Define the size in RAM of the cache in megabytes. This size is split in
23268-
blocks of 1kB which are used by the cache entries. Its maximum value is 4095.
23269-
</pre><a class="anchor" name="max-object-size"></a><a class="anchor" name="6-max-object-size"></a><a class="anchor" name="6.2.1-max-object-size"></a><a class="anchor" name="max-object-size (Cache)"></a><a class="anchor" name="max-object-size (Cache section)"></a><div class="keyword"><b><a class="anchor" name="max-object-size"></a><a href="#6.2.1-max-object-size">max-object-size</a></b> <span style="color: #080">&lt;bytes&gt;</span></div><pre class="text">Define the maximum size of the objects to be cached. Must not be greater than
23270-
an half of &quot;<a href="#total-max-size">total-max-size</a>&quot;. If not set, it equals to a 256th of the cache size.
23271-
All objects with sizes larger than &quot;<a href="#max-object-size">max-object-size</a>&quot; will not be cached.
23267+
size of cache is mandatory (see keyword &quot;<a href="#total-max-size">total-max-size</a>&quot; below).
2327223268
</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
2327323269
value between the s-maxage or max-age (in this order) directive in the
2327423270
Cache-Control response header and this value. The default value is 60
2327523271
seconds, which means that you can't cache an object more than 60 seconds by
2327623272
default.
23273+
</pre><a class="anchor" name="max-object-size"></a><a class="anchor" name="6-max-object-size"></a><a class="anchor" name="6.2.1-max-object-size"></a><a class="anchor" name="max-object-size (Cache)"></a><a class="anchor" name="max-object-size (Cache section)"></a><div class="keyword"><b><a class="anchor" name="max-object-size"></a><a href="#6.2.1-max-object-size">max-object-size</a></b> <span style="color: #080">&lt;bytes&gt;</span></div><pre class="text">Define the maximum size of the objects to be cached. Must not be greater than
23274+
an half of &quot;<a href="#total-max-size">total-max-size</a>&quot;. If not set, it equals to a 256th of the cache size.
23275+
All objects with sizes larger than &quot;<a href="#max-object-size">max-object-size</a>&quot; will not be cached.
23276+
</pre><a class="anchor" name="max-secondary-entries"></a><a class="anchor" name="6-max-secondary-entries"></a><a class="anchor" name="6.2.1-max-secondary-entries"></a><a class="anchor" name="max-secondary-entries (Cache)"></a><a class="anchor" name="max-secondary-entries (Cache section)"></a><div class="keyword"><b><a class="anchor" name="max-secondary-entries"></a><a href="#6.2.1-max-secondary-entries">max-secondary-entries</a></b> <span style="color: #080">&lt;number&gt;</span></div><pre class="text">Define the maximum number of simultaneous secondary entries with the same primary
23277+
key in the cache. This needs the vary support to be enabled. Its default value is 10
23278+
and should be passed a strictly positive integer.
2327723279
</pre><a class="anchor" name="process-vary"></a><a class="anchor" name="6-process-vary"></a><a class="anchor" name="6.2.1-process-vary"></a><a class="anchor" name="process-vary (Cache)"></a><a class="anchor" name="process-vary (Cache section)"></a><div class="keyword"><b><a class="anchor" name="process-vary"></a><a href="#6.2.1-process-vary">process-vary</a></b> <span style="color: #080">&lt;on/off&gt;</span></div><pre class="text">Enable or disable the processing of the Vary header. When disabled, a response
2327823280
containing such a header will never be cached. When enabled, we need to calculate
2327923281
a preliminary hash for a subset of request headers on all the incoming requests
2328023282
(which might come with a cpu cost) which will be used to build a secondary
2328123283
key for a given request (see RFC 7234#4.1). The secondary key is built out of
2328223284
the contents of the 'accept-encoding', 'referer' and 'origin' headers for
2328323285
now. The default value is off (disabled).
23284-
</pre><a class="anchor" name="max-secondary-entries"></a><a class="anchor" name="6-max-secondary-entries"></a><a class="anchor" name="6.2.1-max-secondary-entries"></a><a class="anchor" name="max-secondary-entries (Cache)"></a><a class="anchor" name="max-secondary-entries (Cache section)"></a><div class="keyword"><b><a class="anchor" name="max-secondary-entries"></a><a href="#6.2.1-max-secondary-entries">max-secondary-entries</a></b> <span style="color: #080">&lt;number&gt;</span></div><pre class="text">Define the maximum number of simultaneous secondary entries with the same primary
23285-
key in the cache. This needs the vary support to be enabled. Its default value is 10
23286-
and should be passed a strictly positive integer.
23286+
</pre><a class="anchor" name="total-max-size"></a><a class="anchor" name="6-total-max-size"></a><a class="anchor" name="6.2.1-total-max-size"></a><a class="anchor" name="total-max-size (Cache)"></a><a class="anchor" name="total-max-size (Cache section)"></a><div class="keyword"><b><a class="anchor" name="total-max-size"></a><a href="#6.2.1-total-max-size">total-max-size</a></b> <span style="color: #080">&lt;megabytes&gt;</span></div><pre class="text">Define the size in RAM of the cache in megabytes. This size is split in
23287+
blocks of 1kB which are used by the cache entries. Its maximum value is 4095.
2328723288
</pre></div>
2328823289
<a class="anchor" id="6.2.2" name="6.2.2"></a>
2328923290
<h3 id="chapter-6.2.2" data-target="6.2.2"><small><a class="small" href="#6.2.2">6.2.2.</a></small> Proxy section</h3>
@@ -33216,7 +33217,7 @@ <h2 id="chapter-12.9" data-target="12.9"><small><a class="small" href="#12.9">12
3321633217
<br>
3321733218
<hr>
3321833219
<div class="text-right">
33219-
HAProxy 3.2.9-1 &ndash; Configuration Manual<br>
33220+
HAProxy 3.2.9-21 &ndash; Configuration Manual<br>
3322033221
<small>, 2025/11/21</small>
3322133222
</div>
3322233223
</div>

docs/3.2/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.2.9-1 - Starter Guide</title>
5+
<title>HAProxy version 3.2.9-21 - 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/21</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/12/12</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.2.9-1</strong></p>
498+
<p><strong>version 3.2.9-21</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.2.9-1 &ndash; Starter Guide<br>
2518+
HAProxy 3.2.9-21 &ndash; Starter Guide<br>
25192519
<small>, </small>
25202520
</div>
25212521
</div>

docs/3.2/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.2.9-1 - Management Guide</title>
5+
<title>HAProxy version 3.2.9-21 - 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" />
@@ -662,7 +662,7 @@
662662
You can use <strong>left</strong> and <strong>right</strong> arrow keys to navigate between chapters.<br>
663663
</p>
664664
<p class="text-right">
665-
<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/21</b></small>
665+
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2025/12/12</b></small>
666666
</p>
667667
</div>
668668
<!-- /.sidebar -->
@@ -673,7 +673,7 @@
673673
<div class="text-center">
674674
<h1><a href="http://www.haproxy.org/" title="HAProxy"><img src="../img/HAProxyCommunityEdition_60px.png?0.4.2-15" /></a></h1>
675675
<h2>Management Guide</h2>
676-
<p><strong>version 3.2.9-1</strong></p>
676+
<p><strong>version 3.2.9-21</strong></p>
677677
<p>
678678
<br>
679679

@@ -5596,7 +5596,7 @@ <h2 id="chapter-13.1" data-target="13.1"><small><a class="small" href="#13.1">13
55965596
<br>
55975597
<hr>
55985598
<div class="text-right">
5599-
HAProxy 3.2.9-1 &ndash; Management Guide<br>
5599+
HAProxy 3.2.9-21 &ndash; Management Guide<br>
56005600
<small>, </small>
56015601
</div>
56025602
</div>

0 commit comments

Comments
 (0)