Skip to content

Commit 361d9bb

Browse files
author
HAProxy Community
committed
Update docs for dev
1 parent 4dd4d33 commit 361d9bb

3 files changed

Lines changed: 43 additions & 21 deletions

File tree

‎docs/dev/configuration.html‎

Lines changed: 35 additions & 13 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-dev8-58 - Configuration Manual</title>
5+
<title>HAProxy version 3.4-dev8-128 - 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" />
@@ -4888,7 +4888,7 @@
48884888
You can use <strong>left</strong> and <strong>right</strong> arrow keys to navigate between chapters.<br>
48894889
</p>
48904890
<p class="text-right">
4891-
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2026/04/10</b></small>
4891+
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2026/04/13</b></small>
48924892
</p>
48934893
</div>
48944894
<!-- /.sidebar -->
@@ -4899,7 +4899,7 @@
48994899
<div class="text-center">
49004900
<h1><a href="http://www.haproxy.org/" title="HAProxy"><img src="../img/HAProxyCommunityEdition_60px.png?0.4.2-15" /></a></h1>
49014901
<h2>Configuration Manual</h2>
4902-
<p><strong>version 3.4-dev8-58</strong></p>
4902+
<p><strong>version 3.4-dev8-128</strong></p>
49034903
<p>
49044904
2026/04/03<br>
49054905

@@ -11589,7 +11589,7 @@ <h2 id="chapter-4.1" data-target="4.1"><small><a class="small" href="#4.1">4.1.<
1158911589
<tr><td ><a href="#4-timeout%20tarpit">timeout tarpit</a></td><td class="pagination-centered"><img src="../css/check.png" alt="X" title="yes" /></td><td class="pagination-centered"><img src="../css/check.png" alt="X" title="yes" /></td><td class="pagination-centered"><img src="../css/check.png" alt="X" title="yes" /></td><td class="pagination-centered"><img src="../css/check.png" alt="X" title="yes" /></td></tr>
1159011590
<tr><td ><a href="#4-timeout%20tunnel">timeout tunnel</a></td><td class="pagination-centered"><img src="../css/check.png" alt="X" title="yes" /></td><td class="pagination-centered">&nbsp;</td><td class="pagination-centered"><img src="../css/check.png" alt="X" title="yes" /></td><td class="pagination-centered"><img src="../css/check.png" alt="X" title="yes" /></td></tr>
1159111591
<tr><td ><a href="#4-transparent"><span class="pull-right"><span class="label label-warning">(deprecated)</span></span>transparent</a></td><td class="pagination-centered"><img src="../css/check.png" alt="X" title="yes" /></td><td class="pagination-centered">&nbsp;</td><td class="pagination-centered"><img src="../css/check.png" alt="X" title="yes" /></td><td class="pagination-centered"><img src="../css/check.png" alt="X" title="yes" /></td></tr>
11592-
<tr><td ><a href="#4-unique-id-format">unique-id-format</a></td><td class="pagination-centered"><img src="../css/check.png" alt="X" title="yes" /></td><td class="pagination-centered"><img src="../css/check.png" alt="X" title="yes" /></td><td class="pagination-centered"><img src="../css/check.png" alt="X" title="yes" /></td><td class="pagination-centered">&nbsp;</td></tr>
11592+
<tr><td ><a href="#4-unique-id-format">unique-id-format</a></td><td class="pagination-centered"><img src="../css/check.png" alt="X" title="yes" /></td><td class="pagination-centered"><img src="../css/check.png" alt="X" title="yes" /></td><td class="pagination-centered"><img src="../css/check.png" alt="X" title="yes" /></td><td class="pagination-centered"><img src="../css/check.png" alt="X" title="yes" /></td></tr>
1159311593
<tr><td ><a href="#4-unique-id-header">unique-id-header</a></td><td class="pagination-centered"><img src="../css/check.png" alt="X" title="yes" /></td><td class="pagination-centered"><img src="../css/check.png" alt="X" title="yes" /></td><td class="pagination-centered"><img src="../css/check.png" alt="X" title="yes" /></td><td class="pagination-centered">&nbsp;</td></tr>
1159411594
<tr><td ><a href="#4-use_backend">use_backend</a></td><td class="pagination-centered">&nbsp;</td><td class="pagination-centered"><img src="../css/check.png" alt="X" title="yes" /></td><td class="pagination-centered"><img src="../css/check.png" alt="X" title="yes" /></td><td class="pagination-centered">&nbsp;</td></tr>
1159511595
<tr><td ><a href="#4-use-fcgi-app">use-fcgi-app</a></td><td class="pagination-centered">&nbsp;</td><td class="pagination-centered">&nbsp;</td><td class="pagination-centered"><img src="../css/check.png" alt="X" title="yes" /></td><td class="pagination-centered"><img src="../css/check.png" alt="X" title="yes" /></td></tr>
@@ -19798,7 +19798,7 @@ <h2 id="chapter-4.2" data-target="4.2"><small><a class="small" href="#4.2">4.2.<
1979819798
May be used in the following contexts: tcp, http
1979919799
</pre><div><p> May be used in sections :</p><table class="table table-bordered" border="0" cellspacing="0" cellpadding="0">
1980019800
<thead><tr><th>defaults</th><th>frontend</th><th>listen</th><th>backend</th></tr></thead>
19801-
<tr><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><td class="alert-success pagination-centered">yes<br /><img src="../css/check.png" alt="yes" title="yes" /></td><td class="alert-error pagination-centered">no<br /><img src="../css/cross.png" alt="no" title="no" /></td></tr>
19801+
<tr><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><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>
1980219802
</table></div>
1980319803
<div class="separator">
1980419804
<span class="label label-info">Arguments :</span><pre class="prettyprint arguments">&lt;fmt&gt; is a Custom log format string (see <a href="#8.2.6">section 8.2.6</a>).</pre>
@@ -19819,6 +19819,11 @@ <h2 id="chapter-4.2" data-target="4.2"><small><a class="small" href="#4.2">4.2.<
1981919819

1982019820
It is recommended to use hexadecimal notation for many fields since it
1982119821
makes them more compact and saves space in logs.
19822+
19823+
For regular connections the format configured in the frontend is used to
19824+
generate the unique ID. For health checks the format of the backend is
19825+
used when using the &quot;<a href="#unique-id">unique-id</a>&quot; fetch within a tcp-check or an http-check
19826+
ruleset.
1982219827
</pre><div class="separator">
1982319828
<span class="label label-success">Example:</span>
1982419829
<pre class="prettyprint">
@@ -35041,10 +35046,12 @@ <h2 id="chapter-12.8" data-target="12.8"><small><a class="small" href="#12.8">12
3504135046
A guide is available on the HAProxy wiki
3504235047
https://github.com/haproxy/wiki/wiki/ACME:--native-haproxy
3504335048

35044-
Current limitations as of 3.3:
35045-
- The feature is limited to the HTTP-01 or DNS-01 challenges for now. HTTP-01
35046-
is completely handled by HAProxy, but DNS-01 needs either the dataplaneAPI or
35047-
another 3rd party tool to talk to a DNS provider API.
35049+
Current limitations:
35050+
- The feature is limited to the http-01, dns-01 or dns-persist-01 challenges
35051+
for now. http-01 is completely handled by HAProxy, but dns-01 and
35052+
dns-persist-01 needs either the dataplaneAPI or another 3rd party
35053+
tool to talk to a DNS provider API. dns-persist-01 only needs the TXT entry
35054+
to be set once, so it could be set manually without a tool.
3504835055
- It is possible to start without an existing certificate on the disk. To do
3504935056
so, the certificate must configured in a crt-store.
3505035057
When using the &quot;<span class="dropdown"><a class="dropdown-toggle" data-toggle="dropdown" href="#">acme<span class="caret"></span></a><ul class="dropdown-menu"><li class="dropdown-header">This keyword is available in sections :</li><li><a href="#acme%20%28Load%20options%29">Load options</a></li><li><a href="#acme%20%28ACME%29">ACME</a></li></ul></span>&quot; keyword in a crt-store, a temporary key pair will be
@@ -35083,8 +35090,14 @@ <h2 id="chapter-12.8" data-target="12.8"><small><a class="small" href="#12.8">12
3508335090
Setting a too high value can trigger a warning if your machine is not
3508435091
powerful enough. (This can be configured with &quot;<a href="#warn-blocked-traffic-after">warn-blocked-traffic-after</a>&quot;
3508535092
but blocking the traffic too long could trigger the watchdog.)
35086-
</pre><a class="anchor" name="challenge"></a><a class="anchor" name="12-challenge"></a><a class="anchor" name="12.8-challenge"></a><a class="anchor" name="challenge (Other sections)"></a><a class="anchor" name="challenge (ACME)"></a><div class="keyword"><b><a class="anchor" name="challenge"></a><a href="#12.8-challenge">challenge</a></b> <span style="color: #080">&lt;string&gt;</span></div><pre class="text">Takes a challenge type as parameter, this must be http-01 or dns-01. When not
35087-
used the default is http-01.
35093+
</pre><a class="anchor" name="challenge"></a><a class="anchor" name="12-challenge"></a><a class="anchor" name="12.8-challenge"></a><a class="anchor" name="challenge (Other sections)"></a><a class="anchor" name="challenge (ACME)"></a><div class="keyword"><b><a class="anchor" name="challenge"></a><a href="#12.8-challenge">challenge</a></b> <span style="color: #080">&lt;string&gt;</span></div><pre class="text">Takes a challenge type as parameter, this must be http-01, dns-01 or
35094+
dns-persist-01. When not used the default is http-01.
35095+
35096+
dns-persist-01 implements draft-ietf-acme-dns-persist. Unlike dns-01, it
35097+
uses a static TXT record at &quot;_validation-persist.&lt;domain&gt;&quot; that is set once
35098+
and never changes between renewals. The record must contain the account URI
35099+
and an optional policy. This challenge type does not require write access to
35100+
the DNS provider API on each renewal.
3508835101
</pre><a class="anchor" name="challenge-ready"></a><a class="anchor" name="12-challenge-ready"></a><a class="anchor" name="12.8-challenge-ready"></a><a class="anchor" name="challenge-ready (Other sections)"></a><a class="anchor" name="challenge-ready (ACME)"></a><div class="keyword"><b><a class="anchor" name="challenge-ready"></a><a href="#12.8-challenge-ready">challenge-ready</a></b> <span style="color: #080">&lt;value&gt;</span><span style="color: #008">[,<span style="color: #080">&lt;value&gt;</span>]</span>*</div><pre class="text">Configure the conditions that must be met before notifying the ACME server
3508935102
that a dns-01 challenge is ready to be validated. Accepted values are:
3509035103

@@ -35102,6 +35115,11 @@ <h2 id="chapter-12.8" data-target="12.8"><small><a class="small" href="#12.8">12
3510235115
option is independent of the CLI command, so no human intervention
3510335116
is required.
3510435117

35118+
For dns-01, the TXT record at &quot;_acme-challenge.&lt;domain&gt;&quot; is
35119+
resolved and must match the expected token. For dns-persist-01,
35120+
the TXT record at &quot;_validation-persist.&lt;domain&gt;&quot; is resolved and
35121+
only its presence is checked.
35122+
3510535123
delay - apply an initial wait of &quot;<a href="#dns-delay">dns-delay</a>&quot; before proceeding. Without
3510635124
&quot;dns&quot;, the challenge is submitted after the delay expires. When
3510735125
combined with &quot;dns&quot;, the initial wait is applied before starting
@@ -35116,10 +35134,14 @@ <h2 id="chapter-12.8" data-target="12.8"><small><a class="small" href="#12.8">12
3511635134
the CLI confirmation (&quot;cli&quot;), then applies the initial delay (&quot;delay&quot;), then
3511735135
performs the DNS pre-checks (&quot;dns&quot;).
3511835136

35119-
This option is only compatible with the dns-01 challenge type.
35137+
This option is only compatible with the dns-01 and dns-persist-01 challenge
35138+
types.
3512035139

3512135140
When &quot;<a href="#challenge">challenge</a>&quot; is set to &quot;dns-01&quot; and this option is not configured, the
3512235141
default is &quot;cli&quot;.
35142+
35143+
When &quot;<a href="#challenge">challenge</a>&quot; is set to &quot;dns-persist-01&quot; and this option is not
35144+
configured, the default is &quot;dns,delay&quot;.
3512335145
</pre><div class="separator">
3512435146
<span class="label label-success">Example:</span>
3512535147
<pre class="prettyprint">
@@ -35268,7 +35290,7 @@ <h2 id="chapter-12.9" data-target="12.9"><small><a class="small" href="#12.9">12
3526835290
<br>
3526935291
<hr>
3527035292
<div class="text-right">
35271-
HAProxy 3.4-dev8-58 &ndash; Configuration Manual<br>
35293+
HAProxy 3.4-dev8-128 &ndash; Configuration Manual<br>
3527235294
<small>, 2026/04/03</small>
3527335295
</div>
3527435296
</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-dev8-58 - Starter Guide</title>
5+
<title>HAProxy version 3.4-dev8-128 - 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/04/10</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/04/13</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-dev8-58</strong></p>
498+
<p><strong>version 3.4-dev8-128</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-dev8-58 &ndash; Starter Guide<br>
2518+
HAProxy 3.4-dev8-128 &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-dev8-58 - Management Guide</title>
5+
<title>HAProxy version 3.4-dev8-128 - 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/04/10</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/04/13</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-dev8-58</strong></p>
710+
<p><strong>version 3.4-dev8-128</strong></p>
711711
<p>
712712
<br>
713713

@@ -5849,7 +5849,7 @@ <h2 id="chapter-13.1" data-target="13.1"><small><a class="small" href="#13.1">13
58495849
<br>
58505850
<hr>
58515851
<div class="text-right">
5852-
HAProxy 3.4-dev8-58 &ndash; Management Guide<br>
5852+
HAProxy 3.4-dev8-128 &ndash; Management Guide<br>
58535853
<small>, </small>
58545854
</div>
58555855
</div>

0 commit comments

Comments
 (0)