Skip to content

Commit 073a7f3

Browse files
author
HAProxy Community
committed
Update docs for 3.1
1 parent 2d86fbe commit 073a7f3

File tree

3 files changed

+60
-31
lines changed

3 files changed

+60
-31
lines changed

docs/3.1/configuration.html

Lines changed: 52 additions & 23 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 - Configuration Manual</title>
5+
<title>HAProxy version 3.1.10-18 - 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/11/07</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/05</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</strong></p>
4446+
<p><strong>version 3.1.10-18</strong></p>
44474447
<p>
44484448
2025/11/07<br>
44494449

@@ -6102,6 +6102,8 @@ <h3 id="chapter-1.4.1" data-target="1.4.1"><small><a class="small" href="#1.4.1"
61026102
408 when the request timeout strikes before the request is complete
61036103
410 when the requested resource is no longer available and will not
61046104
be available again
6105+
413 when a HTTP/1.0 GET/HEAD/DELETE requests has a payload, also see
6106+
the &quot;<a href="#h1-accept-payload-with-any-method">h1-accept-payload-with-any-method</a>&quot; option
61056107
500 when HAProxy encounters an unrecoverable internal error, such as a
61066108
memory allocation failure, which should never happen
61076109
501 when HAProxy is unable to satisfy a client request because of an
@@ -6721,26 +6723,51 @@ <h2 id="chapter-2.4" data-target="2.4"><small><a class="small" href="#2.4">2.4.<
67216723
in the features list reported by &quot;haproxy -vv&quot;
67226724
(which means a &lt;name&gt; appears after a '+')
67236725

6724-
- streq(&lt;str1&gt;,&lt;str2&gt;) : returns true only if the two strings are equal
6725-
- strneq(&lt;str1&gt;,&lt;str2&gt;) : returns true only if the two strings differ
6726-
- strstr(&lt;str1&gt;,&lt;str2&gt;) : returns true only if the second string is found in
6727-
the first one.
6726+
- openssl_version_atleast(&lt;ver&gt;) : returns true if the current openssl
6727+
version is at least as recent as &lt;ver&gt; otherwise
6728+
false.
6729+
Libraries like LibreSSL, AWS-LC and WolfSSL also
6730+
provide a pseudo OpenSSL version.
6731+
</pre><div class="separator">
6732+
<span class="label label-success">Example:</span>
6733+
<pre class="prettyprint">
6734+
<code>ssllib_name_startswith(OpenSSL) &amp;&amp; openssl_version_atleast(1.1.1)
6735+
</code></pre>
6736+
</div><pre class="text">- openssl_version_before(&lt;ver&gt;) : returns true if the current openssl
6737+
version is strictly older than &lt;ver&gt; otherwise
6738+
false.
6739+
Libraries like LibreSSL, AWS-LC and WolfSSL also
6740+
provide a pseudo OpenSSL version.
6741+
</pre><div class="separator">
6742+
<span class="label label-success">Example:</span>
6743+
<pre class="prettyprint">
6744+
<div class="example-desc">openssl_version_before(3.5.0)</div><code></code></pre>
6745+
</div><pre class="text">- ssllib_name_startswith(&lt;name&gt;) : return true if the SSL library name
6746+
HAProxy was linked with, starts with &lt;name&gt;.
6747+
</pre><div class="separator">
6748+
<span class="label label-success">Example:</span>
6749+
<pre class="prettyprint">
6750+
<div class="example-desc">ssllib_name_startswith(wolfSSL)</div><code></code></pre>
6751+
</div><pre class="text">- streq(&lt;str1&gt;,&lt;str2&gt;) : returns true only if the two strings are equal
6752+
- strneq(&lt;str1&gt;,&lt;str2&gt;) : returns true only if the two strings differ
6753+
- strstr(&lt;str1&gt;,&lt;str2&gt;) : returns true only if the second string is found in
6754+
the first one.
67286755

6729-
- version_atleast(&lt;ver&gt;): returns true if the current haproxy version is
6730-
at least as recent as &lt;ver&gt; otherwise false. The
6731-
version syntax is the same as shown by &quot;haproxy -v&quot;
6732-
and missing components are assumed as being zero.
6756+
- version_atleast(&lt;ver&gt;): returns true if the current haproxy version is
6757+
at least as recent as &lt;ver&gt; otherwise false. The
6758+
version syntax is the same as shown by &quot;haproxy -v&quot;
6759+
and missing components are assumed as being zero.
67336760

6734-
- version_before(&lt;ver&gt;) : returns true if the current haproxy version is
6735-
strictly older than &lt;ver&gt; otherwise false. The
6736-
version syntax is the same as shown by &quot;haproxy -v&quot;
6737-
and missing components are assumed as being zero.
6761+
- version_before(&lt;ver&gt;) : returns true if the current haproxy version is
6762+
strictly older than &lt;ver&gt; otherwise false. The
6763+
version syntax is the same as shown by &quot;haproxy -v&quot;
6764+
and missing components are assumed as being zero.
67386765

6739-
- enabled(&lt;opt&gt;) : returns true if the option &lt;opt&gt; is enabled at
6740-
run-time. Only a subset of options are supported:
6741-
POLL, EPOLL, KQUEUE, EVPORTS, SPLICE,
6742-
GETADDRINFO, REUSEPORT, FAST-FORWARD,
6743-
SERVER-SSL-VERIFY-NONE
6766+
- enabled(&lt;opt&gt;) : returns true if the option &lt;opt&gt; is enabled at
6767+
run-time. Only a subset of options are supported:
6768+
POLL, EPOLL, KQUEUE, EVPORTS, SPLICE,
6769+
GETADDRINFO, REUSEPORT, FAST-FORWARD,
6770+
SERVER-SSL-VERIFY-NONE
67446771
</pre><div class="separator">
67456772
<span class="label label-success">Example:</span>
67466773
<pre class="prettyprint">
@@ -7615,7 +7642,8 @@ <h2 id="chapter-3.1" data-target="3.1"><small><a class="small" href="#3.1">3.1.<
76157642
</div><div class="page-header"><b>See also:</b> hard-stop-after, monitor</div>
76167643
<a class="anchor" name="group"></a><a class="anchor" name="3-group"></a><a class="anchor" name="3.1-group"></a><a class="anchor" name="group (Global parameters)"></a><a class="anchor" name="group (Process management and security)"></a><div class="keyword"><b><a class="anchor" name="group"></a><a href="#3.1-group">group</a></b> <span style="color: #080">&lt;group name&gt;</span></div><pre class="text">Similar to &quot;<span class="dropdown"><a class="dropdown-toggle" data-toggle="dropdown" href="#">gid<span class="caret"></span></a><ul class="dropdown-menu"><li class="dropdown-header">This keyword is available in sections :</li><li><a href="#gid%20%28Process%20management%20and%20security%29">Process management and security</a></li><li><a href="#gid%20%28Bind%20options%29">Bind options</a></li></ul></span>&quot; but uses the GID of group name &lt;group name&gt; from /etc/group.
76177644
See also &quot;<span class="dropdown"><a class="dropdown-toggle" data-toggle="dropdown" href="#">gid<span class="caret"></span></a><ul class="dropdown-menu"><li class="dropdown-header">This keyword is available in sections :</li><li><a href="#gid%20%28Process%20management%20and%20security%29">Process management and security</a></li><li><a href="#gid%20%28Bind%20options%29">Bind options</a></li></ul></span>&quot; and &quot;<span class="dropdown"><a class="dropdown-toggle" data-toggle="dropdown" href="#">user<span class="caret"></span></a><ul class="dropdown-menu"><li class="dropdown-header">This keyword is available in sections :</li><li><a href="#user%20%28Process%20management%20and%20security%29">Process management and security</a></li><li><a href="#user%20%28Userlists%29">Userlists</a></li><li><a href="#user%20%28Programs%20%28deprecated%29%29">Programs (deprecated)</a></li><li><a href="#user%20%28Bind%20options%29">Bind options</a></li></ul></span>&quot;.
7618-
</pre><a class="anchor" name="h1-accept-payload-with-any-method"></a><a class="anchor" name="3-h1-accept-payload-with-any-method"></a><a class="anchor" name="3.1-h1-accept-payload-with-any-method"></a><a class="anchor" name="h1-accept-payload-with-any-method (Global parameters)"></a><a class="anchor" name="h1-accept-payload-with-any-method (Process management and security)"></a><div class="keyword"><b><a class="anchor" name="h1-accept-payload-with-any-method"></a><a href="#3.1-h1-accept-payload-with-any-method">h1-accept-payload-with-any-method</a></b></div><pre class="text">Does not reject HTTP/1.0 GET/HEAD/DELETE requests with a payload.
7645+
</pre><a class="anchor" name="h1-accept-payload-with-any-method"></a><a class="anchor" name="3-h1-accept-payload-with-any-method"></a><a class="anchor" name="3.1-h1-accept-payload-with-any-method"></a><a class="anchor" name="h1-accept-payload-with-any-method (Global parameters)"></a><a class="anchor" name="h1-accept-payload-with-any-method (Process management and security)"></a><div class="keyword"><b><a class="anchor" name="h1-accept-payload-with-any-method"></a><a href="#3.1-h1-accept-payload-with-any-method">h1-accept-payload-with-any-method</a></b></div><pre class="text">Does not reject HTTP/1.0 GET/HEAD/DELETE requests with a payload with a
7646+
413 Payload Too Large HTTP response.
76197647

76207648
While It is explicitly allowed in HTTP/1.1, HTTP/1.0 is not clear on this
76217649
point and some old servers don't expect any payload and never look for body
@@ -9229,7 +9257,8 @@ <h2 id="chapter-3.2" data-target="3.2"><small><a class="small" href="#3.2">3.2.<
92299257
the polling system. The default value is adapted to the operating system. It
92309258
has been noticed that reducing it below 200 tends to slightly decrease
92319259
latency at the expense of network bandwidth, and increasing it above 200
9232-
tends to trade latency for slightly increased bandwidth.
9260+
tends to trade latency for slightly increased bandwidth. The configured value
9261+
must be lower than or equal to 1000000.
92339262
</pre><a class="anchor" name="tune.maxrewrite"></a><a class="anchor" name="3-tune.maxrewrite"></a><a class="anchor" name="3.2-tune.maxrewrite"></a><a class="anchor" name="tune.maxrewrite (Global parameters)"></a><a class="anchor" name="tune.maxrewrite (Performance tuning)"></a><div class="keyword"><b><a class="anchor" name="tune.maxrewrite"></a><a href="#3.2-tune.maxrewrite">tune.maxrewrite</a></b> <span style="color: #080">&lt;number&gt;</span></div><pre class="text">Sets the reserved buffer space to this size in bytes. The reserved space is
92349263
used for header rewriting or appending. The first reads on sockets will never
92359264
fill more than bufsize-maxrewrite. Historically it has defaulted to half of
@@ -31843,7 +31872,7 @@ <h2 id="chapter-11.3" data-target="11.3"><small><a class="small" href="#11.3">11
3184331872
<br>
3184431873
<hr>
3184531874
<div class="text-right">
31846-
HAProxy 3.1.10 &ndash; Configuration Manual<br>
31875+
HAProxy 3.1.10-18 &ndash; Configuration Manual<br>
3184731876
<small>, 2025/11/07</small>
3184831877
</div>
3184931878
</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 - Starter Guide</title>
5+
<title>HAProxy version 3.1.10-18 - 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/07</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/05</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</strong></p>
498+
<p><strong>version 3.1.10-18</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 &ndash; Starter Guide<br>
2518+
HAProxy 3.1.10-18 &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 - Management Guide</title>
5+
<title>HAProxy version 3.1.10-18 - 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/11/07</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/05</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</strong></p>
666+
<p><strong>version 3.1.10-18</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 &ndash; Management Guide<br>
5438+
HAProxy 3.1.10-18 &ndash; Management Guide<br>
54395439
<small>, </small>
54405440
</div>
54415441
</div>

0 commit comments

Comments
 (0)