Skip to content

Commit b8ae72e

Browse files
author
HAProxy Community
committed
Update docs for dev
1 parent 578902e commit b8ae72e

3 files changed

Lines changed: 42 additions & 19 deletions

File tree

‎docs/dev/configuration.html‎

Lines changed: 19 additions & 9 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.5-dev3-150 - Configuration Manual</title>
5+
<title>HAProxy version 3.5-dev3-157 - 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" />
@@ -4900,7 +4900,7 @@
49004900
You can use <strong>left</strong> and <strong>right</strong> arrow keys to navigate between chapters.<br>
49014901
</p>
49024902
<p class="text-right">
4903-
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2026/08/04</b></small>
4903+
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2026/08/05</b></small>
49044904
</p>
49054905
</div>
49064906
<!-- /.sidebar -->
@@ -4911,7 +4911,7 @@
49114911
<div class="text-center">
49124912
<h1><a href="http://www.haproxy.org/" title="HAProxy"><img src="../img/HAProxyCommunityEdition_60px.png?0.4.2-15" /></a></h1>
49134913
<h2>Configuration Manual</h2>
4914-
<p><strong>version 3.5-dev3-150</strong></p>
4914+
<p><strong>version 3.5-dev3-157</strong></p>
49154915
<p>
49164916
2026/07/22<br>
49174917

@@ -9964,7 +9964,8 @@ <h2 id="chapter-3.2" data-target="3.2"><small><a class="small" href="#3.2">3.2.<
99649964

99659965
Default-server instances are kept in memory after parsing as they may be
99669966
reused for dynamic servers added at runtime. Similarly, named defaults
9967-
proxies sections are preserved as dynamic backends rely on them.
9967+
proxies sections are preserved as dynamic backends rely on them. The command
9968+
&quot;show default-server&quot; and &quot;show defaults&quot; may be used to list them.
99689969

99699970
This may consume a noticeable amount of memory if the number of default
99709971
instances is important. It's possible to reclaim this memory after the
@@ -11375,6 +11376,11 @@ <h2 id="chapter-3.4" data-target="3.4"><small><a class="small" href="#3.4">3.4.<
1137511376
profiles to carry groups of default settings (e.g. TCP vs HTTP or short vs long
1137611377
timeouts) but can quickly become confusing to follow.
1137711378

11379+
By default, named defaults sections are preserved after configuration parsing.
11380+
This allows to reuse them for dynamic backends creation. This behavior can be
11381+
changed globally via &quot;<a href="#tune.defaults.purge">tune.defaults.purge</a>&quot; keyword. It is possible to list the
11382+
preserved instances via the command &quot;show defaults&quot;.
11383+
1137811384
All proxy names must be formed from upper and lower case letters, digits,
1137911385
'-' (dash), '_' (underscore) , '.' (dot) and ':' (colon). ACL names are
1138011386
case-sensitive, which means that &quot;www&quot; and &quot;WWW&quot; are two different proxies.
@@ -12778,10 +12784,14 @@ <h2 id="chapter-4.2" data-target="4.2"><small><a class="small" href="#4.2">4.2.<
1277812784
completing the previous one. This set of options can be reset by using the
1277912785
&quot;from none&quot; keyword value.
1278012786

12781-
An unnamed default-server with no parameter set will automatically be purged
12782-
after parsing. As such, a final &quot;default-server from none&quot; statement will be
12783-
sufficient to release this unused memory, regardless of the global setting
12784-
&quot;<a href="#tune.defaults.purge">tune.defaults.purge</a>&quot; value.
12787+
By default, all default-server named and unnamed are preserved after
12788+
configuration parsing. This allows to reuse them for dynamic servers
12789+
creation. This behavior can be changed globally via &quot;<a href="#tune.defaults.purge">tune.defaults.purge</a>&quot;
12790+
keyword. An unnamed default-server with no parameter set will automatically
12791+
be purged after parsing. As such, a final &quot;default-server from none&quot;
12792+
statement will be sufficient to release this unused memory, regardless of the
12793+
global setting. It is possible to list the preserved instances via the
12794+
command &quot;show default-server&quot;.
1278512795
</pre><div class="page-header"><b>See also:</b> &quot;<span class="dropdown"><a class="dropdown-toggle" data-toggle="dropdown" href="#">server<span class="caret"></span></a><ul class="dropdown-menu"><li class="dropdown-header">This keyword is available in sections :</li><li><a href="#server%20%28Peers%20declaration%29">Peers declaration</a></li><li><a href="#server%20%28Rings%29">Rings</a></li><li><a href="#server%20%28Alphabetically%20sorted%20keywords%20reference%29">Alphabetically sorted keywords reference</a></li></ul></span>&quot;, <a href="#5">section 5</a> about server options and global &quot;<a href="#tune.defaults.purge">tune.defaults.purge</a>&quot; option</div>
1278612796
<a class="anchor" name="default_backend"></a><a class="anchor" name="4-default_backend"></a><a class="anchor" name="4.2-default_backend"></a><a class="anchor" name="default_backend (Proxies)"></a><a class="anchor" name="default_backend (Alphabetically sorted keywords reference)"></a><div class="keyword"><b><a class="anchor" name="default_backend"></a><a href="#4.2-default_backend">default_backend</a></b> <span style="color: #080">&lt;backend&gt;</span></div><pre class="text">Specify the backend to use when no &quot;<a href="#use_backend">use_backend</a>&quot; rule has been matched.
1278712797

@@ -35623,7 +35633,7 @@ <h2 id="chapter-12.9" data-target="12.9"><small><a class="small" href="#12.9">12
3562335633
<br>
3562435634
<hr>
3562535635
<div class="text-right">
35626-
HAProxy 3.5-dev3-150 &ndash; Configuration Manual<br>
35636+
HAProxy 3.5-dev3-157 &ndash; Configuration Manual<br>
3562735637
<small>, 2026/07/22</small>
3562835638
</div>
3562935639
</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.5-dev3-150 - Starter Guide</title>
5+
<title>HAProxy version 3.5-dev3-157 - 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/08/04</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/08/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.5-dev3-150</strong></p>
498+
<p><strong>version 3.5-dev3-157</strong></p>
499499
<p>
500500
<br>
501501

@@ -2510,7 +2510,7 @@ <h2 id="chapter-4.4" data-target="4.4"><small><a class="small" href="#4.4">4.4.<
25102510
<br>
25112511
<hr>
25122512
<div class="text-right">
2513-
HAProxy 3.5-dev3-150 &ndash; Starter Guide<br>
2513+
HAProxy 3.5-dev3-157 &ndash; Starter Guide<br>
25142514
<small>, </small>
25152515
</div>
25162516
</div>

‎docs/dev/management.html‎

Lines changed: 19 additions & 6 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.5-dev3-150 - Management Guide</title>
5+
<title>HAProxy version 3.5-dev3-157 - 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" />
@@ -567,6 +567,10 @@
567567

568568
<a class="list-group-item" href="#show cli sockets">show cli sockets</a>
569569

570+
<a class="list-group-item" href="#show default-server">show default-server</a>
571+
572+
<a class="list-group-item" href="#show defaults">show defaults</a>
573+
570574
<a class="list-group-item" href="#show dev">show dev</a>
571575

572576
<a class="list-group-item" href="#show env">show env</a>
@@ -694,7 +698,7 @@
694698
You can use <strong>left</strong> and <strong>right</strong> arrow keys to navigate between chapters.<br>
695699
</p>
696700
<p class="text-right">
697-
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2026/08/04</b></small>
701+
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2026/08/05</b></small>
698702
</p>
699703
</div>
700704
<!-- /.sidebar -->
@@ -705,7 +709,7 @@
705709
<div class="text-center">
706710
<h1><a href="http://www.haproxy.org/" title="HAProxy"><img src="../img/HAProxyCommunityEdition_60px.png?0.4.2-15" /></a></h1>
707711
<h2>Management Guide</h2>
708-
<p><strong>version 3.5-dev3-150</strong></p>
712+
<p><strong>version 3.5-dev3-157</strong></p>
709713
<p>
710714
<br>
711715

@@ -2617,7 +2621,9 @@ <h2 id="chapter-9.3" data-target="9.3"><small><a class="small" href="#9.3">9.3.<
26172621

26182622
All named default proxies can be used, given that they validate the same
26192623
inheritance rules applied during configuration parsing. There is some
2620-
exceptions though, for example when the mode is neither TCP nor HTTP.
2624+
exceptions though, for example when the mode is neither TCP nor HTTP. The
2625+
available default proxy instances can be listed via the &quot;<a href="#show%20defaults">show defaults</a>&quot;
2626+
additional command.
26212627

26222628
This command is restricted and can only be issued on sockets configured for
26232629
level &quot;admin&quot;.
@@ -2660,7 +2666,8 @@ <h2 id="chapter-9.3" data-target="9.3"><small><a class="small" href="#9.3">9.3.<
26602666
By default, 'default-server' is ignored by a dynamically created server.
26612667
However, it is possible to use the 'from' server positional keyword to
26622668
explicitely preset the settings of the newly created server from another
2663-
server or a default-server instance, either named or unnamed.
2669+
server or a default-server instance, either named or unnamed. The additional
2670+
command &quot;<a href="#show%20default-server">show default-server</a>&quot; lists the available entries.
26642671

26652672
Currently a dynamic server is statically initialized with the &quot;none&quot;
26662673
init-addr method. This means that no resolution will be undertaken if a FQDN
@@ -3727,6 +3734,12 @@ <h2 id="chapter-9.3" data-target="9.3"><small><a class="small" href="#9.3">9.3.<
37273734
5. number of blocks used for the object
37283735
6. number of transactions using the entry
37293736
7. expiration time, can be negative if already expired
3737+
</pre><a class="anchor" name="show"></a><a class="anchor" name="9-show"></a><a class="anchor" name="9.3-show"></a><a class="anchor" name="show (Statistics and monitoring)"></a><a class="anchor" name="show (Unix Socket commands)"></a><a class="anchor" name="show default-server"></a><a class="anchor" name="9-show default-server"></a><a class="anchor" name="9.3-show default-server"></a><a class="anchor" name="show default-server (Statistics and monitoring)"></a><a class="anchor" name="show default-server (Unix Socket commands)"></a><div class="keyword"><b><a class="anchor" name="show default-server"></a><a href="#9.3-show%20default-server">show default-server</a></b> <span style="color: #008">[<span style="color: #080">&lt;backend&gt;</span>]</span></div><pre class="text">Dump the list of default-server instances still present in a backend after
3738+
configuration parsing. These instances can be referenced via the server
3739+
keyword from during &quot;<a href="#add%20server">add server</a>&quot;.
3740+
</pre><a class="anchor" name="show"></a><a class="anchor" name="9-show"></a><a class="anchor" name="9.3-show"></a><a class="anchor" name="show (Statistics and monitoring)"></a><a class="anchor" name="show (Unix Socket commands)"></a><a class="anchor" name="show defaults"></a><a class="anchor" name="9-show defaults"></a><a class="anchor" name="9.3-show defaults"></a><a class="anchor" name="show defaults (Statistics and monitoring)"></a><a class="anchor" name="show defaults (Unix Socket commands)"></a><div class="keyword"><b><a class="anchor" name="show defaults"></a><a href="#9.3-show%20defaults">show defaults</a></b></div><pre class="text">Dump the list of named defaults proxies instances still present after
3741+
configuration parsing. These instances can be reused with &quot;<a href="#add%20backend">add backend</a>&quot;
3742+
command to serve as configuration for the newly created proxy.
37303743
</pre><a class="anchor" name="show"></a><a class="anchor" name="9-show"></a><a class="anchor" name="9.3-show"></a><a class="anchor" name="show (Statistics and monitoring)"></a><a class="anchor" name="show (Unix Socket commands)"></a><a class="anchor" name="show dev"></a><a class="anchor" name="9-show dev"></a><a class="anchor" name="9.3-show dev"></a><a class="anchor" name="show dev (Statistics and monitoring)"></a><a class="anchor" name="show dev (Unix Socket commands)"></a><div class="keyword"><b><a class="anchor" name="show dev"></a><a href="#9.3-show%20dev">show dev</a></b></div><pre class="text">This command is meant to centralize some information that HAProxy developers
37313744
might need to better understand the causes of a given problem. It generally
37323745
does not provide useful information for the user, but these information allow
@@ -5941,7 +5954,7 @@ <h2 id="chapter-13.1" data-target="13.1"><small><a class="small" href="#13.1">13
59415954
<br>
59425955
<hr>
59435956
<div class="text-right">
5944-
HAProxy 3.5-dev3-150 &ndash; Management Guide<br>
5957+
HAProxy 3.5-dev3-157 &ndash; Management Guide<br>
59455958
<small>, </small>
59465959
</div>
59475960
</div>

0 commit comments

Comments
 (0)