Update docs for 2.8

HAProxy Community · HAProxy Community · commit f4ba60244e33 · 2025-04-17T00:56:39.000Z
diff --git a/docs/2.8/configuration.html b/docs/2.8/configuration.html
@@ -2,7 +2,7 @@
 <html lang="en">
 	<head>
 		<meta charset="utf-8" />
-		<title>HAProxy version 2.8.14-5 - Configuration Manual</title>
+		<title>HAProxy version 2.8.14-80 - 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" />
@@ -4294,7 +4294,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>2025/01/29</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>2025/04/16</b></small>
 				</p>
 			</div>
 			<!-- /.sidebar -->
@@ -4305,7 +4305,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 2.8.14-5</strong></p>
+							<p><strong>version 2.8.14-80</strong></p>
 							<p>
 								2025/01/29<br>
 								
@@ -6505,6 +6505,7 @@ <h2 id="chapter-2.7" data-target="2.7"><small><a class="small" href="#2.7">2.7.<
    - <a href="#nopoll">nopoll</a>
    - <a href="#noreuseport">noreuseport</a>
    - <a href="#nosplice">nosplice</a>
+   - <a href="#profiling.memory">profiling.memory</a>
    - <a href="#profiling.tasks">profiling.tasks</a>
    - <a href="#server-state-base">server-state-base</a>
    - <a href="#server-state-file">server-state-file</a>
@@ -6534,13 +6535,14 @@ <h2 id="chapter-2.7" data-target="2.7"><small><a class="small" href="#2.7">2.7.<
    - <a href="#tune.http.maxhdr">tune.http.maxhdr</a>
    - <a href="#tune.idle-pool.shared">tune.idle-pool.shared</a>
    - <a href="#tune.idletimer">tune.idletimer</a>
+   - <a href="#tune.lua.burst-timeout">tune.lua.burst-timeout</a>
    - <a href="#tune.lua.forced-yield">tune.lua.forced-yield</a>
+   - <a href="#tune.lua.log.loggers">tune.lua.log.loggers</a>
+   - <a href="#tune.lua.log.stderr">tune.lua.log.stderr</a>
    - <a href="#tune.lua.maxmem">tune.lua.maxmem</a>
    - <a href="#tune.lua.service-timeout">tune.lua.service-timeout</a>
    - <a href="#tune.lua.session-timeout">tune.lua.session-timeout</a>
    - <a href="#tune.lua.task-timeout">tune.lua.task-timeout</a>
-   - <a href="#tune.lua.log.loggers">tune.lua.log.loggers</a>
-   - <a href="#tune.lua.log.stderr">tune.lua.log.stderr</a>
    - <a href="#tune.maxaccept">tune.maxaccept</a>
    - <a href="#tune.maxpollevents">tune.maxpollevents</a>
    - <a href="#tune.maxrewrite">tune.maxrewrite</a>
@@ -8301,21 +8303,6 @@ <h2 id="chapter-3.2" data-target="3.2"><small><a class="small" href="#3.2">3.2.<
 using &quot;off&quot; for troubleshooting, or for situations where connections are
 short-lived and it is estimated that the operating system already provides a
 good enough distribution. The default is &quot;on&quot;.
-</pre><a class="anchor" name="tune.lua.forced-yield"></a><a class="anchor" name="3-tune.lua.forced-yield"></a><a class="anchor" name="3.2-tune.lua.forced-yield"></a><a class="anchor" name="tune.lua.forced-yield (Global parameters)"></a><a class="anchor" name="tune.lua.forced-yield (Performance tuning)"></a><div class="keyword"><b><a class="anchor" name="tune.lua.forced-yield"></a><a href="#3.2-tune.lua.forced-yield">tune.lua.forced-yield</a></b> <span style="color: #080">&lt;number&gt;</span></div><pre class="text">This directive forces the Lua engine to execute a yield each &lt;number&gt; of
-instructions executed. This permits interrupting a long script and allows the
-HAProxy scheduler to process other tasks like accepting connections or
-forwarding traffic. The default value is 10000 instructions. If HAProxy often
-executes some Lua code but more responsiveness is required, this value can be
-lowered. If the Lua code is quite long and its result is absolutely required
-to process the data, the &lt;number&gt; can be increased.
-</pre><a class="anchor" name="tune.lua.maxmem"></a><a class="anchor" name="3-tune.lua.maxmem"></a><a class="anchor" name="3.2-tune.lua.maxmem"></a><a class="anchor" name="tune.lua.maxmem (Global parameters)"></a><a class="anchor" name="tune.lua.maxmem (Performance tuning)"></a><div class="keyword"><b><a class="anchor" name="tune.lua.maxmem"></a><a href="#3.2-tune.lua.maxmem">tune.lua.maxmem</a></b></div><pre class="text">Sets the maximum amount of RAM in megabytes per process usable by Lua. By
-default it is zero which means unlimited. It is important to set a limit to
-ensure that a bug in a script will not result in the system running out of
-memory.
-</pre><a class="anchor" name="tune.lua.session-timeout"></a><a class="anchor" name="3-tune.lua.session-timeout"></a><a class="anchor" name="3.2-tune.lua.session-timeout"></a><a class="anchor" name="tune.lua.session-timeout (Global parameters)"></a><a class="anchor" name="tune.lua.session-timeout (Performance tuning)"></a><div class="keyword"><b><a class="anchor" name="tune.lua.session-timeout"></a><a href="#3.2-tune.lua.session-timeout">tune.lua.session-timeout</a></b> <span style="color: #080">&lt;timeout&gt;</span></div><pre class="text">This is the execution timeout for the Lua sessions. This is useful for
-preventing infinite loops or spending too much time in Lua. This timeout
-counts only the pure Lua runtime. If the Lua does a sleep, the sleep is
-not taken in account. The default timeout is 4s.
 </pre><a class="anchor" name="tune.lua.burst-timeout"></a><a class="anchor" name="3-tune.lua.burst-timeout"></a><a class="anchor" name="3.2-tune.lua.burst-timeout"></a><a class="anchor" name="tune.lua.burst-timeout (Global parameters)"></a><a class="anchor" name="tune.lua.burst-timeout (Performance tuning)"></a><div class="keyword"><b><a class="anchor" name="tune.lua.burst-timeout"></a><a href="#3.2-tune.lua.burst-timeout">tune.lua.burst-timeout</a></b> <span style="color: #080">&lt;timeout&gt;</span></div><pre class="text">The &quot;burst&quot; execution timeout applies to any Lua handler. If the handler
 fails to finish or yield before timeout is reached, it will be aborted to
 prevent thread contention, to prevent traffic from not being served for too
@@ -8364,14 +8351,20 @@ <h2 id="chapter-3.2" data-target="3.2"><small><a class="small" href="#3.2">3.2.<
   - increasing tune.lua.burst-timeout
 
 Setting value to 0 completely disables this protection.
-</pre><a class="anchor" name="tune.lua.service-timeout"></a><a class="anchor" name="3-tune.lua.service-timeout"></a><a class="anchor" name="3.2-tune.lua.service-timeout"></a><a class="anchor" name="tune.lua.service-timeout (Global parameters)"></a><a class="anchor" name="tune.lua.service-timeout (Performance tuning)"></a><div class="keyword"><b><a class="anchor" name="tune.lua.service-timeout"></a><a href="#3.2-tune.lua.service-timeout">tune.lua.service-timeout</a></b> <span style="color: #080">&lt;timeout&gt;</span></div><pre class="text">This is the execution timeout for the Lua services. This is useful for
-preventing infinite loops or spending too much time in Lua. This timeout
-counts only the pure Lua runtime. If the Lua does a sleep, the sleep is
-not taken in account. The default timeout is 4s.
-</pre><a class="anchor" name="tune.lua.task-timeout"></a><a class="anchor" name="3-tune.lua.task-timeout"></a><a class="anchor" name="3.2-tune.lua.task-timeout"></a><a class="anchor" name="tune.lua.task-timeout (Global parameters)"></a><a class="anchor" name="tune.lua.task-timeout (Performance tuning)"></a><div class="keyword"><b><a class="anchor" name="tune.lua.task-timeout"></a><a href="#3.2-tune.lua.task-timeout">tune.lua.task-timeout</a></b> <span style="color: #080">&lt;timeout&gt;</span></div><pre class="text">Purpose is the same as &quot;<a href="#tune.lua.session-timeout">tune.lua.session-timeout</a>&quot;, but this timeout is
-dedicated to the tasks. By default, this timeout isn't set because a task may
-remain alive during of the lifetime of HAProxy. For example, a task used to
-check servers.
+</pre><a class="anchor" name="tune.lua.forced-yield"></a><a class="anchor" name="3-tune.lua.forced-yield"></a><a class="anchor" name="3.2-tune.lua.forced-yield"></a><a class="anchor" name="tune.lua.forced-yield (Global parameters)"></a><a class="anchor" name="tune.lua.forced-yield (Performance tuning)"></a><div class="keyword"><b><a class="anchor" name="tune.lua.forced-yield"></a><a href="#3.2-tune.lua.forced-yield">tune.lua.forced-yield</a></b> <span style="color: #080">&lt;number&gt;</span></div><pre class="text">This directive forces the Lua engine to execute a yield each &lt;number&gt; of
+instructions executed. This permits interrupting a long script and allows the
+HAProxy scheduler to process other tasks like accepting connections or
+forwarding traffic. The default value is 10000 instructions for scripts loaded
+using &quot;<a href="#lua-load-per-thread">lua-load-per-thread</a>&quot; and MAX(500, 10000 / nbthread) instructions for
+scripts loaded using &quot;<a href="#lua-load">lua-load</a>&quot; (it was found to be an optimal value for
+performance while taking care of not creating thread contention with multiple
+threads competing for the global lua lock).
+
+If HAProxy often executes some Lua code but more responsiveness is required,
+this value can be lowered. If the Lua code is quite long and its result is
+absolutely required to process the data, the &lt;number&gt; can be increased, but
+the value should be set wisely as in multithreading context it could increase
+contention.
 </pre><a class="anchor" name="tune.lua.log.loggers"></a><a class="anchor" name="3-tune.lua.log.loggers"></a><a class="anchor" name="3.2-tune.lua.log.loggers"></a><a class="anchor" name="tune.lua.log.loggers (Global parameters)"></a><a class="anchor" name="tune.lua.log.loggers (Performance tuning)"></a><div class="keyword"><b><a class="anchor" name="tune.lua.log.loggers"></a><a href="#3.2-tune.lua.log.loggers">tune.lua.log.loggers</a></b> <span style="color: #800">{ on | off }</span></div><pre class="text">Enables ('on') or disables ('off') logging the output of LUA scripts via the
 loggers applicable to the current proxy, if any.
 
@@ -8388,6 +8381,22 @@ <h2 id="chapter-3.2" data-target="3.2"><small><a class="small" href="#3.2">3.2.<
 configured via tune.lua.log.loggers.
 
 Defaults to 'on'.
+</pre><a class="anchor" name="tune.lua.maxmem"></a><a class="anchor" name="3-tune.lua.maxmem"></a><a class="anchor" name="3.2-tune.lua.maxmem"></a><a class="anchor" name="tune.lua.maxmem (Global parameters)"></a><a class="anchor" name="tune.lua.maxmem (Performance tuning)"></a><div class="keyword"><b><a class="anchor" name="tune.lua.maxmem"></a><a href="#3.2-tune.lua.maxmem">tune.lua.maxmem</a></b> <span style="color: #080">&lt;number&gt;</span></div><pre class="text">Sets the maximum amount of RAM in megabytes per process usable by Lua. By
+default it is zero which means unlimited. It is important to set a limit to
+ensure that a bug in a script will not result in the system running out of
+memory.
+</pre><a class="anchor" name="tune.lua.service-timeout"></a><a class="anchor" name="3-tune.lua.service-timeout"></a><a class="anchor" name="3.2-tune.lua.service-timeout"></a><a class="anchor" name="tune.lua.service-timeout (Global parameters)"></a><a class="anchor" name="tune.lua.service-timeout (Performance tuning)"></a><div class="keyword"><b><a class="anchor" name="tune.lua.service-timeout"></a><a href="#3.2-tune.lua.service-timeout">tune.lua.service-timeout</a></b> <span style="color: #080">&lt;timeout&gt;</span></div><pre class="text">This is the execution timeout for the Lua services. This is useful for
+preventing infinite loops or spending too much time in Lua. This timeout
+counts only the pure Lua runtime. If the Lua does a sleep, the sleep is
+not taken in account. The default timeout is 4s.
+</pre><a class="anchor" name="tune.lua.session-timeout"></a><a class="anchor" name="3-tune.lua.session-timeout"></a><a class="anchor" name="3.2-tune.lua.session-timeout"></a><a class="anchor" name="tune.lua.session-timeout (Global parameters)"></a><a class="anchor" name="tune.lua.session-timeout (Performance tuning)"></a><div class="keyword"><b><a class="anchor" name="tune.lua.session-timeout"></a><a href="#3.2-tune.lua.session-timeout">tune.lua.session-timeout</a></b> <span style="color: #080">&lt;timeout&gt;</span></div><pre class="text">This is the execution timeout for the Lua sessions. This is useful for
+preventing infinite loops or spending too much time in Lua. This timeout
+counts only the pure Lua runtime. If the Lua does a sleep, the sleep is
+not taken in account. The default timeout is 4s.
+</pre><a class="anchor" name="tune.lua.task-timeout"></a><a class="anchor" name="3-tune.lua.task-timeout"></a><a class="anchor" name="3.2-tune.lua.task-timeout"></a><a class="anchor" name="tune.lua.task-timeout (Global parameters)"></a><a class="anchor" name="tune.lua.task-timeout (Performance tuning)"></a><div class="keyword"><b><a class="anchor" name="tune.lua.task-timeout"></a><a href="#3.2-tune.lua.task-timeout">tune.lua.task-timeout</a></b> <span style="color: #080">&lt;timeout&gt;</span></div><pre class="text">Purpose is the same as &quot;<a href="#tune.lua.session-timeout">tune.lua.session-timeout</a>&quot;, but this timeout is
+dedicated to the tasks. By default, this timeout isn't set because a task may
+remain alive during of the lifetime of HAProxy. For example, a task used to
+check servers.
 </pre><a class="anchor" name="tune.maxaccept"></a><a class="anchor" name="3-tune.maxaccept"></a><a class="anchor" name="3.2-tune.maxaccept"></a><a class="anchor" name="tune.maxaccept (Global parameters)"></a><a class="anchor" name="tune.maxaccept (Performance tuning)"></a><div class="keyword"><b><a class="anchor" name="tune.maxaccept"></a><a href="#3.2-tune.maxaccept">tune.maxaccept</a></b> <span style="color: #080">&lt;number&gt;</span></div><pre class="text">Sets the maximum number of consecutive connections a process may accept in a
 row before switching to other work. In single process mode, higher numbers
 used to give better performance at high connection rates, though this is not
@@ -15089,7 +15098,8 @@ <h2 id="chapter-4.2" data-target="4.2"><small><a class="small" href="#4.2">4.2.<
            third retry. You can disable redispatches with a value of 0.</pre>
 </div>
 <pre class="text">In HTTP mode, if a server designated by a cookie is down, clients may
-definitely stick to it because they cannot flush the cookie, so they will not
+definitely stick to it, for example when using &quot;<a href="#option%20persist">option persist</a>&quot; or
+&quot;<a href="#force-persist">force-persist</a>&quot;, because they cannot flush the cookie, so they will not
 be able to access the service anymore.
 
 Specifying &quot;<a href="#option%20redispatch">option redispatch</a>&quot; will allow the proxy to break cookie or
@@ -15121,7 +15131,7 @@ <h2 id="chapter-4.2" data-target="4.2"><small><a class="small" href="#4.2">4.2.<
 
 If this option has been enabled in a &quot;defaults&quot; section, it can be disabled
 in a specific instance by prepending the &quot;no&quot; keyword before it.
-</pre><div class="page-header"><b>See also :</b> &quot;<a href="#retries">retries</a>&quot;, &quot;<a href="#force-persist">force-persist</a>&quot;</div>
+</pre><div class="page-header"><b>See also :</b> &quot;<a href="#option%20persist">option persist</a>&quot;, &quot;<a href="#force-persist">force-persist</a>&quot;, &quot;<a href="#retries">retries</a>&quot;</div>
 <a class="anchor" name="option"></a><a class="anchor" name="4-option"></a><a class="anchor" name="4.2-option"></a><a class="anchor" name="option (Proxies)"></a><a class="anchor" name="option (Alphabetically sorted keywords reference)"></a><a class="anchor" name="option redis-check"></a><a class="anchor" name="4-option redis-check"></a><a class="anchor" name="4.2-option redis-check"></a><a class="anchor" name="option redis-check (Proxies)"></a><a class="anchor" name="option redis-check (Alphabetically sorted keywords reference)"></a><div class="keyword"><b><a class="anchor" name="option redis-check"></a><a href="#4.2-option%20redis-check">option redis-check</a></b></div><pre class="text">Use redis health checks for server testing
 </pre><div><p>  May be used in sections  :</p><table class="table table-bordered" border="0" cellspacing="0" cellpadding="0">
 <thead><tr><th>defaults</th><th>frontend</th><th>listen</th><th>backend</th></tr></thead>
@@ -17970,8 +17980,8 @@ <h2 id="chapter-4.2" data-target="4.2"><small><a class="small" href="#4.2">4.2.<
 <span class="comment"># and reject everything else. (works for HTTP/1 and HTTP/2 connections)</span>
 acl is_host_com hdr(Host) -i example.com
 tcp-request inspect-delay 5s
-tcp-request switch-mode http if HTTP
-tcp-request reject   <span class="comment"># non-HTTP traffic is implicit here</span>
+tcp-request content switch-mode http if HTTP
+tcp-request content reject   <span class="comment"># non-HTTP traffic is implicit here</span>
 ...
 http-request reject unless is_host_com
 </code></pre>
@@ -27884,7 +27894,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 2.8.14-5 &ndash; Configuration Manual<br>
+							HAProxy 2.8.14-80 &ndash; Configuration Manual<br>
 							<small>, 2025/01/29</small>
 						</div>
 					</div>
diff --git a/docs/2.8/intro.html b/docs/2.8/intro.html
@@ -2,7 +2,7 @@
 <html lang="en">
 	<head>
 		<meta charset="utf-8" />
-		<title>HAProxy version 2.8.14-5 - Starter Guide</title>
+		<title>HAProxy version 2.8.14-80 - 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" />
@@ -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>2025/01/29</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>2025/04/16</b></small>
 				</p>
 			</div>
 			<!-- /.sidebar -->
@@ -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 2.8.14-5</strong></p>
+							<p><strong>version 2.8.14-80</strong></p>
 							<p>
 								<br>
 								
@@ -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 2.8.14-5 &ndash; Starter Guide<br>
+							HAProxy 2.8.14-80 &ndash; Starter Guide<br>
 							<small>, </small>
 						</div>
 					</div>
diff --git a/docs/2.8/management.html b/docs/2.8/management.html
