Skip to content

Commit 22b87b0

Browse files
author
HAProxy Community
committed
Update docs for dev
1 parent 6e849e3 commit 22b87b0

File tree

3 files changed

+47
-13
lines changed

3 files changed

+47
-13
lines changed

docs/dev/configuration.html

Lines changed: 39 additions & 5 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.3-dev8-141 - Configuration Manual</title>
5+
<title>HAProxy version 3.3-dev8-158 - 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" />
@@ -1599,6 +1599,10 @@
15991599

16001600
<a class="list-group-item" href="#capture.res.ver">capture.res.ver</a>
16011601

1602+
<a class="list-group-item" href="#cc (Bind options)">cc (Bind options)</a>
1603+
1604+
<a class="list-group-item" href="#cc (Server and default-server options)">cc (Server and default-server options)</a>
1605+
16021606
<a class="list-group-item" href="#challenge">challenge</a>
16031607

16041608
<a class="list-group-item" href="#check">check</a>
@@ -4617,7 +4621,7 @@
46174621
You can use <strong>left</strong> and <strong>right</strong> arrow keys to navigate between chapters.<br>
46184622
</p>
46194623
<p class="text-right">
4620-
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2025/09/11</b></small>
4624+
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2025/09/17</b></small>
46214625
</p>
46224626
</div>
46234627
<!-- /.sidebar -->
@@ -4628,7 +4632,7 @@
46284632
<div class="text-center">
46294633
<h1><a href="http://www.haproxy.org/" title="HAProxy"><img src="../img/HAProxyCommunityEdition_60px.png?0.4.2-15" /></a></h1>
46304634
<h2>Configuration Manual</h2>
4631-
<p><strong>version 3.3-dev8-141</strong></p>
4635+
<p><strong>version 3.3-dev8-158</strong></p>
46324636
<p>
46334637
2025/09/05<br>
46344638

@@ -20818,6 +20822,22 @@ <h2 id="chapter-5.1" data-target="5.1"><small><a class="small" href="#5.1">5.1.<
2081820822
included in CA names sent in server hello message. Typically, &quot;<span class="dropdown"><a class="dropdown-toggle" data-toggle="dropdown" href="#">ca-file<span class="caret"></span></a><ul class="dropdown-menu"><li class="dropdown-header">This keyword is available in sections :</li><li><a href="#ca-file%20%28Bind%20options%29">Bind options</a></li><li><a href="#ca-file%20%28Server%20and%20default-server%20options%29">Server and default-server options</a></li></ul></span>&quot; must
2081920823
be defined with intermediate certificates, and &quot;<a href="#ca-verify-file">ca-verify-file</a>&quot; with
2082020824
certificates to ending the chain, like root CA.
20825+
</pre><a class="anchor" name="cc"></a><a class="anchor" name="5-cc"></a><a class="anchor" name="5.1-cc"></a><a class="anchor" name="cc (Bind and server options)"></a><a class="anchor" name="cc (Bind options)"></a><div class="keyword"><b><a class="anchor" name="cc"></a><a href="#5.1-cc">cc</a></b> <span style="color: #080">&lt;algo&gt;</span></div><pre class="text">This setting is only available on systems which define TCP_CONGESTION, and
20826+
was validated on Linux and FreeBSD. It takes the name of a TCP congestion
20827+
control algorithm and configures the listener to use this algorithm on all
20828+
connections that are accepted from this listener. Typical names include
20829+
&quot;reno&quot;, &quot;cubic&quot; and will depend on the operating system. On some systems,
20830+
special permissions may be required to configure certain algorithms. On
20831+
Linux, the list of available algorithms may be found in the sysctl
20832+
&quot;net.ipv4.tcp_available_congestion_control&quot;, and the list of those permitted
20833+
without privileges is in &quot;net.ipv4.tcp_allowed_congestion_control&quot;. In order
20834+
to access algorithms requiring extra permissions, the &quot;cap_net_admin&quot;
20835+
capability might be required (see &quot;<a href="#setcap">setcap</a>&quot; in the global section). In case of
20836+
failure to configure a specific congestion control algorithm, the default one
20837+
will remain unchanged and a warning will be emitted to report the problem.
20838+
</pre><div class="page-header"><b>See also:</b> the &quot;<span class="dropdown"><a class="dropdown-toggle" data-toggle="dropdown" href="#">cc<span class="caret"></span></a><ul class="dropdown-menu"><li class="dropdown-header">This keyword is available in sections :</li><li><a href="#cc%20%28Bind%20options%29">Bind options</a></li><li><a href="#cc%20%28Server%20and%20default-server%20options%29">Server and default-server options</a></li></ul></span>&quot; server keyword (<a href="#5.2">section 5.2</a>). Example:</div>
20839+
<pre class="text">frontend public
20840+
bind :443 cc bbr # use the BBR algorithm for high bandwidths
2082120841
</pre><a class="anchor" name="ciphers"></a><a class="anchor" name="5-ciphers"></a><a class="anchor" name="5.1-ciphers"></a><a class="anchor" name="ciphers (Bind and server options)"></a><a class="anchor" name="ciphers (Bind options)"></a><div class="keyword"><b><a class="anchor" name="ciphers"></a><a href="#5.1-ciphers">ciphers</a></b> <span style="color: #080">&lt;ciphers&gt;</span></div><pre class="text">This setting is only available when support for OpenSSL was built in. It sets
2082220842
the string describing the list of cipher algorithms (&quot;cipher suite&quot;) that are
2082320843
negotiated during the SSL/TLS handshake up to TLSv1.2. The format of the
@@ -21803,7 +21823,21 @@ <h2 id="chapter-5.2" data-target="5.2"><small><a class="small" href="#5.2">5.2.<
2180321823
In order to use the trusted CAs of your system, the &quot;@system-ca&quot; parameter
2180421824
could be used in place of the cafile. The location of this directory could be
2180521825
overwritten by setting the SSL_CERT_DIR environment variable.
21806-
</pre><a class="anchor" name="check"></a><a class="anchor" name="5-check"></a><a class="anchor" name="5.2-check"></a><a class="anchor" name="check (Bind and server options)"></a><a class="anchor" name="check (Server and default-server options)"></a><div class="keyword"><b><a class="anchor" name="check"></a><a href="#5.2-check">check</a></b></div><pre class="text">May be used in the following contexts: tcp, http, log
21826+
</pre><a class="anchor" name="cc"></a><a class="anchor" name="5-cc"></a><a class="anchor" name="5.2-cc"></a><a class="anchor" name="cc (Bind and server options)"></a><a class="anchor" name="cc (Server and default-server options)"></a><div class="keyword"><b><a class="anchor" name="cc"></a><a href="#5.2-cc">cc</a></b> <span style="color: #080">&lt;algo&gt;</span></div><pre class="text">May be used in the following contexts: tcp, http, log, peers, ring
21827+
21828+
This setting is only available on systems which define TCP_CONGESTION, and
21829+
was validated on Linux and FreeBSD. It takes the name of a TCP congestion
21830+
control algorithm and configures outgoing connections to use this algorithm.
21831+
Typical names include &quot;reno&quot; or &quot;cubic&quot; and will depend on the operating
21832+
system. On some systems, special permissions may be required to configure
21833+
certain algorithms. On Linux, available algorithms are listed in sysctl
21834+
&quot;net.ipv4.tcp_available_congestion_control&quot;, and those permitted without
21835+
privileges are in &quot;net.ipv4.tcp_allowed_congestion_control&quot;. In order to
21836+
access algorithms requiring extra permissions, the &quot;cap_net_admin&quot; capability
21837+
might be required (see &quot;<a href="#setcap">setcap</a>&quot; in the global section). In case of failure to
21838+
configure a specific congestion control algorithm, the default one remains
21839+
</pre><div class="page-header"><b>See also:</b> the &quot;<span class="dropdown"><a class="dropdown-toggle" data-toggle="dropdown" href="#">cc<span class="caret"></span></a><ul class="dropdown-menu"><li class="dropdown-header">This keyword is available in sections :</li><li><a href="#cc%20%28Bind%20options%29">Bind options</a></li><li><a href="#cc%20%28Server%20and%20default-server%20options%29">Server and default-server options</a></li></ul></span>&quot; bind keyword (<a href="#5.1">section 5.1</a>).</div>
21840+
<a class="anchor" name="check"></a><a class="anchor" name="5-check"></a><a class="anchor" name="5.2-check"></a><a class="anchor" name="check (Bind and server options)"></a><a class="anchor" name="check (Server and default-server options)"></a><div class="keyword"><b><a class="anchor" name="check"></a><a href="#5.2-check">check</a></b></div><pre class="text">May be used in the following contexts: tcp, http, log
2180721841

2180821842
This option enables health checks on a server:
2180921843
- when not set, no health checking is performed, and the server is always
@@ -33307,7 +33341,7 @@ <h2 id="chapter-12.8" data-target="12.8"><small><a class="small" href="#12.8">12
3330733341
<br>
3330833342
<hr>
3330933343
<div class="text-right">
33310-
HAProxy 3.3-dev8-141 &ndash; Configuration Manual<br>
33344+
HAProxy 3.3-dev8-158 &ndash; Configuration Manual<br>
3331133345
<small>, 2025/09/05</small>
3331233346
</div>
3331333347
</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.3-dev8-141 - Starter Guide</title>
5+
<title>HAProxy version 3.3-dev8-158 - 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/09/11</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/09/17</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.3-dev8-141</strong></p>
498+
<p><strong>version 3.3-dev8-158</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.3-dev8-141 &ndash; Starter Guide<br>
2518+
HAProxy 3.3-dev8-158 &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.3-dev8-141 - Management Guide</title>
5+
<title>HAProxy version 3.3-dev8-158 - 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" />
@@ -662,7 +662,7 @@
662662
You can use <strong>left</strong> and <strong>right</strong> arrow keys to navigate between chapters.<br>
663663
</p>
664664
<p class="text-right">
665-
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2025/09/11</b></small>
665+
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2025/09/17</b></small>
666666
</p>
667667
</div>
668668
<!-- /.sidebar -->
@@ -673,7 +673,7 @@
673673
<div class="text-center">
674674
<h1><a href="http://www.haproxy.org/" title="HAProxy"><img src="../img/HAProxyCommunityEdition_60px.png?0.4.2-15" /></a></h1>
675675
<h2>Management Guide</h2>
676-
<p><strong>version 3.3-dev8-141</strong></p>
676+
<p><strong>version 3.3-dev8-158</strong></p>
677677
<p>
678678
<br>
679679

@@ -5622,7 +5622,7 @@ <h2 id="chapter-13.1" data-target="13.1"><small><a class="small" href="#13.1">13
56225622
<br>
56235623
<hr>
56245624
<div class="text-right">
5625-
HAProxy 3.3-dev8-141 &ndash; Management Guide<br>
5625+
HAProxy 3.3-dev8-158 &ndash; Management Guide<br>
56265626
<small>, </small>
56275627
</div>
56285628
</div>

0 commit comments

Comments
 (0)