Skip to content

Commit ac8964d

Browse files
author
HAProxy Community
committed
Update docs for dev
1 parent e0ca6ab commit ac8964d

File tree

3 files changed

+40
-22
lines changed

3 files changed

+40
-22
lines changed

docs/dev/configuration.html

Lines changed: 32 additions & 14 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-dev10-89 - Configuration Manual</title>
5+
<title>HAProxy version 3.1-dev10-102 - 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" />
@@ -4402,7 +4402,7 @@
44024402
You can use <strong>left</strong> and <strong>right</strong> arrow keys to navigate between chapters.<br>
44034403
</p>
44044404
<p class="text-right">
4405-
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2024/10/24</b></small>
4405+
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2024/10/29</b></small>
44064406
</p>
44074407
</div>
44084408
<!-- /.sidebar -->
@@ -4413,7 +4413,7 @@
44134413
<div class="text-center">
44144414
<h1><a href="http://www.haproxy.org/" title="HAProxy"><img src="../img/HAProxyCommunityEdition_60px.png?0.4.2-15" /></a></h1>
44154415
<h2>Configuration Manual</h2>
4416-
<p><strong>version 3.1-dev10-89</strong></p>
4416+
<p><strong>version 3.1-dev10-102</strong></p>
44174417
<p>
44184418
2024/10/16<br>
44194419

@@ -10954,6 +10954,11 @@ <h2 id="chapter-4.2" data-target="4.2"><small><a class="small" href="#4.2">4.2.<
1095410954
only in log-forward sections.
1095510955
- 'unix@' -&gt; address is a path to a local unix socket
1095610956
- 'abns@' -&gt; address is in abstract namespace (Linux only).
10957+
- 'abnsz@' -&gt; address is in abstract namespace (Linux only)
10958+
but it is explicitly zero-terminated. This means no \0
10959+
padding is used to complete sun_path. It is useful to
10960+
interconnect with programs that don't implement the
10961+
default abns naming logic that haproxy uses.
1095710962
- 'fd@&lt;n&gt;' -&gt; use file descriptor &lt;n&gt; inherited from the
1095810963
parent. The fd must be bound and may or may not already
1095910964
be listening.
@@ -11047,11 +11052,12 @@ <h2 id="chapter-4.2" data-target="4.2"><small><a class="small" href="#4.2">4.2.<
1104711052
listen h3_quic_proxy
1104811053
bind [email protected]:8888 ssl crt /etc/mycrt
1104911054
</code></pre>
11050-
</div><pre class="text">Note: regarding Linux's abstract namespace sockets, HAProxy uses the whole
11051-
sun_path length is used for the address length. Some other programs
11052-
such as socat use the string length only by default. Pass the option
11053-
&quot;,unix-tightsocklen=0&quot; to any abstract socket definition in socat to
11054-
make it compatible with HAProxy's.
11055+
</div><pre class="text">Note: regarding Linux's abstract namespace sockets, &quot;abns&quot; HAProxy sockets
11056+
uses the whole sun_path length is used for the address length. Some
11057+
other programs such as socat use the string length only by default.
11058+
Pass the option &quot;,unix-tightsocklen=0&quot; to any abstract socket
11059+
definition in socat to make it compatible with HAProxy's, or use the
11060+
&quot;abnsz&quot; HAProxy socket family instead.
1105511061
</pre><div class="page-header"><b>See also :</b> &quot;<span class="dropdown"><a class="dropdown-toggle" data-toggle="dropdown" href="#">source<span class="caret"></span></a><ul class="dropdown-menu"><li class="dropdown-header">This keyword is available in sections :</li><li><a href="#source%20%28Alphabetically%20sorted%20keywords%20reference%29">Alphabetically sorted keywords reference</a></li><li><a href="#source%20%28Server%20and%20default-server%20options%29">Server and default-server options</a></li></ul></span>&quot;, &quot;<a href="#option%20forwardfor">option forwardfor</a>&quot;, &quot;<a href="#unix-bind">unix-bind</a>&quot; and the PROXY protocol documentation, and <a href="#5">section 5</a> about bind options.</div>
1105611062
<a class="anchor" name="capture"></a><a class="anchor" name="4-capture"></a><a class="anchor" name="4.2-capture"></a><a class="anchor" name="capture (Proxies)"></a><a class="anchor" name="capture (Alphabetically sorted keywords reference)"></a><a class="anchor" name="capture cookie"></a><a class="anchor" name="4-capture cookie"></a><a class="anchor" name="4.2-capture cookie"></a><a class="anchor" name="capture cookie (Proxies)"></a><a class="anchor" name="capture cookie (Alphabetically sorted keywords reference)"></a><div class="keyword"><b><a class="anchor" name="capture cookie"></a><a href="#4.2-capture%20cookie">capture cookie</a></b> <span style="color: #080">&lt;name&gt;</span> len <span style="color: #080">&lt;length&gt;</span></div><pre class="text">Capture and log a cookie in the request and in the response.
1105711063

@@ -16036,6 +16042,11 @@ <h2 id="chapter-4.2" data-target="4.2"><small><a class="small" href="#4.2">4.2.<
1603616042
- 'ipv6@' -&gt; address is always IPv6
1603716043
- 'unix@' -&gt; address is a path to a local unix socket
1603816044
- 'abns@' -&gt; address is in abstract namespace (Linux only)
16045+
- 'abnsz@' -&gt; address is in abstract namespace (Linux only)
16046+
but it is explicitly zero-terminated. This means no \0
16047+
padding is used to complete sun_path. It is useful to
16048+
interconnect with programs that don't implement the
16049+
default abns naming logic that haproxy uses.
1603916050
- 'sockpair@' -&gt; address is the FD of a connected unix
1604016051
socket or of a socketpair. During a connection, the
1604116052
backend creates a pair of connected sockets, and passes
@@ -16072,11 +16083,12 @@ <h2 id="chapter-4.2" data-target="4.2"><small><a class="small" href="#4.2">4.2.<
1607216083
server www1_dc1 &quot;${LAN_DC1}.101:80&quot;
1607316084
server www1_dc2 &quot;${LAN_DC2}.101:80&quot;
1607416085
</code></pre>
16075-
</div><pre class="text">Note: regarding Linux's abstract namespace sockets, HAProxy uses the whole
16076-
sun_path length is used for the address length. Some other programs
16077-
such as socat use the string length only by default. Pass the option
16078-
&quot;,unix-tightsocklen=0&quot; to any abstract socket definition in socat to
16079-
make it compatible with HAProxy's.
16086+
</div><pre class="text">Note: regarding Linux's abstract namespace sockets, &quot;abns&quot; HAProxy sockets
16087+
uses the whole sun_path length is used for the address length. Some
16088+
other programs such as socat use the string length only by default.
16089+
Pass the option &quot;,unix-tightsocklen=0&quot; to any abstract socket
16090+
definition in socat to make it compatible with HAProxy's, or use the
16091+
&quot;abnsz&quot; HAProxy socket family instead.
1608016092
</pre><div class="page-header"><b>See also:</b> &quot;<span class="dropdown"><a class="dropdown-toggle" data-toggle="dropdown" href="#">default-server<span class="caret"></span></a><ul class="dropdown-menu"><li class="dropdown-header">This keyword is available in sections :</li><li><a href="#default-server%20%28Peers%29">Peers</a></li><li><a href="#default-server%20%28Alphabetically%20sorted%20keywords%20reference%29">Alphabetically sorted keywords reference</a></li></ul></span>&quot;, &quot;<a href="#http-send-name-header">http-send-name-header</a>&quot; and <a href="#5">section 5</a> about server options</div>
1608116093
<a class="anchor" name="server-state-file-name"></a><a class="anchor" name="4-server-state-file-name"></a><a class="anchor" name="4.2-server-state-file-name"></a><a class="anchor" name="server-state-file-name (Proxies)"></a><a class="anchor" name="server-state-file-name (Alphabetically sorted keywords reference)"></a><div class="keyword"><b><a class="anchor" name="server-state-file-name"></a><a href="#4.2-server-state-file-name">server-state-file-name</a></b> <span style="color: #008">[ <span style="color: #800">{ use-backend-name | <span style="color: #080">&lt;file&gt;</span> }</span> ]</span></div><pre class="text">Set the server state file to read, load and apply to servers available in
1608216094
this backend.
@@ -16162,6 +16174,9 @@ <h2 id="chapter-4.2" data-target="4.2"><small><a class="small" href="#4.2">4.2.<
1616216174
- 'ipv6@' -&gt; address is always IPv6
1616316175
- 'unix@' -&gt; address is a path to a local unix socket
1616416176
- 'abns@' -&gt; address is in abstract namespace (Linux only)
16177+
- 'abnsz@' -&gt; address is in zero-terminated abstract namespace
16178+
(Linux only)
16179+
1616516180
You may want to reference some environment variables in the
1616616181
address parameter, see <a href="#2.3">section 2.3</a> about environment variables.
1616716182

@@ -31113,6 +31128,9 @@ <h2 id="chapter-10.3" data-target="10.3"><small><a class="small" href="#10.3">10
3111331128
<h2 id="chapter-11.1" data-target="11.1"><small><a class="small" href="#11.1">11.1.</a></small> Address family prefixes</h2>
3111431129
<div><pre class="text">'abns@&lt;name&gt;' following &lt;name&gt; is an abstract namespace (Linux only).
3111531130

31131+
'abnsz@&lt;name&gt;' following &lt;name&gt; is a zero-terminated abstract namespace
31132+
(Linux only).
31133+
3111631134
'fd@&lt;n&gt;' following address is a file descriptor &lt;n&gt; inherited from the
3111731135
parent. The fd must be bound and may or may not already be
3111831136
listening.
@@ -31269,7 +31287,7 @@ <h2 id="chapter-11.3" data-target="11.3"><small><a class="small" href="#11.3">11
3126931287
<br>
3127031288
<hr>
3127131289
<div class="text-right">
31272-
HAProxy 3.1-dev10-89 &ndash; Configuration Manual<br>
31290+
HAProxy 3.1-dev10-102 &ndash; Configuration Manual<br>
3127331291
<small>, 2024/10/16</small>
3127431292
</div>
3127531293
</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.1-dev10-89 - Starter Guide</title>
5+
<title>HAProxy version 3.1-dev10-102 - 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>2024/10/24</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>2024/10/29</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-dev10-89</strong></p>
498+
<p><strong>version 3.1-dev10-102</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-dev10-89 &ndash; Starter Guide<br>
2518+
HAProxy 3.1-dev10-102 &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.1-dev10-89 - Management Guide</title>
5+
<title>HAProxy version 3.1-dev10-102 - 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" />
@@ -648,7 +648,7 @@
648648
You can use <strong>left</strong> and <strong>right</strong> arrow keys to navigate between chapters.<br>
649649
</p>
650650
<p class="text-right">
651-
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2024/10/24</b></small>
651+
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2024/10/29</b></small>
652652
</p>
653653
</div>
654654
<!-- /.sidebar -->
@@ -659,7 +659,7 @@
659659
<div class="text-center">
660660
<h1><a href="http://www.haproxy.org/" title="HAProxy"><img src="../img/HAProxyCommunityEdition_60px.png?0.4.2-15" /></a></h1>
661661
<h2>Management Guide</h2>
662-
<p><strong>version 3.1-dev10-89</strong></p>
662+
<p><strong>version 3.1-dev10-102</strong></p>
663663
<p>
664664
<br>
665665

@@ -5352,7 +5352,7 @@ <h2 id="chapter-13.1" data-target="13.1"><small><a class="small" href="#13.1">13
53525352
<br>
53535353
<hr>
53545354
<div class="text-right">
5355-
HAProxy 3.1-dev10-89 &ndash; Management Guide<br>
5355+
HAProxy 3.1-dev10-102 &ndash; Management Guide<br>
53565356
<small>, </small>
53575357
</div>
53585358
</div>

0 commit comments

Comments
 (0)