|
2 | 2 | <html lang="en"> |
3 | 3 | <head> |
4 | 4 | <meta charset="utf-8" /> |
5 | | - <title>HAProxy version 3.3.0-1 - Configuration Manual</title> |
| 5 | + <title>HAProxy version 3.3.0-42 - Configuration Manual</title> |
6 | 6 | <link href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet" /> |
7 | 7 | <link href="https://raw.githubusercontent.com/thomaspark/bootswatch/v3.3.7/cerulean/bootstrap.min.css" rel="stylesheet" /> |
8 | 8 | <link href="../css/page.css?0.4.2-15" rel="stylesheet" /> |
|
2933 | 2933 |
|
2934 | 2934 | <a class="list-group-item" href="#queue">queue</a> |
2935 | 2935 |
|
2936 | | - <a class="list-group-item" href="#quic-cc-algo">quic-cc-algo</a> |
| 2936 | + <a class="list-group-item" href="#quic-cc-algo (Bind options)">quic-cc-algo (Bind options)</a> |
| 2937 | + |
| 2938 | + <a class="list-group-item" href="#quic-cc-algo (Server and default-server options)">quic-cc-algo (Server and default-server options)</a> |
2937 | 2939 |
|
2938 | 2940 | <a class="list-group-item" href="#quic-force-retry">quic-force-retry</a> |
2939 | 2941 |
|
|
4699 | 4701 | You can use <strong>left</strong> and <strong>right</strong> arrow keys to navigate between chapters.<br> |
4700 | 4702 | </p> |
4701 | 4703 | <p class="text-right"> |
4702 | | - <small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2025/11/26</b></small> |
| 4704 | + <small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2025/12/12</b></small> |
4703 | 4705 | </p> |
4704 | 4706 | </div> |
4705 | 4707 | <!-- /.sidebar --> |
|
4710 | 4712 | <div class="text-center"> |
4711 | 4713 | <h1><a href="http://www.haproxy.org/" title="HAProxy"><img src="../img/HAProxyCommunityEdition_60px.png?0.4.2-15" /></a></h1> |
4712 | 4714 | <h2>Configuration Manual</h2> |
4713 | | - <p><strong>version 3.3.0-1</strong></p> |
| 4715 | + <p><strong>version 3.3.0-42</strong></p> |
4714 | 4716 | <p> |
4715 | 4717 | 2025/11/26<br> |
4716 | 4718 |
|
@@ -10223,7 +10225,7 @@ <h2 id="chapter-3.2" data-target="3.2"><small><a class="small" href="#3.2">3.2.< |
10223 | 10225 |
|
10224 | 10226 | The default value is 480k. |
10225 | 10227 |
|
10226 | | -See also the "<a href="#quic-cc-algo">quic-cc-algo</a>" bind option. |
| 10228 | +See also the "<span class="dropdown"><a class="dropdown-toggle" data-toggle="dropdown" href="#">quic-cc-algo<span class="caret"></span></a><ul class="dropdown-menu"><li class="dropdown-header">This keyword is available in sections :</li><li><a href="#quic-cc-algo%20%28Bind%20options%29">Bind options</a></li><li><a href="#quic-cc-algo%20%28Server%20and%20default-server%20options%29">Server and default-server options</a></li></ul></span>" bind and server options. |
10227 | 10229 | </pre><a class="anchor" name="tune.quic.frontend.default-max-window-size"></a><a class="anchor" name="3-tune.quic.frontend.default-max-window-size"></a><a class="anchor" name="3.2-tune.quic.frontend.default-max-window-size"></a><a class="anchor" name="tune.quic.frontend.default-max-window-size (Global section)"></a><a class="anchor" name="tune.quic.frontend.default-max-window-size (Performance tuning)"></a><div class="keyword"><b><a class="anchor" name="tune.quic.frontend.default-max-window-size"></a><a href="#3.2-tune.quic.frontend.default-max-window-size">tune.quic.frontend.default-max-window-size</a></b> <span style="color: #080"><size></span> <span class="label label-warning">(deprecated)</span></div><pre class="text">This keyword has been deprecated in 3.3 and will be removed in 3.5. It is |
10228 | 10230 | part of the streamlining process apply on QUIC configuration. If used, this |
10229 | 10231 | setting will only be applied on frontend connections. |
@@ -10359,7 +10361,7 @@ <h2 id="chapter-3.2" data-target="3.2"><small><a class="small" href="#3.2">3.2.< |
10359 | 10361 | deactivate it for networks with very high bandwidth/low latency |
10360 | 10362 | characteristics to prevent unwanted delay and reduce CPU consumption. |
10361 | 10363 |
|
10362 | | -See also the "<a href="#quic-cc-algo">quic-cc-algo</a>" bind option. |
| 10364 | +See also the "<span class="dropdown"><a class="dropdown-toggle" data-toggle="dropdown" href="#">quic-cc-algo<span class="caret"></span></a><ul class="dropdown-menu"><li class="dropdown-header">This keyword is available in sections :</li><li><a href="#quic-cc-algo%20%28Bind%20options%29">Bind options</a></li><li><a href="#quic-cc-algo%20%28Server%20and%20default-server%20options%29">Server and default-server options</a></li></ul></span>" bind and server options. |
10363 | 10365 | </pre><a class="anchor" name="tune.quic.disable-tx-pacing"></a><a class="anchor" name="3-tune.quic.disable-tx-pacing"></a><a class="anchor" name="3.2-tune.quic.disable-tx-pacing"></a><a class="anchor" name="tune.quic.disable-tx-pacing (Global section)"></a><a class="anchor" name="tune.quic.disable-tx-pacing (Performance tuning)"></a><div class="keyword"><b><a class="anchor" name="tune.quic.disable-tx-pacing"></a><a href="#3.2-tune.quic.disable-tx-pacing">tune.quic.disable-tx-pacing</a></b> <span class="label label-warning">(deprecated)</span></div><pre class="text">This keyword has been deprecated in 3.3 and will be removed in 3.5. It is |
10364 | 10366 | part of the streamlining process apply on QUIC configuration. If used, this |
10365 | 10367 | setting will only be applied on frontend connections. |
@@ -14156,8 +14158,9 @@ <h2 id="chapter-4.2" data-target="4.2"><small><a class="small" href="#4.2">4.2.< |
14156 | 14158 | server features are supported, but not TCP or HTTP specific ones. |
14157 | 14159 |
|
14158 | 14160 | spop When used in a backend section, it will turn the backend into a |
14159 | | - log backend. This mode is mandatory and automatically set, if |
14160 | | - necessary, for backends referenced by SPOE engines.</pre> |
| 14161 | + spop backend. This mode is mandatory if the backend contains |
| 14162 | + SPOA servers, but when mode is tcp, it will automatically be |
| 14163 | + converted to mode spop if such servers are detected.</pre> |
14161 | 14164 | </div> |
14162 | 14165 | <pre class="text">When doing content switching, it is mandatory that the frontend and the |
14163 | 14166 | backend are in the same mode (generally HTTP), otherwise the configuration |
@@ -21402,9 +21405,10 @@ <h2 id="chapter-5.1" data-target="5.1"><small><a class="small" href="#5.1">5.1.< |
21402 | 21405 | See https://datatracker.ietf.org/doc/draft-ietf-tls-esni/ |
21403 | 21406 |
|
21404 | 21407 | This is an experimental feature, which requires the |
21405 | | -"<a href="#expose-experimental-directives">expose-experimental-directives</a>" option in the global section. It also |
21406 | | -necessitates an OpenSSL version that supports ECH, and HAProxy must be |
21407 | | -compiled with USE_ECH=1. |
| 21408 | +"<a href="#expose-experimental-directives">expose-experimental-directives</a>" option in the global section. |
| 21409 | +It also necessitates an OpenSSL version that supports ECH |
| 21410 | +( https://github.com/openssl/openssl/tree/feature/ech), and HAProxy must be |
| 21411 | +compiled with USE_ECH=1. The ECH API of AWS-LC is not supported. |
21408 | 21412 | </pre><div class="separator"> |
21409 | 21413 | <span class="label label-success">Example:</span> |
21410 | 21414 | <pre class="prettyprint"> |
@@ -22989,7 +22993,14 @@ <h2 id="chapter-5.2" data-target="5.2"><small><a class="small" href="#5.2">5.2.< |
22989 | 22993 | instance, if "proto h1" is set, the ALPN should not be set to "h2". |
22990 | 22994 |
|
22991 | 22995 | See also "<a href="#ws">ws</a>" to use an alternative protocol for websocket streams. |
22992 | | -</pre><a class="anchor" name="redir"></a><a class="anchor" name="5-redir"></a><a class="anchor" name="5.2-redir"></a><a class="anchor" name="redir (Bind and server options)"></a><a class="anchor" name="redir (Server and default-server options)"></a><div class="keyword"><b><a class="anchor" name="redir"></a><a href="#5.2-redir">redir</a></b> <span style="color: #080"><prefix></span></div><pre class="text">May be used in the following contexts: http |
| 22996 | +</pre><a class="anchor" name="quic-cc-algo"></a><a class="anchor" name="5-quic-cc-algo"></a><a class="anchor" name="5.2-quic-cc-algo"></a><a class="anchor" name="quic-cc-algo (Bind and server options)"></a><a class="anchor" name="quic-cc-algo (Server and default-server options)"></a><div class="keyword"><b><a class="anchor" name="quic-cc-algo"></a><a href="#5.2-quic-cc-algo">quic-cc-algo</a></b> <span style="color: #800">{ cubic | newreno | bbr | nocc }</span><span style="color: #008">[(<span style="color: #080"><args,...></span>)]</span></div><pre class="text">This is a QUIC specific setting to select the congestion control algorithm |
| 22997 | +for any connection targetting this server. They are similar to those used by |
| 22998 | +TCP. See the bind option with a similar name for a complete description of |
| 22999 | +all customization options. |
| 23000 | + |
| 23001 | +Default value: cubic |
| 23002 | +</pre><div class="page-header"><b>See also:</b> "<a href="#tune.quic.be.tx.pacing">tune.quic.be.tx.pacing</a>" and "<a href="#tune.quic.be.cc.max-win-size">tune.quic.be.cc.max-win-size</a>"</div> |
| 23003 | +<a class="anchor" name="redir"></a><a class="anchor" name="5-redir"></a><a class="anchor" name="5.2-redir"></a><a class="anchor" name="redir (Bind and server options)"></a><a class="anchor" name="redir (Server and default-server options)"></a><div class="keyword"><b><a class="anchor" name="redir"></a><a href="#5.2-redir">redir</a></b> <span style="color: #080"><prefix></span></div><pre class="text">May be used in the following contexts: http |
22993 | 23004 |
|
22994 | 23005 | The "<a href="#redir">redir</a>" parameter enables the redirection mode for all GET and HEAD |
22995 | 23006 | requests addressing this server. This means that instead of having HAProxy |
@@ -23737,27 +23748,27 @@ <h2 id="chapter-6.2" data-target="6.2"><small><a class="small" href="#6.2">6.2.< |
23737 | 23748 | <a class="anchor" id="6.2.1" name="6.2.1"></a> |
23738 | 23749 | <h3 id="chapter-6.2.1" data-target="6.2.1"><small><a class="small" href="#6.2.1">6.2.1.</a></small> Cache section</h3> |
23739 | 23750 | <div><a class="anchor" name="cache"></a><a class="anchor" name="6-cache"></a><a class="anchor" name="6.2.1-cache"></a><a class="anchor" name="cache (Cache)"></a><a class="anchor" name="cache (Cache section)"></a><div class="keyword"><b><a class="anchor" name="cache"></a><a href="#6.2.1-cache">cache</a></b> <span style="color: #080"><name></span></div><pre class="text">Declare a cache section, allocate a shared cache memory named <name>, the |
23740 | | -size of cache is mandatory. |
23741 | | -</pre><a class="anchor" name="total-max-size"></a><a class="anchor" name="6-total-max-size"></a><a class="anchor" name="6.2.1-total-max-size"></a><a class="anchor" name="total-max-size (Cache)"></a><a class="anchor" name="total-max-size (Cache section)"></a><div class="keyword"><b><a class="anchor" name="total-max-size"></a><a href="#6.2.1-total-max-size">total-max-size</a></b> <span style="color: #080"><megabytes></span></div><pre class="text">Define the size in RAM of the cache in megabytes. This size is split in |
23742 | | -blocks of 1kB which are used by the cache entries. Its maximum value is 4095. |
23743 | | -</pre><a class="anchor" name="max-object-size"></a><a class="anchor" name="6-max-object-size"></a><a class="anchor" name="6.2.1-max-object-size"></a><a class="anchor" name="max-object-size (Cache)"></a><a class="anchor" name="max-object-size (Cache section)"></a><div class="keyword"><b><a class="anchor" name="max-object-size"></a><a href="#6.2.1-max-object-size">max-object-size</a></b> <span style="color: #080"><bytes></span></div><pre class="text">Define the maximum size of the objects to be cached. Must not be greater than |
23744 | | -an half of "<a href="#total-max-size">total-max-size</a>". If not set, it equals to a 256th of the cache size. |
23745 | | -All objects with sizes larger than "<a href="#max-object-size">max-object-size</a>" will not be cached. |
| 23751 | +size of cache is mandatory (see keyword "<a href="#total-max-size">total-max-size</a>" below). |
23746 | 23752 | </pre><a class="anchor" name="max-age"></a><a class="anchor" name="6-max-age"></a><a class="anchor" name="6.2.1-max-age"></a><a class="anchor" name="max-age (Cache)"></a><a class="anchor" name="max-age (Cache section)"></a><div class="keyword"><b><a class="anchor" name="max-age"></a><a href="#6.2.1-max-age">max-age</a></b> <span style="color: #080"><seconds></span></div><pre class="text">Define the maximum expiration duration. The expiration is set as the lowest |
23747 | 23753 | value between the s-maxage or max-age (in this order) directive in the |
23748 | 23754 | Cache-Control response header and this value. The default value is 60 |
23749 | 23755 | seconds, which means that you can't cache an object more than 60 seconds by |
23750 | 23756 | default. |
| 23757 | +</pre><a class="anchor" name="max-object-size"></a><a class="anchor" name="6-max-object-size"></a><a class="anchor" name="6.2.1-max-object-size"></a><a class="anchor" name="max-object-size (Cache)"></a><a class="anchor" name="max-object-size (Cache section)"></a><div class="keyword"><b><a class="anchor" name="max-object-size"></a><a href="#6.2.1-max-object-size">max-object-size</a></b> <span style="color: #080"><bytes></span></div><pre class="text">Define the maximum size of the objects to be cached. Must not be greater than |
| 23758 | +an half of "<a href="#total-max-size">total-max-size</a>". If not set, it equals to a 256th of the cache size. |
| 23759 | +All objects with sizes larger than "<a href="#max-object-size">max-object-size</a>" will not be cached. |
| 23760 | +</pre><a class="anchor" name="max-secondary-entries"></a><a class="anchor" name="6-max-secondary-entries"></a><a class="anchor" name="6.2.1-max-secondary-entries"></a><a class="anchor" name="max-secondary-entries (Cache)"></a><a class="anchor" name="max-secondary-entries (Cache section)"></a><div class="keyword"><b><a class="anchor" name="max-secondary-entries"></a><a href="#6.2.1-max-secondary-entries">max-secondary-entries</a></b> <span style="color: #080"><number></span></div><pre class="text">Define the maximum number of simultaneous secondary entries with the same primary |
| 23761 | +key in the cache. This needs the vary support to be enabled. Its default value is 10 |
| 23762 | +and should be passed a strictly positive integer. |
23751 | 23763 | </pre><a class="anchor" name="process-vary"></a><a class="anchor" name="6-process-vary"></a><a class="anchor" name="6.2.1-process-vary"></a><a class="anchor" name="process-vary (Cache)"></a><a class="anchor" name="process-vary (Cache section)"></a><div class="keyword"><b><a class="anchor" name="process-vary"></a><a href="#6.2.1-process-vary">process-vary</a></b> <span style="color: #080"><on/off></span></div><pre class="text">Enable or disable the processing of the Vary header. When disabled, a response |
23752 | 23764 | containing such a header will never be cached. When enabled, we need to calculate |
23753 | 23765 | a preliminary hash for a subset of request headers on all the incoming requests |
23754 | 23766 | (which might come with a cpu cost) which will be used to build a secondary |
23755 | 23767 | key for a given request (see RFC 7234#4.1). The secondary key is built out of |
23756 | 23768 | the contents of the 'accept-encoding', 'referer' and 'origin' headers for |
23757 | 23769 | now. The default value is off (disabled). |
23758 | | -</pre><a class="anchor" name="max-secondary-entries"></a><a class="anchor" name="6-max-secondary-entries"></a><a class="anchor" name="6.2.1-max-secondary-entries"></a><a class="anchor" name="max-secondary-entries (Cache)"></a><a class="anchor" name="max-secondary-entries (Cache section)"></a><div class="keyword"><b><a class="anchor" name="max-secondary-entries"></a><a href="#6.2.1-max-secondary-entries">max-secondary-entries</a></b> <span style="color: #080"><number></span></div><pre class="text">Define the maximum number of simultaneous secondary entries with the same primary |
23759 | | -key in the cache. This needs the vary support to be enabled. Its default value is 10 |
23760 | | -and should be passed a strictly positive integer. |
| 23770 | +</pre><a class="anchor" name="total-max-size"></a><a class="anchor" name="6-total-max-size"></a><a class="anchor" name="6.2.1-total-max-size"></a><a class="anchor" name="total-max-size (Cache)"></a><a class="anchor" name="total-max-size (Cache section)"></a><div class="keyword"><b><a class="anchor" name="total-max-size"></a><a href="#6.2.1-total-max-size">total-max-size</a></b> <span style="color: #080"><megabytes></span></div><pre class="text">Define the size in RAM of the cache in megabytes. This size is split in |
| 23771 | +blocks of 1kB which are used by the cache entries. Its maximum value is 4095. |
23761 | 23772 | </pre></div> |
23762 | 23773 | <a class="anchor" id="6.2.2" name="6.2.2"></a> |
23763 | 23774 | <h3 id="chapter-6.2.2" data-target="6.2.2"><small><a class="small" href="#6.2.2">6.2.2.</a></small> Proxy section</h3> |
@@ -33818,7 +33829,7 @@ <h2 id="chapter-12.8" data-target="12.8"><small><a class="small" href="#12.8">12 |
33818 | 33829 | <br> |
33819 | 33830 | <hr> |
33820 | 33831 | <div class="text-right"> |
33821 | | - HAProxy 3.3.0-1 – Configuration Manual<br> |
| 33832 | + HAProxy 3.3.0-42 – Configuration Manual<br> |
33822 | 33833 | <small>, 2025/11/26</small> |
33823 | 33834 | </div> |
33824 | 33835 | </div> |
|
0 commit comments