Skip to content

Commit e26ecab

Browse files
author
HAProxy Community
committed
Update docs for 3.1
1 parent 0c01ffb commit e26ecab

3 files changed

Lines changed: 24 additions & 23 deletions

File tree

docs/3.1/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.1.10-19 - Configuration Manual</title>
5+
<title>HAProxy version 3.1.10-43 - 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" />
@@ -4432,7 +4432,7 @@
44324432
You can use <strong>left</strong> and <strong>right</strong> arrow keys to navigate between chapters.<br>
44334433
</p>
44344434
<p class="text-right">
4435-
<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/05</b></small>
4435+
<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>
44364436
</p>
44374437
</div>
44384438
<!-- /.sidebar -->
@@ -4443,7 +4443,7 @@
44434443
<div class="text-center">
44444444
<h1><a href="http://www.haproxy.org/" title="HAProxy"><img src="../img/HAProxyCommunityEdition_60px.png?0.4.2-15" /></a></h1>
44454445
<h2>Configuration Manual</h2>
4446-
<p><strong>version 3.1.10-19</strong></p>
4446+
<p><strong>version 3.1.10-43</strong></p>
44474447
<p>
44484448
2025/11/07<br>
44494449

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

1386013860
spop When used in a backend section, it will turn the backend into a
13861-
log backend. This mode is mandatory and automatically set, if
13862-
necessary, for backends referenced by SPOE engines.</pre>
13861+
spop backend. This mode is mandatory if the backend contains
13862+
SPOA servers, but when mode is tcp, it will automatically be
13863+
converted to mode spop if such servers are detected.</pre>
1386313864
</div>
1386413865
<pre class="text">When doing content switching, it is mandatory that the frontend and the
1386513866
backend are in the same mode (generally HTTP), otherwise the configuration
@@ -23298,27 +23299,27 @@ <h2 id="chapter-6.2" data-target="6.2"><small><a class="small" href="#6.2">6.2.<
2329823299
<a class="anchor" id="6.2.1" name="6.2.1"></a>
2329923300
<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>
2330023301
<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
23301-
size of cache is mandatory.
23302-
</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
23303-
blocks of 1kB which are used by the cache entries. Its maximum value is 4095.
23304-
</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
23305-
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.
23306-
All objects with sizes larger than &quot;<a href="#max-object-size">max-object-size</a>&quot; will not be cached.
23302+
size of cache is mandatory (see keyword &quot;<a href="#total-max-size">total-max-size</a>&quot; below).
2330723303
</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
2330823304
value between the s-maxage or max-age (in this order) directive in the
2330923305
Cache-Control response header and this value. The default value is 60
2331023306
seconds, which means that you can't cache an object more than 60 seconds by
2331123307
default.
23308+
</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
23309+
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.
23310+
All objects with sizes larger than &quot;<a href="#max-object-size">max-object-size</a>&quot; will not be cached.
23311+
</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
23312+
key in the cache. This needs the vary support to be enabled. Its default value is 10
23313+
and should be passed a strictly positive integer.
2331223314
</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
2331323315
containing such a header will never be cached. When enabled, we need to calculate
2331423316
a preliminary hash for a subset of request headers on all the incoming requests
2331523317
(which might come with a cpu cost) which will be used to build a secondary
2331623318
key for a given request (see RFC 7234#4.1). The secondary key is built out of
2331723319
the contents of the 'accept-encoding', 'referer' and 'origin' headers for
2331823320
now. The default value is off (disabled).
23319-
</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
23320-
key in the cache. This needs the vary support to be enabled. Its default value is 10
23321-
and should be passed a strictly positive integer.
23321+
</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
23322+
blocks of 1kB which are used by the cache entries. Its maximum value is 4095.
2332223323
</pre></div>
2332323324
<a class="anchor" id="6.2.2" name="6.2.2"></a>
2332423325
<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>
@@ -31872,7 +31873,7 @@ <h2 id="chapter-11.3" data-target="11.3"><small><a class="small" href="#11.3">11
3187231873
<br>
3187331874
<hr>
3187431875
<div class="text-right">
31875-
HAProxy 3.1.10-19 &ndash; Configuration Manual<br>
31876+
HAProxy 3.1.10-43 &ndash; Configuration Manual<br>
3187631877
<small>, 2025/11/07</small>
3187731878
</div>
3187831879
</div>

docs/3.1/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.1.10-19 - Starter Guide</title>
5+
<title>HAProxy version 3.1.10-43 - 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/12/05</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.1.10-19</strong></p>
498+
<p><strong>version 3.1.10-43</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.1.10-19 &ndash; Starter Guide<br>
2518+
HAProxy 3.1.10-43 &ndash; Starter Guide<br>
25192519
<small>, </small>
25202520
</div>
25212521
</div>

docs/3.1/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.1.10-19 - Management Guide</title>
5+
<title>HAProxy version 3.1.10-43 - 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" />
@@ -652,7 +652,7 @@
652652
You can use <strong>left</strong> and <strong>right</strong> arrow keys to navigate between chapters.<br>
653653
</p>
654654
<p class="text-right">
655-
<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/05</b></small>
655+
<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>
656656
</p>
657657
</div>
658658
<!-- /.sidebar -->
@@ -663,7 +663,7 @@
663663
<div class="text-center">
664664
<h1><a href="http://www.haproxy.org/" title="HAProxy"><img src="../img/HAProxyCommunityEdition_60px.png?0.4.2-15" /></a></h1>
665665
<h2>Management Guide</h2>
666-
<p><strong>version 3.1.10-19</strong></p>
666+
<p><strong>version 3.1.10-43</strong></p>
667667
<p>
668668
<br>
669669

@@ -5435,7 +5435,7 @@ <h2 id="chapter-13.1" data-target="13.1"><small><a class="small" href="#13.1">13
54355435
<br>
54365436
<hr>
54375437
<div class="text-right">
5438-
HAProxy 3.1.10-19 &ndash; Management Guide<br>
5438+
HAProxy 3.1.10-43 &ndash; Management Guide<br>
54395439
<small>, </small>
54405440
</div>
54415441
</div>

0 commit comments

Comments
 (0)