Skip to content

Commit 40ef8ac

Browse files
author
HAProxy Community
committed
Update docs for 3.0
1 parent 16d0b72 commit 40ef8ac

File tree

3 files changed

+51
-27
lines changed

3 files changed

+51
-27
lines changed

docs/3.0/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.0.10-1 - Configuration Manual</title>
5+
<title>HAProxy version 3.0.10-32 - 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" />
@@ -4327,7 +4327,7 @@
43274327
You can use <strong>left</strong> and <strong>right</strong> arrow keys to navigate between chapters.<br>
43284328
</p>
43294329
<p class="text-right">
4330-
<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/22</b></small>
4330+
<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/20</b></small>
43314331
</p>
43324332
</div>
43334333
<!-- /.sidebar -->
@@ -4338,7 +4338,7 @@
43384338
<div class="text-center">
43394339
<h1><a href="http://www.haproxy.org/" title="HAProxy"><img src="../img/HAProxyCommunityEdition_60px.png?0.4.2-15" /></a></h1>
43404340
<h2>Configuration Manual</h2>
4341-
<p><strong>version 3.0.10-1</strong></p>
4341+
<p><strong>version 3.0.10-32</strong></p>
43424342
<p>
43434343
2025/04/22<br>
43444344

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

96679667
ring myring
96689668
description &quot;My local buffer&quot;
9669-
format rfc3164
9669+
format rfc5424
96709670
maxlen 1200
96719671
size 32764
96729672
timeout connect 5s
@@ -21347,15 +21347,20 @@ <h2 id="chapter-5.2" data-target="5.2"><small><a class="small" href="#5.2">5.2.<
2134721347
instances on the fly. This option defaults to &quot;last,libc&quot; indicating that the
2134821348
previous address found in the state file (if any) is used first, otherwise
2134921349
the libc's resolver is used. This ensures continued compatibility with the
21350-
historic behavior.
21351-
</pre><div class="separator">
21352-
<span class="label label-success">Example:</span>
21353-
<pre class="prettyprint">
21354-
<code>defaults
21355-
<span class="comment"># never fail on address resolution</span>
21356-
default-server init-addr last,libc,none
21357-
</code></pre>
21358-
</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
21350+
historic behavior. When using internal resolvers, it is generally recommended
21351+
to either disable libc-based resolution, or make it explicit (see <a href="#5.3">section 5.3</a>
21352+
for more details).
21353+
21354+
Example 1:
21355+
defaults
21356+
# never fail on address resolution
21357+
default-server init-addr last,libc,none
21358+
21359+
Example 2:
21360+
defaults
21361+
# disable libc resolution in combination with resolvers
21362+
default-server init-addr last,none
21363+
</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
2135921364

2136021365
The &quot;<a href="#inter">inter</a>&quot; parameter sets the interval between two consecutive health checks
2136121366
to &lt;delay&gt; milliseconds. If left unspecified, the delay defaults to 2000 ms.
@@ -21828,13 +21833,16 @@ <h2 id="chapter-5.2" data-target="5.2"><small><a class="small" href="#5.2">5.2.<
2182821833
</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
2182921834

2183021835
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
21831-
hostname.
21836+
hostname. It is often recommended to disable libc-based resolution when using
21837+
resolvers, though exceptions exist (see <a href="#5.3.1">section 5.3.1</a>). In any case it is a
21838+
good practice to explicitly specify &quot;<a href="#init-addr">init-addr</a>&quot; when using resolvers in order
21839+
not to overlook this element.
2183221840
</pre><div class="separator">
2183321841
<span class="label label-success">Example:</span>
2183421842
<pre class="prettyprint">
21835-
<code>server s1 app1.domain.com:80 check resolvers mydns
21843+
<code>server s1 app1.domain.com:80 init-addr last,none check resolvers mydns
2183621844
</code></pre>
21837-
</div><pre class="text">See also <a href="#5.3">section 5.3</a>
21845+
</div><pre class="text">See also <a href="#5.3">section 5.3</a> for implementation details and traps to be aware of.
2183821846
</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
2183921847

2184021848
The &quot;<a href="#send-proxy">send-proxy</a>&quot; parameter enforces use of the PROXY protocol over any
@@ -22157,10 +22165,13 @@ <h2 id="chapter-5.3" data-target="5.3"><small><a class="small" href="#5.3">5.3.<
2215722165
This is not sufficient in some cases, such as in Amazon where a server's IP
2215822166
can change after a reboot or an ELB Virtual IP can change based on current
2215922167
workload.
22168+
2216022169
This chapter describes how HAProxy can be configured to process server's name
2216122170
resolution at run time.
22162-
Whether run time server name resolution has been enable or not, HAProxy will
22163-
carry on doing the first resolution when parsing the configuration.
22171+
22172+
Whether run time server name resolution has been enable or not, by default
22173+
HAProxy will do the first resolution at startup during configuration parsing
22174+
via libc unless disabled by the &quot;<a href="#init-addr">init-addr</a>&quot; parameter.
2216422175
</pre></div>
2216522176
<a class="anchor" id="5.3.1" name="5.3.1"></a>
2216622177
<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>
@@ -22192,6 +22203,17 @@ <h3 id="chapter-5.3.1" data-target="5.3.1"><small><a class="small" href="#5.3.1"
2219222203

2219322204
- a resolution is considered as invalid (NX, timeout, refused), when all the
2219422205
servers return an error.
22206+
22207+
- The DNS client implemented in HAProxy is very basic and will not understand
22208+
the vast number of options and advanced setups that an operating system's
22209+
resolver can deal with. As such, except for really trivial setups where a
22210+
server known by its FQDN only has exactly one IP address at a time and
22211+
might occasionally renew it (e.g. a reboot), it is highly recommended to
22212+
avoid mixing libc-based init-time resolution with DNS-based runtime
22213+
resolution, as such setups are known to cause failures upon address
22214+
renewal. As a conclusion, unless you know exactly what you are doing, you
22215+
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
22216+
server line.
2219522217
</pre></div>
2219622218
<a class="anchor" id="5.3.2" name="5.3.2"></a>
2219722219
<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>
@@ -22318,6 +22340,8 @@ <h3 id="chapter-5.3.2" data-target="5.3.2"><small><a class="small" href="#5.3.2"
2231822340
valid status from the DNS server.
2231922341

2232022342
A separate behavior exists for &quot;hold valid&quot; and &quot;hold obsolete&quot;.
22343+
22344+
Default value is 10s for &quot;valid&quot;, 0s for &quot;obsolete&quot; and 30s for others.
2232122345
</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
2232222346
giving up.
2232322347
Default value: 3
@@ -30753,7 +30777,7 @@ <h2 id="chapter-11.3" data-target="11.3"><small><a class="small" href="#11.3">11
3075330777
<br>
3075430778
<hr>
3075530779
<div class="text-right">
30756-
HAProxy 3.0.10-1 &ndash; Configuration Manual<br>
30780+
HAProxy 3.0.10-32 &ndash; Configuration Manual<br>
3075730781
<small>, 2025/04/22</small>
3075830782
</div>
3075930783
</div>

docs/3.0/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.0.10-1 - Starter Guide</title>
5+
<title>HAProxy version 3.0.10-32 - 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/22</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/20</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.0.10-1</strong></p>
498+
<p><strong>version 3.0.10-32</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.0.10-1 &ndash; Starter Guide<br>
2518+
HAProxy 3.0.10-32 &ndash; Starter Guide<br>
25192519
<small>, </small>
25202520
</div>
25212521
</div>

docs/3.0/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.0.10-1 - Management Guide</title>
5+
<title>HAProxy version 3.0.10-32 - 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" />
@@ -646,7 +646,7 @@
646646
You can use <strong>left</strong> and <strong>right</strong> arrow keys to navigate between chapters.<br>
647647
</p>
648648
<p class="text-right">
649-
<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/22</b></small>
649+
<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/20</b></small>
650650
</p>
651651
</div>
652652
<!-- /.sidebar -->
@@ -657,7 +657,7 @@
657657
<div class="text-center">
658658
<h1><a href="http://www.haproxy.org/" title="HAProxy"><img src="../img/HAProxyCommunityEdition_60px.png?0.4.2-15" /></a></h1>
659659
<h2>Management Guide</h2>
660-
<p><strong>version 3.0.10-1</strong></p>
660+
<p><strong>version 3.0.10-32</strong></p>
661661
<p>
662662
<br>
663663

@@ -5313,7 +5313,7 @@ <h2 id="chapter-13.1" data-target="13.1"><small><a class="small" href="#13.1">13
53135313
<br>
53145314
<hr>
53155315
<div class="text-right">
5316-
HAProxy 3.0.10-1 &ndash; Management Guide<br>
5316+
HAProxy 3.0.10-32 &ndash; Management Guide<br>
53175317
<small>, </small>
53185318
</div>
53195319
</div>

0 commit comments

Comments
 (0)