github.com/krum110487/go-htaccess@v0.0.0-20240316004156-60641c8e7598/tests/data/apache_2_2_34/manual/mod/mod_reqtimeout.html.en (about)

     1  <?xml version="1.0" encoding="ISO-8859-1"?>
     2  <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
     3  <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
     4  <meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type" />
     5  <!--
     6          XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
     7                This file is generated from xml source: DO NOT EDIT
     8          XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
     9        -->
    10  <title>mod_reqtimeout - Apache HTTP Server Version 2.2</title>
    11  <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
    12  <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
    13  <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" /><link rel="stylesheet" type="text/css" href="../style/css/prettify.css" />
    14  <script src="../style/scripts/prettify.min.js" type="text/javascript">
    15  </script>
    16  
    17  <link href="../images/favicon.ico" rel="shortcut icon" /><link href="http://httpd.apache.org/docs/current/mod/mod_reqtimeout.html" rel="canonical" /></head>
    18  <body>
    19  <div id="page-header">
    20  <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>
    21  <p class="apache">Apache HTTP Server Version 2.2</p>
    22  <img alt="" src="../images/feather.gif" /></div>
    23  <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
    24  <div id="path">
    25  <a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs/">Documentation</a> &gt; <a href="../">Version 2.2</a> &gt; <a href="./">Modules</a></div>
    26  <div id="page-content">
    27  <div class="retired"><h4>Please note</h4>
    28              <p> This document refers to a legacy release (<strong>2.2</strong>) of Apache httpd. The active release (<strong>2.4</strong>) is documented <a href="http://httpd.apache.org/docs/current">here</a>. If you have not already upgraded, please follow <a href="http://httpd.apache.org/docs/current/upgrading.html">this link</a> for more information.</p>
    29          <p>You may follow <a href="http://httpd.apache.org/docs/current/mod/mod_reqtimeout.html">this link</a> to go to the current version of this document.</p></div><div id="preamble"><h1>Apache Module mod_reqtimeout</h1>
    30  <div class="toplang">
    31  <p><span>Available Languages: </span><a href="../en/mod/mod_reqtimeout.html" title="English">&nbsp;en&nbsp;</a></p>
    32  </div>
    33  <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Set timeout and minimum data rate for receiving requests
    34  </td></tr>
    35  <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
    36  <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>reqtimeout_module</td></tr>
    37  <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_reqtimeout.c</td></tr>
    38  <tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.2.15 and later</td></tr></table>
    39  </div>
    40  <div id="quickview"><h3>Topics</h3>
    41  <ul id="topics">
    42  <li><img alt="" src="../images/down.gif" /> <a href="#examples">Examples</a></li>
    43  </ul><h3 class="directives">Directives</h3>
    44  <ul id="toc">
    45  <li><img alt="" src="../images/down.gif" /> <a href="#requestreadtimeout">RequestReadTimeout</a></li>
    46  </ul>
    47  <ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
    48  <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
    49  <div class="section">
    50  <h2><a name="examples" id="examples">Examples</a></h2>
    51  
    52      <ol>
    53        <li>
    54          Allow 10 seconds to receive the request including the headers and
    55          30 seconds for receiving the request body:
    56  
    57          <div class="example"><p><code>
    58            RequestReadTimeout header=10 body=30
    59          </code></p></div>
    60        </li>
    61  
    62        <li>
    63          Allow at least 10 seconds to receive the request body.
    64          If the client sends data, increase the timeout by 1 second for every
    65          1000 bytes received, with no upper limit for the timeout (exept for
    66          the limit given indirectly by
    67          <code class="directive"><a href="../mod/core.html#limitrequestbody">LimitRequestBody</a></code>):
    68  
    69          <div class="example"><p><code>
    70            RequestReadTimeout body=10,MinRate=1000
    71          </code></p></div>
    72        </li>
    73  
    74        <li>
    75          Allow at least 10 seconds to receive the request including the headers.
    76          If the client sends data, increase the timeout by 1 second for every
    77          500 bytes received. But do not allow more than 30 seconds for the
    78          request including the headers:
    79  
    80          <div class="example"><p><code>
    81            RequestReadTimeout header=10-30,MinRate=500
    82          </code></p></div>
    83        </li>
    84  
    85        <li>
    86          Usually, a server should have both header and body timeouts configured.
    87          If a common configuration is used for http and https virtual hosts, the
    88          timeouts should not be set too low:
    89  
    90          <div class="example"><p><code>
    91            RequestReadTimeout header=20-40,MinRate=500 body=20,MinRate=500
    92          </code></p></div>
    93        </li>
    94  
    95      </ol>
    96  </div>
    97  <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
    98  <div class="directive-section"><h2><a name="RequestReadTimeout" id="RequestReadTimeout">RequestReadTimeout</a> <a name="requestreadtimeout" id="requestreadtimeout">Directive</a></h2>
    99  <table class="directive">
   100  <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Set timeout values for receiving request headers and body from client.
   101  </td></tr>
   102  <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>RequestReadTimeout
   103  [header=<var>timeout</var>[[-<var>maxtimeout</var>],MinRate=<var>rate</var>]
   104  [body=<var>timeout</var>[[-<var>maxtimeout</var>],MinRate=<var>rate</var>]
   105  </code></td></tr>
   106  <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>Unset; no limit</code></td></tr>
   107  <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
   108  <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
   109  <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_reqtimeout</td></tr>
   110  </table>
   111      <p>This directive can set various timeouts for receiving the request headers
   112      and the request body from the client. If the client fails to send headers or
   113      body within the configured time, a <code>408 REQUEST TIME OUT</code> error
   114      is sent.</p>
   115  
   116      <p>For SSL virtual hosts, the header timeout values include the time needed
   117      to do the initial SSL handshake.  If the user's browser is configured to
   118      query certificate revocation lists and the CRL server is not reachable, the
   119      initial SSL handshake may take a significant time until the browser gives up
   120      waiting for the CRL.  Therefore the header timeout values should not be set
   121      to very low values for SSL virtual hosts.
   122      The body timeout values include the time needed for SSL renegotiation
   123      (if necessary).</p>
   124  
   125      <p>When an <code class="directive"><a href="../mod/core.html#acceptfilter">AcceptFilter</a></code> is in use
   126      (usually the case on Linux and FreeBSD), the socket is not sent to the
   127      server process before at least one byte (or the whole request for
   128      <code>httpready</code>) is received. The header timeout configured with
   129      <code>RequestReadTimeout</code> is only effective after the server process has
   130      received the socket.</p>
   131  
   132      <p>For each of the two timeout types (header or body), there are three ways
   133      to specify the timeout:
   134      </p>
   135  
   136      <ul>
   137  
   138      <li><strong>Fixed timeout value</strong>:<br />
   139  
   140      <div class="example"><p><code><var>type</var>=<var>timeout</var></code></p></div>
   141  
   142      <p>The time in seconds allowed for reading all of the request headers or
   143      body, respectively. A value of 0 means no limit.</p>
   144      </li>
   145  
   146      <li><strong>Timeout value that is increased when data is
   147      received</strong>:<br />
   148      <div class="example"><p><code>
   149      <var>type</var>=<var>timeout</var>,MinRate=<var>data_rate</var>
   150      </code></p></div>
   151  
   152      <p>Same as above, but whenever data is received, the timeout value is
   153      increased according to the specified minimum data rate (in bytes per
   154      second).</p>
   155      </li>
   156  
   157      <li><strong>Timeout value that is increased when data is received, with an
   158      upper bound</strong>:<br />
   159      <div class="example"><p><code>
   160      <var>type</var>=<var>timeout</var>-<var>maxtimeout</var>,MinRate=<var>data_rate</var>
   161      </code></p></div>
   162  
   163      <p>Same as above, but the timeout will not be increased above the second
   164      value of the specified timeout range.</p>
   165      </li>
   166  
   167      </ul>
   168  
   169  
   170  </div>
   171  </div>
   172  <div class="bottomlang">
   173  <p><span>Available Languages: </span><a href="../en/mod/mod_reqtimeout.html" title="English">&nbsp;en&nbsp;</a></p>
   174  </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&amp;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>
   175  <script type="text/javascript"><!--//--><![CDATA[//><!--
   176  var comments_shortname = 'httpd';
   177  var comments_identifier = 'http://httpd.apache.org/docs/2.2/mod/mod_reqtimeout.html';
   178  (function(w, d) {
   179      if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
   180          d.write('<div id="comments_thread"><\/div>');
   181          var s = d.createElement('script');
   182          s.type = 'text/javascript';
   183          s.async = true;
   184          s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
   185          (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
   186      }
   187      else { 
   188          d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
   189      }
   190  })(window, document);
   191  //--><!]]></script></div><div id="footer">
   192  <p class="apache">Copyright 2017 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>
   193  <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[//><!--
   194  if (typeof(prettyPrint) !== 'undefined') {
   195      prettyPrint();
   196  }
   197  //--><!]]></script>
   198  </body></html>