home *** CD-ROM | disk | FTP | other *** search
/ Chip 2004 November / CMCD1104.ISO / Software / Complet / Apache / apache_2.0.52-win32-x86-no_ssl.msi / Data.Cab / F278146_mpm_common.html.en < prev    next >
Extensible Markup Language  |  2004-03-15  |  67KB  |  876 lines

  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.         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
  5.               This file is generated from xml source: DO NOT EDIT
  6.         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
  7.       -->
  8. <title>mpm_common - Apache HTTP Server</title>
  9. <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
  10. <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
  11. <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
  12. <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  13. <body>
  14. <div id="page-header">
  15. <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
  16. <p class="apache">Apache HTTP Server Version 2.0</p>
  17. <img alt="" src="../images/feather.gif" /></div>
  18. <div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div>
  19. <div id="path">
  20. <a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs-project/">Documentation</a> > <a href="../">Version 2.0</a> > <a href="./">Modules</a></div>
  21. <div id="page-content">
  22. <div id="preamble"><h1>Apache MPM Common Directives</h1>
  23. <div class="toplang">
  24. <p><span>Available Languages: </span><a href="../de/mod/mpm_common.html" hreflang="de" rel="alternate" title="Deutsch"> de </a> |
  25. <a href="../en/mod/mpm_common.html" title="English"> en </a> |
  26. <a href="../ja/mod/mpm_common.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a></p>
  27. </div>
  28. <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>A collection of directives that are implemented by
  29. more than one multi-processing module (MPM)</td></tr>
  30. <tr><th><a href="module-dict.html#Status">Status:</a></th><td>MPM</td></tr></table>
  31. </div>
  32. <div id="quickview"><h3 class="directives">Directives</h3>
  33. <ul id="toc">
  34. <li><img alt="" src="../images/down.gif" /> <a href="#acceptmutex">AcceptMutex</a></li>
  35. <li><img alt="" src="../images/down.gif" /> <a href="#bs2000account">BS2000Account</a></li>
  36. <li><img alt="" src="../images/down.gif" /> <a href="#coredumpdirectory">CoreDumpDirectory</a></li>
  37. <li><img alt="" src="../images/down.gif" /> <a href="#enableexceptionhook">EnableExceptionHook</a></li>
  38. <li><img alt="" src="../images/down.gif" /> <a href="#group">Group</a></li>
  39. <li><img alt="" src="../images/down.gif" /> <a href="#listen">Listen</a></li>
  40. <li><img alt="" src="../images/down.gif" /> <a href="#listenbacklog">ListenBackLog</a></li>
  41. <li><img alt="" src="../images/down.gif" /> <a href="#lockfile">LockFile</a></li>
  42. <li><img alt="" src="../images/down.gif" /> <a href="#maxclients">MaxClients</a></li>
  43. <li><img alt="" src="../images/down.gif" /> <a href="#maxmemfree">MaxMemFree</a></li>
  44. <li><img alt="" src="../images/down.gif" /> <a href="#maxrequestsperchild">MaxRequestsPerChild</a></li>
  45. <li><img alt="" src="../images/down.gif" /> <a href="#maxsparethreads">MaxSpareThreads</a></li>
  46. <li><img alt="" src="../images/down.gif" /> <a href="#minsparethreads">MinSpareThreads</a></li>
  47. <li><img alt="" src="../images/down.gif" /> <a href="#pidfile">PidFile</a></li>
  48. <li><img alt="" src="../images/down.gif" /> <a href="#scoreboardfile">ScoreBoardFile</a></li>
  49. <li><img alt="" src="../images/down.gif" /> <a href="#sendbuffersize">SendBufferSize</a></li>
  50. <li><img alt="" src="../images/down.gif" /> <a href="#serverlimit">ServerLimit</a></li>
  51. <li><img alt="" src="../images/down.gif" /> <a href="#startservers">StartServers</a></li>
  52. <li><img alt="" src="../images/down.gif" /> <a href="#startthreads">StartThreads</a></li>
  53. <li><img alt="" src="../images/down.gif" /> <a href="#threadlimit">ThreadLimit</a></li>
  54. <li><img alt="" src="../images/down.gif" /> <a href="#threadsperchild">ThreadsPerChild</a></li>
  55. <li><img alt="" src="../images/down.gif" /> <a href="#user">User</a></li>
  56. </ul>
  57. </div>
  58.  
  59. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  60. <div class="directive-section"><h2><a name="AcceptMutex" id="AcceptMutex">AcceptMutex</a> <a name="acceptmutex" id="acceptmutex">Directive</a></h2>
  61. <table class="directive">
  62. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Method that Apache uses to serialize multiple children
  63. accepting requests on network sockets</td></tr>
  64. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AcceptMutex Default|<var>method</var></code></td></tr>
  65. <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AcceptMutex Default</code></td></tr>
  66. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
  67. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>MPM</td></tr>
  68. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td><code class="module"><a href="../mod/leader.html">leader</a></code>, <code class="module"><a href="../mod/perchild.html">perchild</a></code>, <code class="module"><a href="../mod/prefork.html">prefork</a></code>, <code class="module"><a href="../mod/threadpool.html">threadpool</a></code>, <code class="module"><a href="../mod/worker.html">worker</a></code></td></tr>
  69. </table>
  70.     <p>The <code class="directive">AcceptMutex</code> directives sets the
  71.     method that Apache uses to serialize multiple children accepting
  72.     requests on network sockets. Prior to Apache 2.0, the method was
  73.     selectable only at compile time. The optimal method to use is
  74.     highly architecture and platform dependent. For further details,
  75.     see the <a href="../misc/perf-tuning.html">performance tuning</a>
  76.     documentation.</p>
  77.  
  78.     <p>If this directive is set to <code>Default</code>, then the
  79.     compile-time selected default will be used. Other possible
  80.     methods are listed below. Note that not all methods are
  81.     available on all platforms. If a method is specified which is
  82.     not available, a message will be written to the error log
  83.     listing the available methods.</p>
  84.  
  85.     <dl>
  86.       <dt><code>flock</code></dt>
  87.       <dd>uses the <code>flock(2)</code> system call to lock the
  88.       file defined by the <code class="directive"><a href="#lockfile">LockFile</a></code> directive.</dd>
  89.  
  90.       <dt><code>fcntl</code></dt>
  91.       <dd>uses the <code>fcntl(2)</code> system call to lock the
  92.       file defined by the <code class="directive"><a href="#lockfile">LockFile</a></code> directive.</dd>
  93.  
  94.       <dt><code>posixsem</code></dt>
  95.       <dd>uses POSIX compatible semaphores to implement the mutex.</dd>
  96.  
  97.       <dt><code>pthread</code></dt>
  98.       <dd>uses POSIX mutexes as implemented by the POSIX Threads
  99.       (PThreads) specification.</dd>
  100.  
  101.       <dt><code>sysvsem</code></dt>
  102.       <dd>uses SySV-style semaphores to implement the mutex.</dd>
  103.     </dl>
  104.  
  105.     <p>If you want to find out the compile time chosen default
  106.     for your system, you may set your <code class="directive"><a href="../mod/core.html#loglevel">LogLevel</a></code> to <code>debug</code>. Then the default <code class="directive">AcceptMutex</code> will be written into the <code class="directive"><a href="../mod/core.html#errorlog">ErrorLog</a></code>.</p>
  107.  
  108. </div>
  109. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  110. <div class="directive-section"><h2><a name="BS2000Account" id="BS2000Account">BS2000Account</a> <a name="bs2000account" id="bs2000account">Directive</a></h2>
  111. <table class="directive">
  112. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Define the non-privileged account on BS2000
  113. machines</td></tr>
  114. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>BS2000Account <var>account</var></code></td></tr>
  115. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
  116. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>MPM</td></tr>
  117. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td><code class="module"><a href="../mod/perchild.html">perchild</a></code>, <code class="module"><a href="../mod/prefork.html">prefork</a></code></td></tr>
  118. <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Only available for BS2000 machines</td></tr>
  119. </table>
  120.     <p>The <code class="directive">BS2000Account</code> directive is available for
  121.     BS2000 hosts only. It must be used to define the account number for
  122.     the non-privileged apache server user (which was configured using the
  123.     <code class="directive"><a href="#user">User</a></code> directive). This is
  124.     required by the BS2000 POSIX subsystem (to change the underlying BS2000
  125.     task environment by performing a sub-LOGON) to prevent CGI scripts
  126.     from accessing resources of the privileged account which started the
  127.     server, usually <code>SYSROOT</code>.</p>
  128.  
  129.     <div class="note"><h3>Note</h3>
  130.       <p>Only one <code>BS2000Account</code> directive can be used.</p>
  131.     </div>
  132.  
  133. <h3>See also</h3>
  134. <ul>
  135. <li><a href="../platform/ebcdic.html">Apache EBCDIC port</a></li>
  136. </ul>
  137. </div>
  138. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  139. <div class="directive-section"><h2><a name="CoreDumpDirectory" id="CoreDumpDirectory">CoreDumpDirectory</a> <a name="coredumpdirectory" id="coredumpdirectory">Directive</a></h2>
  140. <table class="directive">
  141. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Directory where Apache attempts to
  142. switch before dumping core</td></tr>
  143. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CoreDumpDirectory <var>directory</var></code></td></tr>
  144. <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>See usage for the default setting</code></td></tr>
  145. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
  146. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>MPM</td></tr>
  147. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td><code class="module"><a href="../mod/beos.html">beos</a></code>, <code class="module"><a href="../mod/leader.html">leader</a></code>, <code class="module"><a href="../mod/mpm_winnt.html">mpm_winnt</a></code>, <code class="module"><a href="../mod/perchild.html">perchild</a></code>, <code class="module"><a href="../mod/prefork.html">prefork</a></code>, <code class="module"><a href="../mod/threadpool.html">threadpool</a></code>, <code class="module"><a href="../mod/worker.html">worker</a></code></td></tr>
  148. </table>
  149.     <p>This controls the directory to which Apache attempts to
  150.     switch before dumping core. The default is in the
  151.     <code class="directive"><a href="../mod/core.html#serverroot">ServerRoot</a></code> directory, however
  152.     since this should not be writable by the user the server runs
  153.     as, core dumps won't normally get written. If you want a core
  154.     dump for debugging, you can use this directive to place it in a
  155.     different location.</p>
  156.  
  157.     <div class="note"><h3>Core Dumps on Linux</h3>
  158.       <p>If Apache starts as root and switches to another user, the
  159.       Linux kernel <em>disables</em> core dumps even if the directory is
  160.       writable for the process. Apache (2.0.46 and later) reenables core dumps
  161.       on Linux 2.4 and beyond, but only if you explicitly configure a <code class="directive">CoreDumpDirectory</code>.</p>
  162.     </div>
  163.  
  164. </div>
  165. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  166. <div class="directive-section"><h2><a name="EnableExceptionHook" id="EnableExceptionHook">EnableExceptionHook</a> <a name="enableexceptionhook" id="enableexceptionhook">Directive</a></h2>
  167. <table class="directive">
  168. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enables a hook that runs exception handlers
  169. after a crash</td></tr>
  170. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>EnableExceptionHook On|Off</code></td></tr>
  171. <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>EnableExceptionHook Off</code></td></tr>
  172. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
  173. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>MPM</td></tr>
  174. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td><code class="module"><a href="../mod/leader.html">leader</a></code>, <code class="module"><a href="../mod/perchild.html">perchild</a></code>, <code class="module"><a href="../mod/prefork.html">prefork</a></code>, <code class="module"><a href="../mod/threadpool.html">threadpool</a></code>, <code class="module"><a href="../mod/worker.html">worker</a></code></td></tr>
  175. <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in version 2.0.49 and later</td></tr>
  176. </table>
  177.     <p>For safety reasons this directive is only available if the server was
  178.     configured with the <code>--enable-exception-hook</code> option. It
  179.     enables a hook that allows external modules to plug in and do something
  180.     after a child crashed.</p>
  181.     
  182.     <p>There are already two modules, <code>mod_whatkilledus</code> and
  183.     <code>mod_backtrace</code> that make use of this hook. Please have a
  184.     look at Jeff Trawick's <a href="http://www.apache.org/~trawick/exception_hook.html">EnableExceptionHook site</a> for more information about these.</p>
  185.  
  186. </div>
  187. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  188. <div class="directive-section"><h2><a name="Group" id="Group">Group</a> <a name="group" id="group">Directive</a></h2>
  189. <table class="directive">
  190. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Group under which the server will answer
  191. requests</td></tr>
  192. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Group <var>unix-group</var></code></td></tr>
  193. <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>Group #-1</code></td></tr>
  194. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
  195. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>MPM</td></tr>
  196. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td><code class="module"><a href="../mod/beos.html">beos</a></code>, <code class="module"><a href="../mod/leader.html">leader</a></code>, <code class="module"><a href="../mod/mpmt_os2.html">mpmt_os2</a></code>, <code class="module"><a href="../mod/perchild.html">perchild</a></code>, <code class="module"><a href="../mod/prefork.html">prefork</a></code>, <code class="module"><a href="../mod/threadpool.html">threadpool</a></code>, <code class="module"><a href="../mod/worker.html">worker</a></code></td></tr>
  197. <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Only valid in global server config since Apache
  198. 2.0</td></tr>
  199. </table>
  200.     <p>The <code class="directive">Group</code> directive sets the group under
  201.     which the server will answer requests. In order to use this
  202.     directive, the server must be run initially as <code>root</code>. If
  203.     you start the server as a non-root user, it will fail to change to the
  204.     specified group, and will instead continue to run as the group of the
  205.     original user. <var>Unix-group</var> is one of:</p>
  206.  
  207.     <dl>
  208.       <dt>A group name</dt>
  209.       <dd>Refers to the given group by name.</dd>
  210.  
  211.       <dt><code>#</code> followed by a group number.</dt>
  212.       <dd>Refers to a group by its number.</dd>
  213.     </dl>
  214.  
  215.     <div class="example"><h3>Example</h3><p><code>
  216.       Group www-group
  217.     </code></p></div>
  218.  
  219.     <p>It is recommended that you set up a new group specifically for
  220.     running the server. Some admins use user <code>nobody</code>,
  221.     but this is not always possible or desirable.</p>
  222.  
  223.     <div class="warning"><h3>Security</h3>
  224.       <p>Don't set <code class="directive">Group</code> (or <code class="directive"><a href="#user">User</a></code>) to <code>root</code> unless
  225.       you know exactly what you are doing, and what the dangers are.</p>
  226.     </div>
  227.  
  228.     <p>Special note: Use of this directive in <code class="directive"><a href="../mod/core.html#virtualhost"><VirtualHost></a></code> is no longer supported. To
  229.     configure your server for <a href="mod_suexec.html">suexec</a> use
  230.     <code class="directive"><a href="../mod/mod_suexec.html#suexecusergroup">SuexecUserGroup</a></code>.</p>
  231.  
  232.     <div class="note"><h3>Note</h3>
  233.       <p>Although the <code class="directive">Group</code> directive is present
  234.       in the <code class="module"><a href="../mod/beos.html">beos</a></code> and <code class="module"><a href="../mod/mpmt_os2.html">mpmt_os2</a></code> MPMs,
  235.       it is actually a no-op there and only exists for compatibility
  236.       reasons.</p>
  237.     </div>
  238.  
  239. </div>
  240. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  241. <div class="directive-section"><h2><a name="Listen" id="Listen">Listen</a> <a name="listen" id="listen">Directive</a></h2>
  242. <table class="directive">
  243. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>IP addresses and ports that the server
  244. listens to</td></tr>
  245. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Listen [<var>IP-address</var>:]<var>portnumber</var></code></td></tr>
  246. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
  247. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>MPM</td></tr>
  248. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td><code class="module"><a href="../mod/beos.html">beos</a></code>, <code class="module"><a href="../mod/leader.html">leader</a></code>, <code class="module"><a href="../mod/mpm_netware.html">mpm_netware</a></code>, <code class="module"><a href="../mod/mpm_winnt.html">mpm_winnt</a></code>, <code class="module"><a href="../mod/mpmt_os2.html">mpmt_os2</a></code>, <code class="module"><a href="../mod/perchild.html">perchild</a></code>, <code class="module"><a href="../mod/prefork.html">prefork</a></code>, <code class="module"><a href="../mod/threadpool.html">threadpool</a></code>, <code class="module"><a href="../mod/worker.html">worker</a></code></td></tr>
  249. <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Required directive since Apache 2.0</td></tr>
  250. </table>
  251.     <p>The <code class="directive">Listen</code> directive instructs Apache to
  252.     listen to only specific IP addresses or ports; by default it
  253.     responds to requests on all IP interfaces. <code class="directive">Listen</code>
  254.     is now a required directive. If it is not in the config file, the
  255.     server will fail to start. This is a change from previous versions
  256.     of Apache.</p>
  257.  
  258.     <p>The <code class="directive">Listen</code> directive tells the server to
  259.     accept incoming requests on the specified port or address-and-port
  260.     combination. If only a port number is specified, the server listens to
  261.     the given port on all interfaces. If an IP address is given as well
  262.     as a port, the server will listen on the given port and
  263.     interface.</p>
  264.  
  265.     <p>Multiple <code class="directive">Listen</code> directives may be used to
  266.     specify a number of addresses and ports to listen to. The server will
  267.     respond to requests from any of the listed addresses and ports.</p>
  268.  
  269.     <p>For example, to make the server accept connections on both
  270.     port 80 and port 8000, use:</p>
  271.  
  272.     <div class="example"><p><code>
  273.       Listen 80<br />
  274.       Listen 8000
  275.     </code></p></div>
  276.  
  277.     <p>To make the server accept connections on two specified
  278.     interfaces and port numbers, use </p>
  279.  
  280.     <div class="example"><p><code>
  281.       Listen 192.170.2.1:80<br />
  282.       Listen 192.170.2.5:8000
  283.     </code></p></div>
  284.  
  285.     <p>IPv6 addresses must be surrounded in square brackets, as in the
  286.     following example:</p>
  287.  
  288.     <div class="example"><p><code>
  289.       Listen [fe80::a00:20ff:fea7:ccea]:80
  290.     </code></p></div>
  291.  
  292. <h3>See also</h3>
  293. <ul>
  294. <li><a href="../dns-caveats.html">DNS Issues</a></li>
  295. <li><a href="../bind.html">Setting which addresses and ports Apache
  296. uses</a></li>
  297. </ul>
  298. </div>
  299. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  300. <div class="directive-section"><h2><a name="ListenBackLog" id="ListenBackLog">ListenBackLog</a> <a name="listenbacklog" id="listenbacklog">Directive</a></h2>
  301. <table class="directive">
  302. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Maximum length of the queue of pending connections</td></tr>
  303. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ListenBacklog <var>backlog</var></code></td></tr>
  304. <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ListenBacklog 511</code></td></tr>
  305. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
  306. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>MPM</td></tr>
  307. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td><code class="module"><a href="../mod/beos.html">beos</a></code>, <code class="module"><a href="../mod/leader.html">leader</a></code>, <code class="module"><a href="../mod/mpm_netware.html">mpm_netware</a></code>, <code class="module"><a href="../mod/mpm_winnt.html">mpm_winnt</a></code>, <code class="module"><a href="../mod/mpmt_os2.html">mpmt_os2</a></code>, <code class="module"><a href="../mod/perchild.html">perchild</a></code>, <code class="module"><a href="../mod/prefork.html">prefork</a></code>, <code class="module"><a href="../mod/threadpool.html">threadpool</a></code>, <code class="module"><a href="../mod/worker.html">worker</a></code></td></tr>
  308. </table>
  309.     <p>The maximum length of the queue of pending connections.
  310.     Generally no tuning is needed or desired, however on some
  311.     systems it is desirable to increase this when under a TCP SYN
  312.     flood attack. See the backlog parameter to the
  313.     <code>listen(2)</code> system call.</p>
  314.  
  315.     <p>This will often be limited to a smaller number by the
  316.     operating system. This varies from OS to OS. Also note that
  317.     many OSes do not use exactly what is specified as the backlog,
  318.     but use a number based on (but normally larger than) what is
  319.     set.</p>
  320.  
  321. </div>
  322. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  323. <div class="directive-section"><h2><a name="LockFile" id="LockFile">LockFile</a> <a name="lockfile" id="lockfile">Directive</a></h2>
  324. <table class="directive">
  325. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Location of the accept serialization lock file</td></tr>
  326. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LockFile <var>filename</var></code></td></tr>
  327. <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LockFile logs/accept.lock</code></td></tr>
  328. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
  329. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>MPM</td></tr>
  330. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td><code class="module"><a href="../mod/leader.html">leader</a></code>, <code class="module"><a href="../mod/perchild.html">perchild</a></code>, <code class="module"><a href="../mod/prefork.html">prefork</a></code>, <code class="module"><a href="../mod/threadpool.html">threadpool</a></code>, <code class="module"><a href="../mod/worker.html">worker</a></code></td></tr>
  331. </table>
  332.     <p>The <code class="directive">LockFile</code> directive sets the path to
  333.     the lockfile used when Apache is used with an <code class="directive"><a href="#acceptmutex">AcceptMutex</a></code> value of either
  334.     <code>fcntl</code> or <code>flock</code>. This directive should
  335.     normally be left at its default value. The main reason for changing
  336.     it is if the <code>logs</code> directory is NFS mounted, since
  337.     <strong>the lockfile must be stored on a local disk</strong>. The PID
  338.     of the main server process is automatically appended to the
  339.     filename.</p>
  340.  
  341.     <div class="warning"><h3>Security</h3>
  342.       <p>It is best to <em>avoid</em> putting this file in a world writable
  343.       directory such as <code>/var/tmp</code> because someone could create
  344.       a denial of service attack and prevent the server from starting by
  345.       creating a lockfile with the same name as the one the server will try
  346.       to create.</p>
  347.     </div>
  348.  
  349. <h3>See also</h3>
  350. <ul>
  351. <li><code class="directive"><a href="#acceptmutex">AcceptMutex</a></code></li>
  352. </ul>
  353. </div>
  354. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  355. <div class="directive-section"><h2><a name="MaxClients" id="MaxClients">MaxClients</a> <a name="maxclients" id="maxclients">Directive</a></h2>
  356. <table class="directive">
  357. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Maximum number of child processes that will be created
  358. to serve requests</td></tr>
  359. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>MaxClients <var>number</var></code></td></tr>
  360. <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>See usage for details</code></td></tr>
  361. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
  362. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>MPM</td></tr>
  363. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td><code class="module"><a href="../mod/beos.html">beos</a></code>, <code class="module"><a href="../mod/leader.html">leader</a></code>, <code class="module"><a href="../mod/prefork.html">prefork</a></code>, <code class="module"><a href="../mod/threadpool.html">threadpool</a></code>, <code class="module"><a href="../mod/worker.html">worker</a></code></td></tr>
  364. </table>
  365.     <p>The <code class="directive">MaxClients</code> directive sets the limit
  366.     on the number of simultaneous requests that will be served.  Any
  367.     connection attempts over the <code class="directive">MaxClients</code>
  368.     limit will normally be queued, up to a number based on the
  369.     <code class="directive"><a href="#listenbacklog">ListenBacklog</a></code>
  370.     directive. Once a child process is freed at the end of a different
  371.     request, the connection will then be serviced.</p>
  372.  
  373.     <p>For non-threaded servers (<em>i.e.</em>, <code class="module"><a href="../mod/prefork.html">prefork</a></code>),
  374.     <code class="directive">MaxClients</code> translates into the maximum
  375.     number of child processes that will be launched to serve requests.
  376.     The default value is <code>256</code>; to increase it, you must also raise
  377.     <code class="directive"><a href="#serverlimit">ServerLimit</a></code>.</p>
  378.  
  379.     <p>For threaded and hybrid servers (<em>e.g.</em> <code class="module"><a href="../mod/beos.html">beos</a></code>
  380.     or <code class="module"><a href="../mod/worker.html">worker</a></code>) <code class="directive">MaxClients</code> restricts
  381.     the total number of threads that will be available to serve clients.
  382.     The default value for <code class="module"><a href="../mod/beos.html">beos</a></code> is <code>50</code>. For
  383.     hybrid MPMs the default value is <code>16</code> (<code class="directive"><a href="#serverlimit">ServerLimit</a></code>) multiplied by the value of
  384.     <code>25</code> (<code class="directive"><a href="#threadsperchild">ThreadsPerChild</a></code>). Therefore, to increase <code class="directive">MaxClients</code> to a value that requires more than 16 processes,
  385.     you must also raise <code class="directive"><a href="#serverlimit">ServerLimit</a></code>.</p>
  386.  
  387. </div>
  388. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  389. <div class="directive-section"><h2><a name="MaxMemFree" id="MaxMemFree">MaxMemFree</a> <a name="maxmemfree" id="maxmemfree">Directive</a></h2>
  390. <table class="directive">
  391. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Maximum amount of memory that the main allocator is allowed
  392. to hold without calling free()</td></tr>
  393. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>MaxMemFree <var>KBytes</var></code></td></tr>
  394. <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>MaxMemFree 0</code></td></tr>
  395. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
  396. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>MPM</td></tr>
  397. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td><code class="module"><a href="../mod/beos.html">beos</a></code>, <code class="module"><a href="../mod/leader.html">leader</a></code>, <code class="module"><a href="../mod/mpm_netware.html">mpm_netware</a></code>, <code class="module"><a href="../mod/prefork.html">prefork</a></code>, <code class="module"><a href="../mod/threadpool.html">threadpool</a></code>, <code class="module"><a href="../mod/worker.html">worker</a></code>, <code class="module"><a href="../mod/mpm_winnt.html">mpm_winnt</a></code></td></tr>
  398. </table>
  399.     <p>The <code class="directive">MaxMemFree</code> directive sets the
  400.     maximum number of free Kbytes that the main allocator is allowed
  401.     to hold without calling <code>free()</code>. When not set, or when set
  402.     to zero, the threshold will be set to unlimited.</p>
  403.  
  404. </div>
  405. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  406. <div class="directive-section"><h2><a name="MaxRequestsPerChild" id="MaxRequestsPerChild">MaxRequestsPerChild</a> <a name="maxrequestsperchild" id="maxrequestsperchild">Directive</a></h2>
  407. <table class="directive">
  408. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Limit on the number of requests that an individual child server
  409. will handle during its life</td></tr>
  410. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>MaxRequestsPerChild <var>number</var></code></td></tr>
  411. <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>MaxRequestsPerChild 10000</code></td></tr>
  412. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
  413. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>MPM</td></tr>
  414. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td><code class="module"><a href="../mod/leader.html">leader</a></code>, <code class="module"><a href="../mod/mpm_netware.html">mpm_netware</a></code>, <code class="module"><a href="../mod/mpm_winnt.html">mpm_winnt</a></code>, <code class="module"><a href="../mod/mpmt_os2.html">mpmt_os2</a></code>, <code class="module"><a href="../mod/perchild.html">perchild</a></code>, <code class="module"><a href="../mod/prefork.html">prefork</a></code>, <code class="module"><a href="../mod/threadpool.html">threadpool</a></code>, <code class="module"><a href="../mod/worker.html">worker</a></code></td></tr>
  415. </table>
  416.     <p>The <code class="directive">MaxRequestsPerChild</code> directive sets
  417.     the limit on the number of requests that an individual child
  418.     server process will handle. After
  419.     <code class="directive">MaxRequestsPerChild</code> requests, the child
  420.     process will die. If <code class="directive">MaxRequestsPerChild</code> is
  421.     <code>0</code>, then the process will never expire.</p>
  422.  
  423.     <div class="note"><h3>Different default values</h3>
  424.       <p>The default value for <code class="module"><a href="../mod/mpm_netware.html">mpm_netware</a></code> and
  425.       <code class="module"><a href="../mod/mpm_winnt.html">mpm_winnt</a></code> is <code>0</code>.</p>
  426.     </div>
  427.  
  428.     <p>Setting <code class="directive">MaxRequestsPerChild</code> to a
  429.     non-zero limit has two beneficial effects:</p>
  430.  
  431.     <ul>
  432.       <li>it limits the amount of memory that process can consume
  433.       by (accidental) memory leakage;</li>
  434.  
  435.       <li>by giving processes a finite lifetime, it helps reduce
  436.       the number of processes when the server load reduces.</li>
  437.     </ul>
  438.  
  439.     <div class="note"><h3>Note</h3>
  440.       <p>For <code class="directive"><a href="../mod/core.html#keepalive">KeepAlive</a></code> requests, only
  441.       the first request is counted towards this limit. In effect, it
  442.       changes the behavior to limit the number of <em>connections</em> per
  443.       child.</p>
  444.     </div>
  445.  
  446. </div>
  447. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  448. <div class="directive-section"><h2><a name="MaxSpareThreads" id="MaxSpareThreads">MaxSpareThreads</a> <a name="maxsparethreads" id="maxsparethreads">Directive</a></h2>
  449. <table class="directive">
  450. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Maximum number of idle threads</td></tr>
  451. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>MaxSpareThreads <var>number</var></code></td></tr>
  452. <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>See usage for details</code></td></tr>
  453. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
  454. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>MPM</td></tr>
  455. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td><code class="module"><a href="../mod/beos.html">beos</a></code>, <code class="module"><a href="../mod/leader.html">leader</a></code>, <code class="module"><a href="../mod/mpm_netware.html">mpm_netware</a></code>, <code class="module"><a href="../mod/mpmt_os2.html">mpmt_os2</a></code>, <code class="module"><a href="../mod/perchild.html">perchild</a></code>, <code class="module"><a href="../mod/threadpool.html">threadpool</a></code>, <code class="module"><a href="../mod/worker.html">worker</a></code></td></tr>
  456. </table>
  457.     <p>Maximum number of idle threads. Different MPMs deal with this
  458.     directive differently.</p>
  459.  
  460.     <p>For <code class="module"><a href="../mod/perchild.html">perchild</a></code> the default is
  461.     <code>MaxSpareThreads 10</code>. This MPM monitors the number of
  462.     idle threads on a per-child basis. If there are too many idle
  463.     threads in that child, the server will begin to kill threads
  464.     within that child.</p>
  465.  
  466.     <p>For <code class="module"><a href="../mod/worker.html">worker</a></code>, <code class="module"><a href="../mod/leader.html">leader</a></code> and <code class="module"><a href="../mod/threadpool.html">threadpool</a></code> the default is <code>MaxSpareThreads 250</code>.
  467.     These MPMs deal with idle threads on a server-wide basis. If there
  468.     are too many idle threads in the server then child processes are
  469.     killed until the number of idle threads is less than this number.</p>
  470.  
  471.     <p>For <code class="module"><a href="../mod/mpm_netware.html">mpm_netware</a></code> the default is
  472.     <code>MaxSpareThreads 100</code>. Since this MPM runs a
  473.     single-process, the spare thread count is also server-wide.</p>
  474.  
  475.     <p><code class="module"><a href="../mod/beos.html">beos</a></code> and <code class="module"><a href="../mod/mpmt_os2.html">mpmt_os2</a></code> work
  476.     similar to <code class="module"><a href="../mod/mpm_netware.html">mpm_netware</a></code>. The default for
  477.     <code class="module"><a href="../mod/beos.html">beos</a></code> is <code>MaxSpareThreads 50</code>. For
  478.     <code class="module"><a href="../mod/mpmt_os2.html">mpmt_os2</a></code> the default value is <code>10</code>.</p>
  479.  
  480.     <div class="note"><h3>Restrictions</h3>
  481.       <p>The range of the <code class="directive">MaxSpareThreads</code> value
  482.       is restricted. Apache will correct the given value automatically
  483.       according to the following rules:</p>
  484.       <ul>
  485.         <li><code class="module"><a href="../mod/perchild.html">perchild</a></code> requires <code class="directive">MaxSpareThreads</code> to be less or equal than <code class="directive"><a href="#threadlimit">ThreadLimit</a></code>.</li>
  486.  
  487.         <li><code class="module"><a href="../mod/mpm_netware.html">mpm_netware</a></code> wants the value to be greater than
  488.         <code class="directive"><a href="#minsparethreads">MinSpareThreads</a></code>.</li>
  489.  
  490.         <li>For <code class="module"><a href="../mod/leader.html">leader</a></code>, <code class="module"><a href="../mod/threadpool.html">threadpool</a></code> and
  491.         <code class="module"><a href="../mod/worker.html">worker</a></code> the value must be greater or equal than
  492.         the sum of <code class="directive"><a href="#minsparethreads">MinSpareThreads</a></code>
  493.         and <code class="directive"><a href="#threadsperchild">ThreadsPerChild</a></code>.</li>
  494.       </ul>
  495.     </div>
  496.  
  497. <h3>See also</h3>
  498. <ul>
  499. <li><code class="directive"><a href="#minsparethreads">MinSpareThreads</a></code></li>
  500. <li><code class="directive"><a href="#startservers">StartServers</a></code></li>
  501. </ul>
  502. </div>
  503. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  504. <div class="directive-section"><h2><a name="MinSpareThreads" id="MinSpareThreads">MinSpareThreads</a> <a name="minsparethreads" id="minsparethreads">Directive</a></h2>
  505. <table class="directive">
  506. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Minimum number of idle threads available to handle request
  507. spikes</td></tr>
  508. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>MinSpareThreads <var>number</var></code></td></tr>
  509. <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>See usage for details</code></td></tr>
  510. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
  511. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>MPM</td></tr>
  512. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td><code class="module"><a href="../mod/beos.html">beos</a></code>, <code class="module"><a href="../mod/leader.html">leader</a></code>, <code class="module"><a href="../mod/mpm_netware.html">mpm_netware</a></code>, <code class="module"><a href="../mod/mpmt_os2.html">mpmt_os2</a></code>, <code class="module"><a href="../mod/perchild.html">perchild</a></code>, <code class="module"><a href="../mod/threadpool.html">threadpool</a></code>, <code class="module"><a href="../mod/worker.html">worker</a></code></td></tr>
  513. </table>
  514.     <p>Minimum number of idle threads to handle request spikes.
  515.     Different MPMs deal with this directive
  516.     differently.</p>
  517.  
  518.     <p><code class="module"><a href="../mod/perchild.html">perchild</a></code> uses a default of
  519.     <code>MinSpareThreads 5</code> and monitors the number of idle
  520.     threads on a per-child basis. If there aren't enough idle threads
  521.     in that child, the server will begin to create new threads within
  522.     that child. Thus, if you set <code class="directive"><a href="../mod/perchild.html#numservers">NumServers</a></code> to <code>10</code> and a <code class="directive">MinSpareThreads</code> value of <code>5</code>, you'll have
  523.     at least 50 idle threads on your system.</p>
  524.  
  525.     <p><code class="module"><a href="../mod/worker.html">worker</a></code>, <code class="module"><a href="../mod/leader.html">leader</a></code> and
  526.     <code class="module"><a href="../mod/threadpool.html">threadpool</a></code> use a default of <code>MinSpareThreads
  527.     75</code> and deal with idle threads on a server-wide basis. If
  528.     there aren't enough idle threads in the server then child
  529.     processes are created until the number of idle threads is greater
  530.     than number.</p>
  531.  
  532.     <p><code class="module"><a href="../mod/mpm_netware.html">mpm_netware</a></code> uses a default of
  533.     <code>MinSpareThreads 10</code> and, since it is a single-process
  534.     MPM, tracks this on a server-wide bases.</p>
  535.  
  536.     <p><code class="module"><a href="../mod/beos.html">beos</a></code> and <code class="module"><a href="../mod/mpmt_os2.html">mpmt_os2</a></code> work
  537.     similar to <code class="module"><a href="../mod/mpm_netware.html">mpm_netware</a></code>. The default for
  538.     <code class="module"><a href="../mod/beos.html">beos</a></code> is <code>MinSpareThreads 1</code>. For
  539.     <code class="module"><a href="../mod/mpmt_os2.html">mpmt_os2</a></code> the default value is <code>5</code>.</p>
  540.  
  541. <h3>See also</h3>
  542. <ul>
  543. <li><code class="directive"><a href="#maxsparethreads">MaxSpareThreads</a></code></li>
  544. <li><code class="directive"><a href="#startservers">StartServers</a></code></li>
  545. </ul>
  546. </div>
  547. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  548. <div class="directive-section"><h2><a name="PidFile" id="PidFile">PidFile</a> <a name="pidfile" id="pidfile">Directive</a></h2>
  549. <table class="directive">
  550. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>File where the server records the process ID
  551. of the daemon</td></tr>
  552. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>PidFile <var>filename</var></code></td></tr>
  553. <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>PidFile logs/httpd.pid</code></td></tr>
  554. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
  555. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>MPM</td></tr>
  556. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td><code class="module"><a href="../mod/beos.html">beos</a></code>, <code class="module"><a href="../mod/leader.html">leader</a></code>, <code class="module"><a href="../mod/mpm_winnt.html">mpm_winnt</a></code>, <code class="module"><a href="../mod/mpmt_os2.html">mpmt_os2</a></code>, <code class="module"><a href="../mod/perchild.html">perchild</a></code>, <code class="module"><a href="../mod/prefork.html">prefork</a></code>, <code class="module"><a href="../mod/threadpool.html">threadpool</a></code>, <code class="module"><a href="../mod/worker.html">worker</a></code></td></tr>
  557. </table>
  558.     <p>The <code class="directive">PidFile</code> directive sets the file to
  559.     which the server records the process id of the daemon. If the
  560.     filename is not absolute then it is assumed to be relative to the
  561.     <code class="directive"><a href="../mod/core.html#serverroot">ServerRoot</a></code>.</p>
  562.  
  563.     <div class="example"><h3>Example</h3><p><code>
  564.       PidFile /var/run/apache.pid
  565.     </code></p></div>
  566.  
  567.     <p>It is often useful to be able to send the server a signal,
  568.     so that it closes and then re-opens its <code class="directive"><a href="../mod/core.html#errorlog">ErrorLog</a></code> and <code class="directive"><a href="../mod/mod_log_config.html#transferlog">TransferLog</a></code>, and
  569.     re-reads its configuration files. This is done by sending a
  570.     SIGHUP (kill -1) signal to the process id listed in the
  571.     <code class="directive">PidFile</code>.</p>
  572.  
  573.     <p>The <code class="directive">PidFile</code> is subject to the same
  574.     warnings about log file placement and <a href="../misc/security_tips.html#serverroot">security</a>.</p>
  575.  
  576.     <div class="note"><h3>Note</h3>
  577.       <p>As of Apache 2 it is recommended to use only the <a href="../programs/apachectl.html">apachectl</a> script for
  578.       (re-)starting or stopping the server.</p>
  579.     </div>
  580.  
  581. </div>
  582. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  583. <div class="directive-section"><h2><a name="ScoreBoardFile" id="ScoreBoardFile">ScoreBoardFile</a> <a name="scoreboardfile" id="scoreboardfile">Directive</a></h2>
  584. <table class="directive">
  585. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Location of the file used to store coordination data for
  586. the child processes</td></tr>
  587. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ScoreBoardFile <var>file-path</var></code></td></tr>
  588. <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ScoreBoardFile logs/apache_status</code></td></tr>
  589. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
  590. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>MPM</td></tr>
  591. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td><code class="module"><a href="../mod/beos.html">beos</a></code>, <code class="module"><a href="../mod/leader.html">leader</a></code>, <code class="module"><a href="../mod/mpm_winnt.html">mpm_winnt</a></code>, <code class="module"><a href="../mod/perchild.html">perchild</a></code>, <code class="module"><a href="../mod/prefork.html">prefork</a></code>, <code class="module"><a href="../mod/threadpool.html">threadpool</a></code>, <code class="module"><a href="../mod/worker.html">worker</a></code></td></tr>
  592. </table>
  593.     <p>Apache uses a scoreboard to communicate between its parent
  594.     and child processes.  Some architectures require a file to facilitate
  595.     this communication. If the file is left unspecified, Apache first
  596.     attempts to create the scoreboard entirely in memory (using anonymous
  597.     shared memory) and, failing that, will attempt to create the file on
  598.     disk (using file-based shared memory). Specifying this directive causes
  599.     Apache to always create the file on the disk.</p>
  600.  
  601.     <div class="example"><h3>Example</h3><p><code>
  602.       ScoreBoardFile /var/run/apache_status
  603.     </code></p></div>
  604.  
  605.     <p>File-based shared memory is useful for third-party applications
  606.     that require direct access to the scoreboard.</p>
  607.  
  608.     <p>If you use a <code class="directive">ScoreBoardFile</code> then
  609.     you may see improved speed by placing it on a RAM disk. But be
  610.     careful that you heed the same warnings about log file placement
  611.     and <a href="../misc/security_tips.html">security</a>.</p>
  612.  
  613. <h3>See also</h3>
  614. <ul>
  615. <li><a href="../stopping.html">Stopping and Restarting
  616. Apache</a></li>
  617. </ul>
  618. </div>
  619. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  620. <div class="directive-section"><h2><a name="SendBufferSize" id="SendBufferSize">SendBufferSize</a> <a name="sendbuffersize" id="sendbuffersize">Directive</a></h2>
  621. <table class="directive">
  622. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>TCP buffer size</td></tr>
  623. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SendBufferSize <var>bytes</var></code></td></tr>
  624. <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SendBufferSize 0</code></td></tr>
  625. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
  626. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>MPM</td></tr>
  627. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td><code class="module"><a href="../mod/beos.html">beos</a></code>, <code class="module"><a href="../mod/leader.html">leader</a></code>, <code class="module"><a href="../mod/mpm_netware.html">mpm_netware</a></code>, <code class="module"><a href="../mod/mpm_winnt.html">mpm_winnt</a></code>, <code class="module"><a href="../mod/mpmt_os2.html">mpmt_os2</a></code>, <code class="module"><a href="../mod/perchild.html">perchild</a></code>, <code class="module"><a href="../mod/prefork.html">prefork</a></code>, <code class="module"><a href="../mod/threadpool.html">threadpool</a></code>, <code class="module"><a href="../mod/worker.html">worker</a></code></td></tr>
  628. </table>
  629.     <p>The server will set the TCP buffer size to the number of bytes
  630.     specified. Very useful to increase past standard OS defaults on
  631.     high speed high latency (<em>i.e.</em>, 100ms or so, such as
  632.     transcontinental fast pipes).</p>
  633.  
  634.     <p>If set to the value of <code>0</code>, the server will use the
  635.     OS deault.</p>
  636.  
  637. </div>
  638. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  639. <div class="directive-section"><h2><a name="ServerLimit" id="ServerLimit">ServerLimit</a> <a name="serverlimit" id="serverlimit">Directive</a></h2>
  640. <table class="directive">
  641. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Upper limit on configurable number of processes</td></tr>
  642. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ServerLimit <var>number</var></code></td></tr>
  643. <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>See usage for details</code></td></tr>
  644. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
  645. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>MPM</td></tr>
  646. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td><code class="module"><a href="../mod/leader.html">leader</a></code>, <code class="module"><a href="../mod/perchild.html">perchild</a></code>, <code class="module"><a href="../mod/prefork.html">prefork</a></code>, <code class="module"><a href="../mod/threadpool.html">threadpool</a></code>, <code class="module"><a href="../mod/worker.html">worker</a></code></td></tr>
  647. </table>
  648.     <p>For the <code class="module"><a href="../mod/prefork.html">prefork</a></code> MPM, this directive sets the
  649.     maximum configured value for <code class="directive"><a href="#maxclients">MaxClients</a></code> for the lifetime of the
  650.     Apache process.  For the <code class="module"><a href="../mod/worker.html">worker</a></code> MPM, this directive
  651.     in combination with <code class="directive"><a href="#threadlimit">ThreadLimit</a></code> sets
  652.     the maximum configured value for <code class="directive"><a href="#maxclients">MaxClients</a></code> for the lifetime of the
  653.     Apache process.  Any attempts to change this directive during a
  654.     restart will be ignored, but <code class="directive"><a href="#maxclients">MaxClients</a></code> can be modified during
  655.     a restart.</p>
  656.  
  657.     <p>Special care must be taken when using this directive.  If
  658.     <code class="directive">ServerLimit</code> is set to a value much higher
  659.     than necessary, extra, unused shared memory will be allocated.  If
  660.     both <code class="directive">ServerLimit</code> and <code class="directive"><a href="#maxclients">MaxClients</a></code> are set to values
  661.     higher than the system can handle, Apache may not start or the
  662.     system may become unstable.</p>
  663.  
  664.     <p>With the <code class="module"><a href="../mod/prefork.html">prefork</a></code> MPM, use this directive only
  665.     if you need to set <code class="directive"><a href="#maxclients">MaxClients</a></code> higher than 256 (default).
  666.     Do not set the value of this directive any higher than what you
  667.     might want to set <code class="directive"><a href="#maxclients">MaxClients</a></code> to.</p>
  668.  
  669.     <p>With <code class="module"><a href="../mod/worker.html">worker</a></code>, <code class="module"><a href="../mod/leader.html">leader</a></code> and
  670.     <code class="module"><a href="../mod/threadpool.html">threadpool</a></code> use this directive only
  671.     if your <code class="directive"><a href="#maxclients">MaxClients</a></code> and
  672.     <code class="directive"><a href="#threadsperchild">ThreadsPerChild</a></code>
  673.     settings require more than 16 server processes (default). Do not set
  674.     the value of this directive any higher than the number of server
  675.     processes required by what you may want for <code class="directive"><a href="#maxclients ">MaxClients </a></code> and <code class="directive"><a href="#threadsperchild">ThreadsPerChild</a></code>.</p>
  676.  
  677.     <p>With the <code class="module"><a href="../mod/perchild.html">perchild</a></code> MPM, use this directive only
  678.     if you need to set <code class="directive"><a href="../mod/perchild.html#numservers">NumServers</a></code> higher than 8 (default).</p>
  679.  
  680.     <div class="note"><h3>Note</h3>
  681.       <p>There is a hard limit of <code>ServerLimit 20000</code> compiled
  682.       into the server. This is intended to avoid nasty effects caused by
  683.       typos.</p>
  684.     </div>
  685.  
  686. <h3>See also</h3>
  687. <ul>
  688. <li><a href="../stopping.html">Stopping and Restarting Apache</a></li>
  689. </ul>
  690. </div>
  691. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  692. <div class="directive-section"><h2><a name="StartServers" id="StartServers">StartServers</a> <a name="startservers" id="startservers">Directive</a></h2>
  693. <table class="directive">
  694. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Number of child server processes created at startup</td></tr>
  695. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>StartServers <var>number</var></code></td></tr>
  696. <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>See usage for details</code></td></tr>
  697. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
  698. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>MPM</td></tr>
  699. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td><code class="module"><a href="../mod/leader.html">leader</a></code>, <code class="module"><a href="../mod/mpmt_os2.html">mpmt_os2</a></code>, <code class="module"><a href="../mod/prefork.html">prefork</a></code>, <code class="module"><a href="../mod/threadpool.html">threadpool</a></code>, <code class="module"><a href="../mod/worker.html">worker</a></code></td></tr>
  700. </table>
  701.     <p>The <code class="directive">StartServers</code> directive sets the
  702.     number of child server processes created on startup. As the number
  703.     of processes is dynamically controlled depending on the load,
  704.     there is usually little reason to adjust this parameter.</p>
  705.  
  706.     <p>The default value differs from MPM to MPM. For
  707.     <code class="module"><a href="../mod/leader.html">leader</a></code>, <code class="module"><a href="../mod/threadpool.html">threadpool</a></code> and
  708.     <code class="module"><a href="../mod/worker.html">worker</a></code> the default is <code>StartServers 3</code>.
  709.     For <code class="module"><a href="../mod/prefork.html">prefork</a></code> defaults to <code>5</code> and for
  710.     <code class="module"><a href="../mod/mpmt_os2.html">mpmt_os2</a></code> to <code>2</code>.</p>
  711.  
  712. </div>
  713. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  714. <div class="directive-section"><h2><a name="StartThreads" id="StartThreads">StartThreads</a> <a name="startthreads" id="startthreads">Directive</a></h2>
  715. <table class="directive">
  716. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Number of threads created on startup</td></tr>
  717. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>StartThreads <var>number</var></code></td></tr>
  718. <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>See usage for details</code></td></tr>
  719. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
  720. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>MPM</td></tr>
  721. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td><code class="module"><a href="../mod/beos.html">beos</a></code>, <code class="module"><a href="../mod/mpm_netware.html">mpm_netware</a></code>, <code class="module"><a href="../mod/perchild.html">perchild</a></code></td></tr>
  722. </table>
  723.     <p>Number of threads created on startup. As the
  724.     number of threads is dynamically controlled depending on the
  725.     load, there is usually little reason to adjust this
  726.     parameter.</p>
  727.  
  728.     <p>For <code class="module"><a href="../mod/perchild.html">perchild</a></code> the default is <code>StartThreads
  729.     5</code> and this directive tracks the number of threads per
  730.     process at startup.</p>
  731.  
  732.     <p>For <code class="module"><a href="../mod/mpm_netware.html">mpm_netware</a></code> the default is
  733.     <code>StartThreads 50</code> and, since there is only a single
  734.     process, this is the total number of threads created at startup to
  735.     serve requests.</p>
  736.  
  737.     <p>For <code class="module"><a href="../mod/beos.html">beos</a></code> the default is <code>StartThreads
  738.     10</code>. It also reflects the total number of threads created
  739.     at startup to serve requests.</p>
  740.  
  741. </div>
  742. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  743. <div class="directive-section"><h2><a name="ThreadLimit" id="ThreadLimit">ThreadLimit</a> <a name="threadlimit" id="threadlimit">Directive</a></h2>
  744. <table class="directive">
  745. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets the upper limit on the configurable number of threads
  746. per child process</td></tr>
  747. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ThreadLimit <var>number</var></code></td></tr>
  748. <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>See usage for details</code></td></tr>
  749. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
  750. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>MPM</td></tr>
  751. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td><code class="module"><a href="../mod/leader.html">leader</a></code>, <code class="module"><a href="../mod/mpm_winnt.html">mpm_winnt</a></code>, <code class="module"><a href="../mod/perchild.html">perchild</a></code>, <code class="module"><a href="../mod/threadpool.html">threadpool</a></code>, <code class="module"><a href="../mod/worker.html">worker</a></code></td></tr>
  752. <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available for <code class="module"><a href="../mod/mpm_winnt.html">mpm_winnt</a></code> in Apache 2.0.41
  753. and later</td></tr>
  754. </table>
  755.     <p>This directive sets the maximum configured value for <code class="directive"><a href="#threadsperchild">ThreadsPerChild</a></code> for the lifetime
  756.     of the Apache process.  Any attempts to change this directive
  757.     during a restart will be ignored, but <code class="directive"><a href="#threadsperchild">ThreadsPerChild</a></code> can be modified
  758.     during a restart up to the value of this directive.</p>
  759.  
  760.     <p>Special care must be taken when using this directive.  If
  761.     <code class="directive">ThreadLimit</code> is set to a value much higher
  762.     than <code class="directive"><a href="#threadsperchild">ThreadsPerChild</a></code>,
  763.     extra unused shared memory will be allocated.  If both
  764.     <code class="directive">ThreadLimit</code> and <code class="directive"><a href="#threadsperchild">ThreadsPerChild</a></code> are set to values
  765.     higher than the system can handle, Apache may not start or the
  766.     system may become unstable. Do not set the value of this directive
  767.     any higher than your greatest predicted setting of <code class="directive"><a href="#threadsperchild">ThreadsPerChild</a></code> for the
  768.     current run of Apache.</p>
  769.  
  770.     <p>The default value for <code class="directive">ThreadLimit</code> is
  771.     <code>1920</code> when used with <code class="module"><a href="../mod/mpm_winnt.html">mpm_winnt</a></code> and
  772.     <code>64</code> when used with the others.</p>
  773.  
  774.     <div class="note"><h3>Note</h3>
  775.       <p>There is a hard limit of <code>ThreadLimit 20000</code> (or
  776.       <code>ThreadLimit 15000</code> with <code class="module"><a href="../mod/mpm_winnt.html">mpm_winnt</a></code>)
  777.       compiled into the server. This is intended to avoid nasty effects
  778.       caused by typos.</p>
  779.     </div>
  780.  
  781. </div>
  782. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  783. <div class="directive-section"><h2><a name="ThreadsPerChild" id="ThreadsPerChild">ThreadsPerChild</a> <a name="threadsperchild" id="threadsperchild">Directive</a></h2>
  784. <table class="directive">
  785. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Number of threads created by each child process</td></tr>
  786. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ThreadsPerChild <var>number</var></code></td></tr>
  787. <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>See usage for details</code></td></tr>
  788. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
  789. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>MPM</td></tr>
  790. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td><code class="module"><a href="../mod/leader.html">leader</a></code>, <code class="module"><a href="../mod/mpm_winnt.html">mpm_winnt</a></code>, <code class="module"><a href="../mod/threadpool.html">threadpool</a></code>, <code class="module"><a href="../mod/worker.html">worker</a></code></td></tr>
  791. </table>
  792.     <p>This directive sets the number of threads created by each
  793.     child process. The child creates these threads at startup and
  794.     never creates more. If using an MPM like <code class="module"><a href="../mod/mpm_winnt.html">mpm_winnt</a></code>,
  795.     where there is only one child process, this number should be high
  796.     enough to handle the entire load of the server. If using an MPM
  797.     like <code class="module"><a href="../mod/worker.html">worker</a></code>, where there are multiple child processes,
  798.     the <em>total</em> number of threads should be high enough to handle
  799.     the common load on the server.</p>
  800.  
  801.     <p>The default value for <code class="directive">ThreadsPerChild</code> is
  802.     <code>64</code> when used with <code class="module"><a href="../mod/mpm_winnt.html">mpm_winnt</a></code> and
  803.     <code>25</code> when used with the others.</p>
  804.  
  805. </div>
  806. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  807. <div class="directive-section"><h2><a name="User" id="User">User</a> <a name="user" id="user">Directive</a></h2>
  808. <table class="directive">
  809. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>The userid under which the server will answer
  810. requests</td></tr>
  811. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>User <var>unix-userid</var></code></td></tr>
  812. <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>User #-1</code></td></tr>
  813. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
  814. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>MPM</td></tr>
  815. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td><code class="module"><a href="../mod/leader.html">leader</a></code>, <code class="module"><a href="../mod/perchild.html">perchild</a></code>, <code class="module"><a href="../mod/prefork.html">prefork</a></code>, <code class="module"><a href="../mod/threadpool.html">threadpool</a></code>, <code class="module"><a href="../mod/worker.html">worker</a></code></td></tr>
  816. <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Only valid in global server config since Apache
  817. 2.0</td></tr>
  818. </table>
  819.     <p>The <code class="directive">User</code> directive sets the user ID as
  820.     which the server will answer requests. In order to use this
  821.     directive, the server must be run initially as <code>root</code>.
  822.     If you start the server as a non-root user, it will fail to change
  823.     to the lesser privileged user, and will instead continue to run as
  824.     that original user. If you do start the server as <code>root</code>,
  825.     then it is normal for the parent process to remain running as root.
  826.     <var>Unix-userid</var> is one of:</p>
  827.  
  828.     <dl>
  829.       <dt>A username</dt>
  830.       <dd>Refers to the given user by name.</dd>
  831.  
  832.       <dt># followed by a user number.</dt>
  833.       <dd>Refers to a user by its number.</dd>
  834.     </dl>
  835.  
  836.     <p>The user should have no privileges that result in it being
  837.     able to access files that are not intended to be visible to the
  838.     outside world, and similarly, the user should not be able to
  839.     execute code that is not meant for HTTP requests. It is
  840.     recommended that you set up a new user and group specifically for
  841.     running the server. Some admins use user <code>nobody</code>, but
  842.     this is not always desirable, since the <code>nobody</code> user
  843.     can have other uses on the system.</p>
  844.  
  845.     <div class="warning"><h3>Security</h3>
  846.       <p>Don't set <code class="directive">User</code> (or <code class="directive"><a href="#group">Group</a></code>) to <code>root</code> unless
  847.       you know exactly what you are doing, and what the dangers are.</p>
  848.     </div>
  849.  
  850.     <p>With the <code class="module"><a href="../mod/perchild.html">perchild</a></code> MPM, which is intended to
  851.     server virtual hosts run under different user IDs, the
  852.     <code class="directive">User</code> directive defines the user ID for the
  853.     main server and the fallback for <code class="directive"><a href="../mod/core.html#virtualhost"><VirtualHost></a></code> sections without an
  854.     <code class="directive"><a href="../mod/perchild.html#assignuserid">AssignUserID</a></code> directive.</p>
  855.  
  856.     <p>Special note: Use of this directive in <code class="directive"><a href="../mod/core.html#virtualhost"><VirtualHost></a></code> is no longer supported. To
  857.     configure your server for <a href="../suexec.html">suexec</a> use
  858.     <code class="directive"><a href="../mod/mod_suexec.html#suexecusergroup">SuexecUserGroup</a></code>.</p>
  859.  
  860.     <div class="note"><h3>Note</h3>
  861.       <p>Although the <code class="directive">User</code> directive is present
  862.       in the <code class="module"><a href="../mod/beos.html">beos</a></code> and <code class="module"><a href="../mod/mpmt_os2.html">mpmt_os2</a></code> MPMs,
  863.       it is actually a no-op there and only exists for compatibility
  864.       reasons.</p>
  865.     </div>
  866.  
  867. </div>
  868. </div>
  869. <div class="bottomlang">
  870. <p><span>Available Languages: </span><a href="../de/mod/mpm_common.html" hreflang="de" rel="alternate" title="Deutsch"> de </a> |
  871. <a href="../en/mod/mpm_common.html" title="English"> en </a> |
  872. <a href="../ja/mod/mpm_common.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a></p>
  873. </div><div id="footer">
  874. <p class="apache">Copyright 1999-2004 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>
  875. <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div>
  876. </body></html>