Skip to content

Commit

Permalink
Update docs for dev
Browse files Browse the repository at this point in the history
  • Loading branch information
HAProxy Community committed Mar 28, 2024
1 parent fbcff1b commit 66f78f0
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 22 deletions.
41 changes: 27 additions & 14 deletions docs/dev/configuration.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta charset="utf-8" />
<title>HAProxy version 3.0-dev6 - Configuration Manual</title>
<title>HAProxy version 3.0-dev6-5 - Configuration Manual</title>
<link href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet" />
<link href="https://raw.githubusercontent.com/thomaspark/bootswatch/v3.3.7/cerulean/bootstrap.min.css" rel="stylesheet" />
<link href="../css/page.css?0.4.2-15" rel="stylesheet" />
Expand Down Expand Up @@ -4015,6 +4015,8 @@

<a class="list-group-item" href="#tune.ssl.ocsp-update.mindelay">tune.ssl.ocsp-update.mindelay</a>

<a class="list-group-item" href="#tune.ssl.ocsp-update.mode">tune.ssl.ocsp-update.mode</a>

<a class="list-group-item" href="#tune.ssl.ssl-ctx-cache-size">tune.ssl.ssl-ctx-cache-size</a>

<a class="list-group-item" href="#tune.stick-counters">tune.stick-counters</a>
Expand Down Expand Up @@ -4196,7 +4198,7 @@
You can use <strong>left</strong> and <strong>right</strong> arrow keys to navigate between chapters.<br>
</p>
<p class="text-right">
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2024/03/26</b></small>
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2024/03/27</b></small>
</p>
</div>
<!-- /.sidebar -->
Expand All @@ -4207,7 +4209,7 @@
<div class="text-center">
<h1><a href="http://www.haproxy.org/" title="HAProxy"><img src="../img/HAProxyCommunityEdition_60px.png?0.4.2-15" /></a></h1>
<h2>Configuration Manual</h2>
<p><strong>version 3.0-dev6</strong></p>
<p><strong>version 3.0-dev6-5</strong></p>
<p>
2024/03/26<br>

Expand Down Expand Up @@ -8774,6 +8776,13 @@ <h2 id="chapter-3.2" data-target="3.2"><small><a class="small" href="#3.2">3.2.<
expiration times. It must be set to a lower value than
&quot;<a href="#tune.ssl.ocsp-update.maxdelay">tune.ssl.ocsp-update.maxdelay</a>&quot;. See option &quot;<a href="#ocsp-update">ocsp-update</a>&quot; for more
information about the auto update mechanism.
</pre><a class="anchor" name="tune.ssl.ocsp-update.mode"></a><a class="anchor" name="3-tune.ssl.ocsp-update.mode"></a><a class="anchor" name="3.2-tune.ssl.ocsp-update.mode"></a><a class="anchor" name="tune.ssl.ocsp-update.mode (Global parameters)"></a><a class="anchor" name="tune.ssl.ocsp-update.mode (Performance tuning)"></a><div class="keyword"><b><a class="anchor" name="tune.ssl.ocsp-update.mode"></a><a href="#3.2-tune.ssl.ocsp-update.mode">tune.ssl.ocsp-update.mode</a></b> <span style="color: #008">[ on | off ]</span></div><pre class="text">Sets the default ocsp-update mode for all certificates used in the
configuration. This global option can be superseded by the crt-list
&quot;<a href="#ocsp-update">ocsp-update</a>&quot; option but an error will be raised if a given certificate has
two distinct configurations simultaneously. This option is set to &quot;off&quot; by
default.
See option &quot;<a href="#ocsp-update">ocsp-update</a>&quot; for more information about the auto update
mechanism.
</pre><a class="anchor" name="tune.stick-counters"></a><a class="anchor" name="3-tune.stick-counters"></a><a class="anchor" name="3.2-tune.stick-counters"></a><a class="anchor" name="tune.stick-counters (Global parameters)"></a><a class="anchor" name="tune.stick-counters (Performance tuning)"></a><div class="keyword"><b><a class="anchor" name="tune.stick-counters"></a><a href="#3.2-tune.stick-counters">tune.stick-counters</a></b> <span style="color: #080">&lt;number&gt;</span></div><pre class="text">Sets the number of stick-counters that may be tracked at the same time by a
connection or a request via &quot;track-sc*&quot; actions in &quot;<a href="#tcp-request">tcp-request</a>&quot; or
&quot;<a href="#http-request">http-request</a>&quot; rules. The default value is set at build time by the macro
Expand Down Expand Up @@ -19945,11 +19954,15 @@ <h2 id="chapter-5.1" data-target="5.1"><small><a class="small" href="#5.1">5.1.<
Its value defaults to 'off'.
Please note that for now, this option can only be used in a crt-list line, it
cannot be used directly on a bind line. It lies in this &quot;Bind options&quot;
section because it is still a frontend option. This limitation was set so
that the option applies to only one certificate at a time.
section because it is still a frontend option. For now, the only way to
enable OCSP auto update on a bind line certificate is via the global option
&quot;tune.ocsp-update.mode&quot;.
If a given certificate is used in multiple crt-lists with different values of
the 'ocsp-update' set, an error will be raised. Here is an example
configuration enabling it:
the 'ocsp-update' set, an error will be raised. Likewise, if a certificate
inherits from the global option on a bind line and has an incompatible
explicit 'ocsp-update' option set in a crt-list, the same error will be
raised.
Here is an example configuration enabling it:

haproxy.cfg:
frontend fe
Expand All @@ -19967,12 +19980,12 @@ <h2 id="chapter-5.1" data-target="5.1"><small><a class="small" href="#5.1">5.1.<
hour limit. A minimum update interval of 5 minutes will still exist in order
to avoid updating too often responses that have a really short expire time or
even no 'Next Update' at all. Because of this hard limit, please note that
when auto update is set to 'on' or 'auto', any OCSP response loaded during
init will not be updated until at least 5 minutes, even if its expire time
ends before now+5m. This should not be too much of a hassle since an OCSP
response must be valid when it gets loaded during init (its expire time must
be in the future) so it is unlikely that this response expires in such a
short time after init.
when auto update is set to 'on', any OCSP response loaded during init will
not be updated until at least 5 minutes, even if its expire time ends before
now+5m. This should not be too much of a hassle since an OCSP response must
be valid when it gets loaded during init (its expire time must be in the
future) so it is unlikely that this response expires in such a short time
after init.
On the other hand, if a certificate has an OCSP uri specified and no OCSP
response, setting this option to 'on' for the given certificate will ensure
that the OCSP response gets fetched automatically right after init.
Expand Down Expand Up @@ -29761,7 +29774,7 @@ <h2 id="chapter-11.3" data-target="11.3"><small><a class="small" href="#11.3">11
<br>
<hr>
<div class="text-right">
HAProxy 3.0-dev6 &ndash; Configuration Manual<br>
HAProxy 3.0-dev6-5 &ndash; Configuration Manual<br>
<small>, 2024/03/26</small>
</div>
</div>
Expand Down
8 changes: 4 additions & 4 deletions docs/dev/intro.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta charset="utf-8" />
<title>HAProxy version 3.0-dev6 - Starter Guide</title>
<title>HAProxy version 3.0-dev6-5 - Starter Guide</title>
<link href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet" />
<link href="https://raw.githubusercontent.com/thomaspark/bootswatch/v3.3.7/cerulean/bootstrap.min.css" rel="stylesheet" />
<link href="../css/page.css?0.4.2-15" rel="stylesheet" />
Expand Down Expand Up @@ -484,7 +484,7 @@
You can use <strong>left</strong> and <strong>right</strong> arrow keys to navigate between chapters.<br>
</p>
<p class="text-right">
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2024/03/26</b></small>
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2024/03/27</b></small>
</p>
</div>
<!-- /.sidebar -->
Expand All @@ -495,7 +495,7 @@
<div class="text-center">
<h1><a href="http://www.haproxy.org/" title="HAProxy"><img src="../img/HAProxyCommunityEdition_60px.png?0.4.2-15" /></a></h1>
<h2>Starter Guide</h2>
<p><strong>version 3.0-dev6</strong></p>
<p><strong>version 3.0-dev6-5</strong></p>
<p>
<br>

Expand Down Expand Up @@ -2515,7 +2515,7 @@ <h2 id="chapter-4.4" data-target="4.4"><small><a class="small" href="#4.4">4.4.<
<br>
<hr>
<div class="text-right">
HAProxy 3.0-dev6 &ndash; Starter Guide<br>
HAProxy 3.0-dev6-5 &ndash; Starter Guide<br>
<small>, </small>
</div>
</div>
Expand Down
8 changes: 4 additions & 4 deletions docs/dev/management.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta charset="utf-8" />
<title>HAProxy version 3.0-dev6 - Management Guide</title>
<title>HAProxy version 3.0-dev6-5 - Management Guide</title>
<link href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet" />
<link href="https://raw.githubusercontent.com/thomaspark/bootswatch/v3.3.7/cerulean/bootstrap.min.css" rel="stylesheet" />
<link href="../css/page.css?0.4.2-15" rel="stylesheet" />
Expand Down Expand Up @@ -616,7 +616,7 @@
You can use <strong>left</strong> and <strong>right</strong> arrow keys to navigate between chapters.<br>
</p>
<p class="text-right">
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2024/03/26</b></small>
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2024/03/27</b></small>
</p>
</div>
<!-- /.sidebar -->
Expand All @@ -627,7 +627,7 @@
<div class="text-center">
<h1><a href="http://www.haproxy.org/" title="HAProxy"><img src="../img/HAProxyCommunityEdition_60px.png?0.4.2-15" /></a></h1>
<h2>Management Guide</h2>
<p><strong>version 3.0-dev6</strong></p>
<p><strong>version 3.0-dev6-5</strong></p>
<p>
<br>

Expand Down Expand Up @@ -5073,7 +5073,7 @@ <h3 id="chapter-9.4.1" data-target="9.4.1"><small><a class="small" href="#9.4.1"
<br>
<hr>
<div class="text-right">
HAProxy 3.0-dev6 &ndash; Management Guide<br>
HAProxy 3.0-dev6-5 &ndash; Management Guide<br>
<small>, </small>
</div>
</div>
Expand Down

0 comments on commit 66f78f0

Please sign in to comment.