Skip to content

Commit e7d848c

Browse files
author
HAProxy Community
committed
Update docs for 3.1
1 parent 863f0dc commit e7d848c

3 files changed

Lines changed: 51 additions & 27 deletions

File tree

docs/3.1/configuration.html

Lines changed: 43 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.1.7-1 - Configuration Manual</title>
5+
<title>HAProxy version 3.1.7-44 - 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" />
@@ -4430,7 +4430,7 @@
44304430
You can use <strong>left</strong> and <strong>right</strong> arrow keys to navigate between chapters.<br>
44314431
</p>
44324432
<p class="text-right">
4433-
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2025/04/17</b></small>
4433+
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2025/05/15</b></small>
44344434
</p>
44354435
</div>
44364436
<!-- /.sidebar -->
@@ -4441,7 +4441,7 @@
44414441
<div class="text-center">
44424442
<h1><a href="http://www.haproxy.org/" title="HAProxy"><img src="../img/HAProxyCommunityEdition_60px.png?0.4.2-15" /></a></h1>
44434443
<h2>Configuration Manual</h2>
4444-
<p><strong>version 3.1.7-1</strong></p>
4444+
<p><strong>version 3.1.7-44</strong></p>
44454445
<p>
44464446
2025/04/17<br>
44474447

@@ -10199,7 +10199,7 @@ <h2 id="chapter-3.9" data-target="3.9"><small><a class="small" href="#3.9">3.9.<
1019910199

1020010200
ring myring
1020110201
description &quot;My local buffer&quot;
10202-
format rfc3164
10202+
format rfc5424
1020310203
maxlen 1200
1020410204
size 32764
1020510205
timeout connect 5s
@@ -22075,15 +22075,20 @@ <h2 id="chapter-5.2" data-target="5.2"><small><a class="small" href="#5.2">5.2.<
2207522075
instances on the fly. This option defaults to &quot;last,libc&quot; indicating that the
2207622076
previous address found in the state file (if any) is used first, otherwise
2207722077
the libc's resolver is used. This ensures continued compatibility with the
22078-
historic behavior.
22079-
</pre><div class="separator">
22080-
<span class="label label-success">Example:</span>
22081-
<pre class="prettyprint">
22082-
<code>defaults
22083-
<span class="comment"># never fail on address resolution</span>
22084-
default-server init-addr last,libc,none
22085-
</code></pre>
22086-
</div><a class="anchor" name="inter"></a><a class="anchor" name="5-inter"></a><a class="anchor" name="5.2-inter"></a><a class="anchor" name="inter (Bind and server options)"></a><a class="anchor" name="inter (Server and default-server options)"></a><div class="keyword"><b><a class="anchor" name="inter"></a><a href="#5.2-inter">inter</a></b> <span style="color: #080">&lt;delay&gt;</span></div><a class="anchor" name="fastinter"></a><a class="anchor" name="5-fastinter"></a><a class="anchor" name="5.2-fastinter"></a><a class="anchor" name="fastinter (Bind and server options)"></a><a class="anchor" name="fastinter (Server and default-server options)"></a><div class="keyword"><b><a class="anchor" name="fastinter"></a><a href="#5.2-fastinter">fastinter</a></b> <span style="color: #080">&lt;delay&gt;</span></div><a class="anchor" name="downinter"></a><a class="anchor" name="5-downinter"></a><a class="anchor" name="5.2-downinter"></a><a class="anchor" name="downinter (Bind and server options)"></a><a class="anchor" name="downinter (Server and default-server options)"></a><div class="keyword"><b><a class="anchor" name="downinter"></a><a href="#5.2-downinter">downinter</a></b> <span style="color: #080">&lt;delay&gt;</span></div><pre class="text">May be used in the following contexts: tcp, http, log
22078+
historic behavior. When using internal resolvers, it is generally recommended
22079+
to either disable libc-based resolution, or make it explicit (see <a href="#5.3">section 5.3</a>
22080+
for more details).
22081+
22082+
Example 1:
22083+
defaults
22084+
# never fail on address resolution
22085+
default-server init-addr last,libc,none
22086+
22087+
Example 2:
22088+
defaults
22089+
# disable libc resolution in combination with resolvers
22090+
default-server init-addr last,none
22091+
</pre><a class="anchor" name="inter"></a><a class="anchor" name="5-inter"></a><a class="anchor" name="5.2-inter"></a><a class="anchor" name="inter (Bind and server options)"></a><a class="anchor" name="inter (Server and default-server options)"></a><div class="keyword"><b><a class="anchor" name="inter"></a><a href="#5.2-inter">inter</a></b> <span style="color: #080">&lt;delay&gt;</span></div><a class="anchor" name="fastinter"></a><a class="anchor" name="5-fastinter"></a><a class="anchor" name="5.2-fastinter"></a><a class="anchor" name="fastinter (Bind and server options)"></a><a class="anchor" name="fastinter (Server and default-server options)"></a><div class="keyword"><b><a class="anchor" name="fastinter"></a><a href="#5.2-fastinter">fastinter</a></b> <span style="color: #080">&lt;delay&gt;</span></div><a class="anchor" name="downinter"></a><a class="anchor" name="5-downinter"></a><a class="anchor" name="5.2-downinter"></a><a class="anchor" name="downinter (Bind and server options)"></a><a class="anchor" name="downinter (Server and default-server options)"></a><div class="keyword"><b><a class="anchor" name="downinter"></a><a href="#5.2-downinter">downinter</a></b> <span style="color: #080">&lt;delay&gt;</span></div><pre class="text">May be used in the following contexts: tcp, http, log
2208722092

2208822093
The &quot;<a href="#inter">inter</a>&quot; parameter sets the interval between two consecutive health checks
2208922094
to &lt;delay&gt; milliseconds. If left unspecified, the delay defaults to 2000 ms.
@@ -22624,13 +22629,16 @@ <h2 id="chapter-5.2" data-target="5.2"><small><a class="small" href="#5.2">5.2.<
2262422629
</div><a class="anchor" name="resolvers"></a><a class="anchor" name="5-resolvers"></a><a class="anchor" name="5.2-resolvers"></a><a class="anchor" name="resolvers (Bind and server options)"></a><a class="anchor" name="resolvers (Server and default-server options)"></a><div class="keyword"><b><a class="anchor" name="resolvers"></a><a href="#5.2-resolvers">resolvers</a></b> <span style="color: #080">&lt;id&gt;</span></div><pre class="text">May be used in the following contexts: tcp, http, log
2262522630

2262622631
Points to an existing &quot;<span class="dropdown"><a class="dropdown-toggle" data-toggle="dropdown" href="#">resolvers<span class="caret"></span></a><ul class="dropdown-menu"><li class="dropdown-header">This keyword is available in sections :</li><li><a href="#resolvers%20%28Server%20and%20default-server%20options%29">Server and default-server options</a></li><li><a href="#resolvers%20%28The%20resolvers%20section%29">The resolvers section</a></li></ul></span>&quot; section to resolve current server's
22627-
hostname.
22632+
hostname. It is often recommended to disable libc-based resolution when using
22633+
resolvers, though exceptions exist (see <a href="#5.3.1">section 5.3.1</a>). In any case it is a
22634+
good practice to explicitly specify &quot;<a href="#init-addr">init-addr</a>&quot; when using resolvers in order
22635+
not to overlook this element.
2262822636
</pre><div class="separator">
2262922637
<span class="label label-success">Example:</span>
2263022638
<pre class="prettyprint">
22631-
<code>server s1 app1.domain.com:80 check resolvers mydns
22639+
<code>server s1 app1.domain.com:80 init-addr last,none check resolvers mydns
2263222640
</code></pre>
22633-
</div><pre class="text">See also <a href="#5.3">section 5.3</a>
22641+
</div><pre class="text">See also <a href="#5.3">section 5.3</a> for implementation details and traps to be aware of.
2263422642
</pre><a class="anchor" name="send-proxy"></a><a class="anchor" name="5-send-proxy"></a><a class="anchor" name="5.2-send-proxy"></a><a class="anchor" name="send-proxy (Bind and server options)"></a><a class="anchor" name="send-proxy (Server and default-server options)"></a><div class="keyword"><b><a class="anchor" name="send-proxy"></a><a href="#5.2-send-proxy">send-proxy</a></b></div><pre class="text">May be used in the following contexts: tcp, http
2263522643

2263622644
The &quot;<a href="#send-proxy">send-proxy</a>&quot; parameter enforces use of the PROXY protocol over any
@@ -22953,10 +22961,13 @@ <h2 id="chapter-5.3" data-target="5.3"><small><a class="small" href="#5.3">5.3.<
2295322961
This is not sufficient in some cases, such as in Amazon where a server's IP
2295422962
can change after a reboot or an ELB Virtual IP can change based on current
2295522963
workload.
22964+
2295622965
This chapter describes how HAProxy can be configured to process server's name
2295722966
resolution at run time.
22958-
Whether run time server name resolution has been enable or not, HAProxy will
22959-
carry on doing the first resolution when parsing the configuration.
22967+
22968+
Whether run time server name resolution has been enable or not, by default
22969+
HAProxy will do the first resolution at startup during configuration parsing
22970+
via libc unless disabled by the &quot;<a href="#init-addr">init-addr</a>&quot; parameter.
2296022971
</pre></div>
2296122972
<a class="anchor" id="5.3.1" name="5.3.1"></a>
2296222973
<h3 id="chapter-5.3.1" data-target="5.3.1"><small><a class="small" href="#5.3.1">5.3.1.</a></small> Global overview</h3>
@@ -22988,6 +22999,17 @@ <h3 id="chapter-5.3.1" data-target="5.3.1"><small><a class="small" href="#5.3.1"
2298822999

2298923000
- a resolution is considered as invalid (NX, timeout, refused), when all the
2299023001
servers return an error.
23002+
23003+
- The DNS client implemented in HAProxy is very basic and will not understand
23004+
the vast number of options and advanced setups that an operating system's
23005+
resolver can deal with. As such, except for really trivial setups where a
23006+
server known by its FQDN only has exactly one IP address at a time and
23007+
might occasionally renew it (e.g. a reboot), it is highly recommended to
23008+
avoid mixing libc-based init-time resolution with DNS-based runtime
23009+
resolution, as such setups are known to cause failures upon address
23010+
renewal. As a conclusion, unless you know exactly what you are doing, you
23011+
should always exclude &quot;libc&quot; from &quot;<a href="#init-addr">init-addr</a>&quot; when using &quot;<span class="dropdown"><a class="dropdown-toggle" data-toggle="dropdown" href="#">resolvers<span class="caret"></span></a><ul class="dropdown-menu"><li class="dropdown-header">This keyword is available in sections :</li><li><a href="#resolvers%20%28Server%20and%20default-server%20options%29">Server and default-server options</a></li><li><a href="#resolvers%20%28The%20resolvers%20section%29">The resolvers section</a></li></ul></span>&quot; on a
23012+
server line.
2299123013
</pre></div>
2299223014
<a class="anchor" id="5.3.2" name="5.3.2"></a>
2299323015
<h3 id="chapter-5.3.2" data-target="5.3.2"><small><a class="small" href="#5.3.2">5.3.2.</a></small> The resolvers section</h3>
@@ -23114,6 +23136,8 @@ <h3 id="chapter-5.3.2" data-target="5.3.2"><small><a class="small" href="#5.3.2"
2311423136
valid status from the DNS server.
2311523137

2311623138
A separate behavior exists for &quot;hold valid&quot; and &quot;hold obsolete&quot;.
23139+
23140+
Default value is 10s for &quot;valid&quot;, 0s for &quot;obsolete&quot; and 30s for others.
2311723141
</pre><a class="anchor" name="resolve_retries"></a><a class="anchor" name="5-resolve_retries"></a><a class="anchor" name="5.3.2-resolve_retries"></a><a class="anchor" name="resolve_retries (Bind and server options)"></a><a class="anchor" name="resolve_retries (The resolvers section)"></a><div class="keyword"><b><a class="anchor" name="resolve_retries"></a><a href="#5.3.2-resolve_retries">resolve_retries</a></b> <span style="color: #080">&lt;nb&gt;</span></div><pre class="text">Defines the number &lt;nb&gt; of queries to send to resolve a server name before
2311823142
giving up.
2311923143
Default value: 3
@@ -31759,7 +31783,7 @@ <h2 id="chapter-11.3" data-target="11.3"><small><a class="small" href="#11.3">11
3175931783
<br>
3176031784
<hr>
3176131785
<div class="text-right">
31762-
HAProxy 3.1.7-1 &ndash; Configuration Manual<br>
31786+
HAProxy 3.1.7-44 &ndash; Configuration Manual<br>
3176331787
<small>, 2025/04/17</small>
3176431788
</div>
3176531789
</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.7-1 - Starter Guide</title>
5+
<title>HAProxy version 3.1.7-44 - 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/04/17</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/05/15</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.7-1</strong></p>
498+
<p><strong>version 3.1.7-44</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.7-1 &ndash; Starter Guide<br>
2518+
HAProxy 3.1.7-44 &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.7-1 - Management Guide</title>
5+
<title>HAProxy version 3.1.7-44 - 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/04/17</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/05/15</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.7-1</strong></p>
666+
<p><strong>version 3.1.7-44</strong></p>
667667
<p>
668668
<br>
669669

@@ -5405,7 +5405,7 @@ <h2 id="chapter-13.1" data-target="13.1"><small><a class="small" href="#13.1">13
54055405
<br>
54065406
<hr>
54075407
<div class="text-right">
5408-
HAProxy 3.1.7-1 &ndash; Management Guide<br>
5408+
HAProxy 3.1.7-44 &ndash; Management Guide<br>
54095409
<small>, </small>
54105410
</div>
54115411
</div>

0 commit comments

Comments
 (0)