Skip to content

Commit bac89d1

Browse files
author
HAProxy Community
committed
Update docs for dev
1 parent 1889ada commit bac89d1

3 files changed

Lines changed: 58 additions & 27 deletions

File tree

docs/dev/configuration.html

Lines changed: 50 additions & 19 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-dev12-30 - Configuration Manual</title>
5+
<title>HAProxy version 3.4-dev12-53 - 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" />
@@ -4926,7 +4926,7 @@
49264926
You can use <strong>left</strong> and <strong>right</strong> arrow keys to navigate between chapters.<br>
49274927
</p>
49284928
<p class="text-right">
4929-
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2026/05/13</b></small>
4929+
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2026/05/19</b></small>
49304930
</p>
49314931
</div>
49324932
<!-- /.sidebar -->
@@ -4937,7 +4937,7 @@
49374937
<div class="text-center">
49384938
<h1><a href="http://www.haproxy.org/" title="HAProxy"><img src="../img/HAProxyCommunityEdition_60px.png?0.4.2-15" /></a></h1>
49394939
<h2>Configuration Manual</h2>
4940-
<p><strong>version 3.4-dev12-30</strong></p>
4940+
<p><strong>version 3.4-dev12-53</strong></p>
49414941
<p>
49424942
2026/05/13<br>
49434943

@@ -13538,7 +13538,10 @@ <h2 id="chapter-4.2" data-target="4.2"><small><a class="small" href="#4.2">4.2.<
1353813538

1353913539
none don't hash the key, the key will be used as a hash, this can be
1354013540
useful to manually hash the key using a converter for that purpose
13541-
and let haproxy use the result directly.
13541+
and let haproxy use the result directly. The operation will
13542+
convert the key to a string if it is not already, and parse it as
13543+
an integer whose value will be used as the key. Some input key
13544+
types might not be relevant here (e.g. IP addresses).
1354213545

1354313546
&lt;modifier&gt; indicates an optional method applied after hashing the key :
1354413547

@@ -23308,6 +23311,21 @@ <h2 id="chapter-5.2" data-target="5.2"><small><a class="small" href="#5.2">5.2.<
2330823311
better only use values comprised between 1 and this value to
2330923312
avoid overlap.
2331023313

23314+
id32 The node keys will be derived from the server's numeric
23315+
identifier as set from &quot;<span class="dropdown"><a class="dropdown-toggle" data-toggle="dropdown" href="#">id<span class="caret"></span></a><ul class="dropdown-menu"><li class="dropdown-header">This keyword is available in sections :</li><li><a href="#id%20%28Alphabetically%20sorted%20keywords%20reference%29">Alphabetically sorted keywords reference</a></li><li><a href="#id%20%28Bind%20options%29">Bind options</a></li><li><a href="#id%20%28Server%20and%20default-server%20options%29">Server and default-server options</a></li></ul></span>&quot; or which defaults to its position
23316+
in the server list, but the full 32 bits of the ID will be
23317+
used so that there is no collision. This one is not scaled
23318+
like &quot;<span class="dropdown"><a class="dropdown-toggle" data-toggle="dropdown" href="#">id<span class="caret"></span></a><ul class="dropdown-menu"><li class="dropdown-header">This keyword is available in sections :</li><li><a href="#id%20%28Alphabetically%20sorted%20keywords%20reference%29">Alphabetically sorted keywords reference</a></li><li><a href="#id%20%28Bind%20options%29">Bind options</a></li><li><a href="#id%20%28Server%20and%20default-server%20options%29">Server and default-server options</a></li></ul></span>&quot; is, so it is recommended to either always use it
23319+
with a hash function (see &quot;<a href="#hash-key">hash-key</a>&quot;) or with explicitly
23320+
assigned ID values that are evenly distributed over the 32-bit
23321+
space.
23322+
23323+
guid The node keys will be derived from the server's guid, when
23324+
available, otherwise they will fall back on &quot;<span class="dropdown"><a class="dropdown-toggle" data-toggle="dropdown" href="#">id<span class="caret"></span></a><ul class="dropdown-menu"><li class="dropdown-header">This keyword is available in sections :</li><li><a href="#id%20%28Alphabetically%20sorted%20keywords%20reference%29">Alphabetically sorted keywords reference</a></li><li><a href="#id%20%28Bind%20options%29">Bind options</a></li><li><a href="#id%20%28Server%20and%20default-server%20options%29">Server and default-server options</a></li></ul></span>&quot;. The benefit
23325+
is that it does not depend on ordering at all, only on an
23326+
internal stable identifier that can be replicated across many
23327+
load balancers.
23328+
2331123329
addr The node keys will be derived from the server's address, when
2331223330
available, or else fall back on &quot;<span class="dropdown"><a class="dropdown-toggle" data-toggle="dropdown" href="#">id<span class="caret"></span></a><ul class="dropdown-menu"><li class="dropdown-header">This keyword is available in sections :</li><li><a href="#id%20%28Alphabetically%20sorted%20keywords%20reference%29">Alphabetically sorted keywords reference</a></li><li><a href="#id%20%28Bind%20options%29">Bind options</a></li><li><a href="#id%20%28Server%20and%20default-server%20options%29">Server and default-server options</a></li></ul></span>&quot;.
2331323331

@@ -23332,9 +23350,13 @@ <h2 id="chapter-5.2" data-target="5.2"><small><a class="small" href="#5.2">5.2.<
2333223350
section&quot;.
2333323351
</pre><a class="anchor" name="id"></a><a class="anchor" name="5-id"></a><a class="anchor" name="5.2-id"></a><a class="anchor" name="id (Bind and server options)"></a><a class="anchor" name="id (Server and default-server options)"></a><div class="keyword"><b><a class="anchor" name="id"></a><a href="#5.2-id">id</a></b> <span style="color: #080">&lt;value&gt;</span></div><pre class="text">May be used in the following contexts: tcp, http, log
2333423352

23335-
Set a persistent ID for the server. This ID must be positive and unique for
23336-
the proxy. An unused ID will automatically be assigned if unset. The first
23337-
assigned value will be 1. This ID is currently only returned in statistics.
23353+
Set a persistent ID for the server. This ID must be a 32-bit positive number
23354+
and unique for the proxy. An unused ID will automatically be assigned if
23355+
unset. The first assigned value will be 1. This ID is currently only returned
23356+
in statistics, and is used to place LB nodes when using consistent hash
23357+
algorithms when &quot;<a href="#hash-key">hash-key</a>&quot; is set to &quot;<span class="dropdown"><a class="dropdown-toggle" data-toggle="dropdown" href="#">id<span class="caret"></span></a><ul class="dropdown-menu"><li class="dropdown-header">This keyword is available in sections :</li><li><a href="#id%20%28Alphabetically%20sorted%20keywords%20reference%29">Alphabetically sorted keywords reference</a></li><li><a href="#id%20%28Bind%20options%29">Bind options</a></li><li><a href="#id%20%28Server%20and%20default-server%20options%29">Server and default-server options</a></li></ul></span>&quot; (the default). In this case, only
23358+
the 28 lowest bits of the value are used (i.e. (id % 268435356)), so better
23359+
only use values comprised between 1 and this value to avoid overlap.
2333823360
</pre><a class="anchor" name="idle-ping"></a><a class="anchor" name="5-idle-ping"></a><a class="anchor" name="5.2-idle-ping"></a><a class="anchor" name="idle-ping (Bind and server options)"></a><a class="anchor" name="idle-ping (Server and default-server options)"></a><div class="keyword"><b><a class="anchor" name="idle-ping"></a><a href="#5.2-idle-ping">idle-ping</a></b> <span style="color: #080">&lt;delay&gt;</span></div><pre class="text">May be used in the following contexts: tcp, http, log
2333923361

2334023362
Define an interval for periodic liveliness on idle backend connections. If
@@ -23411,27 +23433,32 @@ <h2 id="chapter-5.2" data-target="5.2"><small><a class="small" href="#5.2">5.2.<
2341123433
effect to extend the effective check interval. In such a case, reducing the
2341223434
&quot;<a href="#inter">inter</a>&quot; setting will have a very limited effect as it will not be able to
2341323435
reduce the time spent in the queue.
23414-
</pre><a class="anchor" name="init-state"></a><a class="anchor" name="5-init-state"></a><a class="anchor" name="5.2-init-state"></a><a class="anchor" name="init-state (Bind and server options)"></a><a class="anchor" name="init-state (Server and default-server options)"></a><div class="keyword"><b><a class="anchor" name="init-state"></a><a href="#5.2-init-state">init-state</a></b> <span style="color: #800">{ fully-up | up | down | fully-down }</span></div><pre class="text">May be used in the following contexts: tcp, http
23436+
</pre><a class="anchor" name="init-state"></a><a class="anchor" name="5-init-state"></a><a class="anchor" name="5.2-init-state"></a><a class="anchor" name="init-state (Bind and server options)"></a><a class="anchor" name="init-state (Server and default-server options)"></a><div class="keyword"><b><a class="anchor" name="init-state"></a><a href="#5.2-init-state">init-state</a></b> <span style="color: #800">{ fully-up | up | down | fully-down | none }</span></div><pre class="text">May be used in the following contexts: tcp, http
2341523437
</pre><div><p> May be used in sections :</p><table class="table table-bordered" border="0" cellspacing="0" cellpadding="0">
2341623438
<thead><tr><th>defaults</th><th>frontend</th><th>listen</th><th>backend</th></tr></thead>
2341723439
<tr><td class="alert-error pagination-centered">no<br /><img src="../css/cross.png" alt="no" title="no" /></td><td class="alert-error pagination-centered">no<br /><img src="../css/cross.png" alt="no" title="no" /></td><td class="alert-success pagination-centered">yes<br /><img src="../css/check.png" alt="yes" title="yes" /></td><td class="alert-success pagination-centered">yes<br /><img src="../css/check.png" alt="yes" title="yes" /></td></tr>
2341823440
</table></div>
2341923441
<pre class="text">The &quot;<a href="#init-state">init-state</a>&quot; option sets the initial state of the server:
2342023442
- when set to 'fully-up', the server is considered immediately available
23421-
and can turn to the DOWN state when ALL health checks fail.
23422-
- when set to 'up' (the default), the server is considered immediately
23423-
available and will initiate a health check that can turn it to the DOWN
23424-
state immediately if it fails.
23425-
- when set to 'down', the server initially is considered unavailable and
23426-
will initiate a health check that can turn it to the UP state immediately
23427-
if it succeeds.
23443+
and, if health checks are enabled for this server, it will be turned to
23444+
the DOWN state when ALL health checks fail.
23445+
- when set to 'up', the server is considered immediately available and, if
23446+
health checks are enabled for this server, it will be turned to the DOWN
23447+
state immediately if the next health check fails.
23448+
- when set to 'down', the server initially is considered unavailable and,
23449+
if health checks are enabled for this server, it can be turned to the UP
23450+
state if the next health check succeeds.
2342823451
- when set to 'fully-down', the server is initially considered unavailable
23429-
and can turn to the UP state when ALL health checks succeed.
23452+
and, if health checks are enabled for this server, it will turned to the
23453+
UP state when ALL health checks succeed.
23454+
- when set to 'none' (the default value), init-state management is
23455+
disabled. It can be used to restore the default behavior when this
23456+
parameter was inherited from a 'default-server' directive.
2343023457

2343123458
The server's init-state is considered when the HAProxy instance is
2343223459
(re)started, a new server is detected (for example via service discovery /
2343323460
DNS resolution), a dynamic server is inlived, a server exits maintenance,
23434-
etc.
23461+
etc. This directive cannot be used when the server is tracking another one.
2343523462
</pre><div class="separator">
2343623463
<span class="label label-success">Examples:</span>
2343723464
<pre class="prettyprint">
@@ -24468,7 +24495,11 @@ <h3 id="chapter-5.3.2" data-target="5.3.2"><small><a class="small" href="#5.3.2"
2446824495
As a DNS server may not answer all the IPs in one DNS request, HAProxy keeps
2446924496
a cache of previous answers, an answer will be considered obsolete after
2447024497
&lt;hold obsolete&gt; seconds without the IP returned.
24471-
</pre><a class="anchor" name="resolvers"></a><a class="anchor" name="5-resolvers"></a><a class="anchor" name="5.3.2-resolvers"></a><a class="anchor" name="resolvers (Bind and server options)"></a><a class="anchor" name="resolvers (The resolvers section)"></a><div class="keyword"><b><a class="anchor" name="resolvers"></a><a href="#5.3.2-resolvers">resolvers</a></b> <span style="color: #080">&lt;resolvers id&gt;</span></div><pre class="text"> Creates a new name server list labeled &lt;resolvers id&gt;
24498+
</pre><a class="anchor" name="resolvers"></a><a class="anchor" name="5-resolvers"></a><a class="anchor" name="5.3.2-resolvers"></a><a class="anchor" name="resolvers (Bind and server options)"></a><a class="anchor" name="resolvers (The resolvers section)"></a><div class="keyword"><b><a class="anchor" name="resolvers"></a><a href="#5.3.2-resolvers">resolvers</a></b> <span style="color: #080">&lt;resolvers id&gt;</span></div><pre class="text"> Creates a new name server list labeled &lt;resolvers id&gt;. As mentioned above,
24499+
the special name &quot;default&quot; always exists and will be automatically created if
24500+
not explicitly declared; this will be the one internal services such as
24501+
httpclient rely on. Declaring a &quot;default&quot; entry will affect how such services
24502+
perform their name resolution.
2447224503

2447324504
A resolvers section accept the following parameters:
2447424505
</pre><a class="anchor" name="accepted_payload_size"></a><a class="anchor" name="5-accepted_payload_size"></a><a class="anchor" name="5.3.2-accepted_payload_size"></a><a class="anchor" name="accepted_payload_size (Bind and server options)"></a><a class="anchor" name="accepted_payload_size (The resolvers section)"></a><div class="keyword"><b><a class="anchor" name="accepted_payload_size"></a><a href="#5.3.2-accepted_payload_size">accepted_payload_size</a></b> <span style="color: #080">&lt;nb&gt;</span></div><pre class="text">Defines the maximum payload size accepted by HAProxy and announced to all the
@@ -35611,7 +35642,7 @@ <h2 id="chapter-12.9" data-target="12.9"><small><a class="small" href="#12.9">12
3561135642
<br>
3561235643
<hr>
3561335644
<div class="text-right">
35614-
HAProxy 3.4-dev12-30 &ndash; Configuration Manual<br>
35645+
HAProxy 3.4-dev12-53 &ndash; Configuration Manual<br>
3561535646
<small>, 2026/05/13</small>
3561635647
</div>
3561735648
</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-dev12-30 - Starter Guide</title>
5+
<title>HAProxy version 3.4-dev12-53 - 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/05/13</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/05/19</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-dev12-30</strong></p>
498+
<p><strong>version 3.4-dev12-53</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-dev12-30 &ndash; Starter Guide<br>
2518+
HAProxy 3.4-dev12-53 &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-dev12-30 - Management Guide</title>
5+
<title>HAProxy version 3.4-dev12-53 - 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/05/13</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/05/19</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-dev12-30</strong></p>
710+
<p><strong>version 3.4-dev12-53</strong></p>
711711
<p>
712712
<br>
713713

@@ -5856,7 +5856,7 @@ <h2 id="chapter-13.1" data-target="13.1"><small><a class="small" href="#13.1">13
58565856
<br>
58575857
<hr>
58585858
<div class="text-right">
5859-
HAProxy 3.4-dev12-30 &ndash; Management Guide<br>
5859+
HAProxy 3.4-dev12-53 &ndash; Management Guide<br>
58605860
<small>, </small>
58615861
</div>
58625862
</div>

0 commit comments

Comments
 (0)