diff options
Diffstat (limited to '')
| -rw-r--r-- | docs/manual/mod/mod_reqtimeout.html.en | 91 |
1 files changed, 55 insertions, 36 deletions
diff --git a/docs/manual/mod/mod_reqtimeout.html.en b/docs/manual/mod/mod_reqtimeout.html.en index 459c704..686b88d 100644 --- a/docs/manual/mod/mod_reqtimeout.html.en +++ b/docs/manual/mod/mod_reqtimeout.html.en @@ -1,7 +1,7 @@ -<?xml version="1.0" encoding="ISO-8859-1"?> +<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head> -<meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type" /> +<meta content="text/html; charset=UTF-8" http-equiv="Content-Type" /> <!-- XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX This file is generated from xml source: DO NOT EDIT @@ -27,14 +27,27 @@ <div id="preamble"><h1>Apache Module mod_reqtimeout</h1> <div class="toplang"> <p><span>Available Languages: </span><a href="../en/mod/mod_reqtimeout.html" title="English"> en </a> | -<a href="../fr/mod/mod_reqtimeout.html" hreflang="fr" rel="alternate" title="Français"> fr </a></p> +<a href="../fr/mod/mod_reqtimeout.html" hreflang="fr" rel="alternate" title="Français"> fr </a></p> </div> <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Set timeout and minimum data rate for receiving requests </td></tr> <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr> -<tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>reqtimeout_module</td></tr> -<tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_reqtimeout.c</td></tr> +<tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>reqtimeout_module</td></tr> +<tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_reqtimeout.c</td></tr> <tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache HTTPD 2.2.15 and later</td></tr></table> +<h3>Summary</h3> + + <p>This module provides a convenient way to set timeouts and minimum data + rates for receiving requests. Should a timeout occur or a data rate be + to low, the corresponding connection will be closed by the server.</p> + + <p>This is logged at <code class="directive"><a href="../mod/core.html#loglevel">LogLevel</a></code> + <code>info</code>.</p> + + <p>If needed, the <code class="directive"><a href="../mod/core.html#loglevel">LogLevel</a></code> directive + can be tweaked to explicitly log it:</p> + <pre class="prettyprint lang-config">LogLevel reqtimeout:info</pre> + </div> <div id="quickview"><a href="https://www.apache.org/foundation/contributing.html" class="badge"><img src="https://www.apache.org/images/SupportApache-small.png" alt="Support Apache!" /></a><h3>Topics</h3> <ul id="topics"> @@ -52,10 +65,11 @@ <ol> <li> - Allow 10 seconds to receive the request including the headers and - 30 seconds for receiving the request body: + Allow for 5 seconds to complete the TLS handshake, 10 seconds to + receive the request headers and 30 seconds for receiving the + request body: - <pre class="prettyprint lang-config">RequestReadTimeout header=10 body=30</pre> + <pre class="prettyprint lang-config">RequestReadTimeout handshake=5 header=10 body=30</pre> </li> @@ -71,10 +85,10 @@ </li> <li> - Allow at least 10 seconds to receive the request including the headers. + Allow at least 10 seconds to receive the request headers. If the client sends data, increase the timeout by 1 second for every 500 bytes received. But do not allow more than 30 seconds for the - request including the headers: + request headers: <pre class="prettyprint lang-config">RequestReadTimeout header=10-30,MinRate=500</pre> @@ -94,65 +108,70 @@ <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> <div class="directive-section"><h2><a name="RequestReadTimeout" id="RequestReadTimeout">RequestReadTimeout</a> <a name="requestreadtimeout" id="requestreadtimeout">Directive</a></h2> <table class="directive"> -<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Set timeout values for receiving request headers and body from client. +<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Set timeout values for completing the TLS handshake, receiving +the request headers and/or body from client. </td></tr> <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>RequestReadTimeout +[handshake=<var>timeout</var>[-<var>maxtimeout</var>][,MinRate=<var>rate</var>] [header=<var>timeout</var>[-<var>maxtimeout</var>][,MinRate=<var>rate</var>] [body=<var>timeout</var>[-<var>maxtimeout</var>][,MinRate=<var>rate</var>] </code></td></tr> -<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>header=20-40,MinRate=500 body=20,MinRate=500</code></td></tr> +<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>RequestReadTimeout handshake=0 header=20-40,MinRate=500 body=20,MinRate=500</code></td></tr> <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr> <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr> <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_reqtimeout</td></tr> <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in version 2.2.15 and later; defaulted to disabled in -version 2.3.14 and earlier.</td></tr> +version 2.3.14 and earlier. The <code>handshake</code> stage is available since +version 2.4.39. +</td></tr> </table> - <p>This directive can set various timeouts for receiving the request headers - and the request body from the client. If the client fails to send headers or - body within the configured time, a <code>408 REQUEST TIME OUT</code> error - is sent.</p> + <p>This directive can set various timeouts for completing the TLS handshake, + receiving the request headers and/or the request body from the client. + If the client fails to complete each of these stages within the configured + time, a <code>408 REQUEST TIME OUT</code> error is sent.</p> - <p>For SSL virtual hosts, the header timeout values include the time needed - to do the initial SSL handshake. If the user's browser is configured to + <p>For SSL virtual hosts, the <code>handshake</code> timeout values is the time + needed to do the initial SSL handshake. If the user's browser is configured to query certificate revocation lists and the CRL server is not reachable, the initial SSL handshake may take a significant time until the browser gives up - waiting for the CRL. Therefore the header timeout values should not be set - to very low values for SSL virtual hosts. + waiting for the CRL. Therefore the <code>handshake</code> timeout should take + this possible overhead into consideration for SSL virtual hosts (if necessary). The body timeout values include the time needed for SSL renegotiation (if necessary).</p> <p>When an <code class="directive"><a href="../mod/core.html#acceptfilter">AcceptFilter</a></code> is in use (usually the case on Linux and FreeBSD), the socket is not sent to the server process before at least one byte (or the whole request for - <code>httpready</code>) is received. The header timeout configured with - <code class="directive">RequestReadTimeout</code> is only effective after the server process has - received the socket.</p> + <code>httpready</code>) is received. The handshake and header timeouts + configured with <code class="directive">RequestReadTimeout</code> are only effective + after the server process has received the socket.</p> - <p>For each of the two timeout types (header or body), there are three ways - to specify the timeout: + <p>For each of the three timeout stages (handshake, header or body), there are + three ways to specify the timeout: </p> <ul> <li><strong>Fixed timeout value</strong>:<br /> - <div class="example"><p><code><var>type</var>=<var>timeout</var></code></p></div> + <div class="example"><p><code><var>stage</var>=<var>timeout</var></code></p></div> - <p>The time in seconds allowed for reading all of the request headers or - body, respectively. A value of 0 means no limit.</p> + <p>The time in seconds allowed for completing the whole stage (handshaking, + reading all of the request headers or body). A value of 0 means no limit.</p> </li> <li><strong>Disable module for a vhost</strong>:<br /> - <div class="example"><p><code>header=0 body=0</code></p></div> + <div class="example"><p><code>handshake=0 header=0 body=0</code></p></div> - <p>This disables <code class="module"><a href="../mod/mod_reqtimeout.html">mod_reqtimeout</a></code> completely.</p> + <p>This disables <code class="module"><a href="../mod/mod_reqtimeout.html">mod_reqtimeout</a></code> completely (note that + <code>handshake=0</code> is the default already and could be omitted).</p> </li> <li><strong>Timeout value that is increased when data is received</strong>:<br /> <div class="example"><p><code> - <var>type</var>=<var>timeout</var>,MinRate=<var>data_rate</var> + <var>stage</var>=<var>timeout</var>,MinRate=<var>data_rate</var> </code></p></div> <p>Same as above, but whenever data is received, the timeout value is @@ -163,7 +182,7 @@ version 2.3.14 and earlier.</td></tr> <li><strong>Timeout value that is increased when data is received, with an upper bound</strong>:<br /> <div class="example"><p><code> - <var>type</var>=<var>timeout</var>-<var>maxtimeout</var>,MinRate=<var>data_rate</var> + <var>stage</var>=<var>timeout</var>-<var>maxtimeout</var>,MinRate=<var>data_rate</var> </code></p></div> <p>Same as above, but the timeout will not be increased above the second @@ -177,8 +196,8 @@ version 2.3.14 and earlier.</td></tr> </div> <div class="bottomlang"> <p><span>Available Languages: </span><a href="../en/mod/mod_reqtimeout.html" title="English"> en </a> | -<a href="../fr/mod/mod_reqtimeout.html" hreflang="fr" rel="alternate" title="Français"> fr </a></p> -</div><div class="top"><a href="#page-header"><img src="../images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">Comments</a></h2><div class="warning"><strong>Notice:</strong><br />This is not a Q&A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed again by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Freenode, or sent to our <a href="http://httpd.apache.org/lists.html">mailing lists</a>.</div> +<a href="../fr/mod/mod_reqtimeout.html" hreflang="fr" rel="alternate" title="Français"> fr </a></p> +</div><div class="top"><a href="#page-header"><img src="../images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">Comments</a></h2><div class="warning"><strong>Notice:</strong><br />This is not a Q&A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Libera.chat, or sent to our <a href="https://httpd.apache.org/lists.html">mailing lists</a>.</div> <script type="text/javascript"><!--//--><![CDATA[//><!-- var comments_shortname = 'httpd'; var comments_identifier = 'http://httpd.apache.org/docs/2.4/mod/mod_reqtimeout.html'; @@ -196,7 +215,7 @@ var comments_identifier = 'http://httpd.apache.org/docs/2.4/mod/mod_reqtimeout.h } })(window, document); //--><!]]></script></div><div id="footer"> -<p class="apache">Copyright 2019 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p> +<p class="apache">Copyright 2024 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p> <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!-- if (typeof(prettyPrint) !== 'undefined') { prettyPrint(); |