home *** CD-ROM | disk | FTP | other *** search
/ PC World 2003 May / PCWorld_2003-05_cd.bin / Komunik / apache / apache_2.0.45-win32-x86-no_ssl.msi / Data.Cab / F232993_perchild.xml < prev    next >
Extensible Markup Language  |  2002-12-22  |  11KB  |  248 lines
  1. <?xml version="1.0"?>
  2. <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
  3. <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
  4. <modulesynopsis>
  5.  
  6. <name>perchild</name>
  7. <description>Multi-Processing Module allowing for daemon processes serving
  8. requests to be assigned a variety of different userids</description>
  9. <status>MPM</status>
  10. <sourcefile>perchild.c</sourcefile>
  11. <identifier>mpm_perchild_module</identifier>
  12.  
  13. <summary>
  14.     <note type="warning">
  15.       This MPM does not currently work on most platforms.  Work is ongoing
  16.       to make it functional.
  17.     </note>
  18.  
  19.     <p>This Multi-Processing Module (MPM) implements a hybrid
  20.     multi-process, multi-threaded web server. A fixed number of
  21.     processes create threads to handle requests. Fluctuations in
  22.     load are handled by increasing or decreasing the number of
  23.     threads in each process.</p>
  24. </summary>
  25. <seealso><a href="../bind.html">Setting which addresses and ports Apache
  26. uses</a></seealso>
  27.  
  28. <section id="how-it-works"><title>How it works</title>
  29.     <p>A single control process launches the number of child processes
  30.     indicated by the <directive module="perchild">NumServers</directive>
  31.     directive at server startup. Each child process creates threads as
  32.     specified in the <directive module="mpm_common">StartThreads</directive> directive.
  33.     The individual threads then
  34.     listen for connections and serve them when they arrive.</p>
  35.  
  36.     <p>Apache always tries to maintain a pool of <dfn>spare</dfn> or
  37.     idle server threads, which stand ready to serve incoming
  38.     requests. In this way, clients do not need to wait for new
  39.     threads to be created. For each child process, Apache assesses
  40.     the number of idle threads and creates or destroys threads to
  41.     keep this number within the boundaries specified by
  42.     <directive module="mpm_common">MinSpareThreads</directive>
  43.     and <directive module="mpm_common">MaxSpareThreads</directive>.
  44.     Since this process is very self-regulating, it is rarely
  45.     necessary to modify these directives from their default values.
  46.     The maximum number of clients that may be served simultaneously
  47.     is determined by multiplying the number of server processes
  48.     that will be created (<directive 
  49.     module="perchild">NumServers</directive>) by the maximum
  50.     number of threads created in each process
  51.     (<directive module="mpm_common">MaxThreadsPerChild</directive>).</p>
  52.  
  53.     <p>While the parent process is usually started as root under
  54.     Unix in order to bind to port 80, the child processes and
  55.     threads are launched by Apache as a less-privileged user. The
  56.     <directive module="mpm_common">User</directive> and <directive
  57.     module="mpm_common">Group</directive> directives are used to
  58.     set the privileges of the Apache child processes. The child
  59.     processes must be able to read all the content that will be
  60.     served, but should have as few privileges beyond that as
  61.     possible. In addition, unless <a
  62.     href="../suexec.html">suexec</a> is used, these directives also
  63.     set the privileges which will be inherited by CGI scripts.</p>
  64.  
  65.     <p><directive module="mpm_common">MaxRequestsPerChild</directive>
  66.     controls how frequently the
  67.     server recycles processes by killing old ones and launching new
  68.     ones.</p>
  69.  
  70.     <section id="user-ids"><title>Working with different user-IDs</title>
  71.       <p>The <module>perchild</module> MPM adds the extra ability to
  72.       specify that particular processes should serve requests under
  73.       different user-IDs. These user-IDs can then be associated with
  74.       specific virtual hosts. You have to use one <directive
  75.       module="perchild">ChildPerUserID</directive> directive for
  76.       every user/group combination you want to be run. Then you can tie
  77.       particular virtual hosts to that user and group IDs.</p>
  78.  
  79.       <p>The following example runs 7 child processes. Two of them are run
  80.       under <code>user1</code>/<code>group1</code>. The next four are run
  81.       under <code>user2</code>/<code>group2</code> and the remaining
  82.       process uses the <directive module="mpm_common"
  83.       >User</directive> and <directive module="mpm_common">Group</directive>
  84.       of the main server:</p>
  85.  
  86.       <example><title>Global config</title>
  87.         NumServers 7<br />
  88.         ChildPerUserID user1 group1 2<br />
  89.         ChildPerUserID user2 group2 4
  90.       </example>
  91.  
  92.       <p>Using unbalanced numbers of processes as above is useful, if the
  93.       particular virtual hosts produce different load. The assignment to
  94.       the virtual hosts is easily done as in the example below. In
  95.       conclusion with the example above the following assumes, that
  96.       <code>server2</code> has to serve about twice of the hits of
  97.       <code>server1</code>.</p>
  98.  
  99.       <example><title>Example</title>
  100.         NameVirtualHost *<br />
  101.         <br />
  102.         <VirtualHost *><br />
  103.         <indent>
  104.           ServerName fallbackhost<br />
  105.           # no assignment; use fallback<br />
  106.         </indent>
  107.         </VirtualHost><br />
  108.         <br />
  109.         <VirtualHost *><br />
  110.         <indent>
  111.           ServerName server1<br />
  112.           AssignUserID user1 group1<br />
  113.         </indent>
  114.         </VirtualHost><br />
  115.         <br />
  116.         <VirtualHost *><br />
  117.         <indent>
  118.           ServerName server2<br />
  119.           AssignUserID user2 group2<br />
  120.         </indent>
  121.         </VirtualHost>
  122.       </example>
  123.     </section>
  124. </section>
  125.  
  126. <directivesynopsis location="mpm_common"><name>AcceptMutex</name>
  127. </directivesynopsis>
  128. <directivesynopsis location="mpm_common"><name>BS2000Account</name>
  129. </directivesynopsis>
  130. <directivesynopsis location="mpm_common"><name>CoreDumpDirectory</name>
  131. </directivesynopsis>
  132. <directivesynopsis location="mpm_common"><name>Group</name>
  133. </directivesynopsis>
  134. <directivesynopsis location="mpm_common"><name>PidFile</name>
  135. </directivesynopsis>
  136. <directivesynopsis location="mpm_common"><name>Listen</name>
  137. </directivesynopsis>
  138. <directivesynopsis location="mpm_common"><name>ListenBacklog</name>
  139. </directivesynopsis>
  140. <directivesynopsis location="mpm_common"><name>LockFile</name>
  141. </directivesynopsis>
  142. <directivesynopsis location="mpm_common"><name>MaxRequestsPerChild</name>
  143. </directivesynopsis>
  144. <directivesynopsis location="mpm_common"><name>MaxSpareThreads</name>
  145. </directivesynopsis>
  146. <directivesynopsis location="mpm_common"><name>MinSpareThreads</name>
  147. </directivesynopsis>
  148. <directivesynopsis location="mpm_common"><name>ScoreBoardFile</name>
  149. </directivesynopsis>
  150. <directivesynopsis location="mpm_common"><name>SendBufferSize</name>
  151. </directivesynopsis>
  152. <directivesynopsis location="mpm_common"><name>ServerLimit</name>
  153. </directivesynopsis>
  154. <directivesynopsis location="mpm_common"><name>StartThreads</name>
  155. </directivesynopsis>
  156. <directivesynopsis location="mpm_common"><name>ThreadLimit</name>
  157. </directivesynopsis>
  158. <directivesynopsis location="mpm_common"><name>User</name>
  159. </directivesynopsis>
  160.  
  161. <directivesynopsis>
  162. <name>AssignUserID</name>
  163. <description>Tie a virtual host to a user and group ID</description>
  164. <syntax>AssignUserID <var>user-id</var> <var>group-id</var></syntax>
  165. <contextlist><context>virtual host</context></contextlist>
  166.  
  167. <usage>
  168.     <p>Tie a virtual host to a specific user/group combination. Requests
  169.     addressed to the virtual host where this directive appears will be
  170.     served by a process running with the specified user and group ID.</p>
  171.  
  172.     <p>The user and group ID has to be assigned to a number of children
  173.     in the global server config using the <directive module="perchild"
  174.     >ChildPerUserID</directive> directive. See the section above for a
  175.     <a href="#user-ids">configuration example</a>.</p>
  176. </usage>
  177. </directivesynopsis>
  178.  
  179. <directivesynopsis>
  180. <name>ChildPerUserID</name>
  181. <description>Specify user ID and group ID for a number of child
  182. processes</description>
  183. <syntax>ChildPerUserID <var>user-id</var> <var>group-id</var>
  184. <var>num-children</var></syntax>
  185. <contextlist><context>server config</context></contextlist>
  186.  
  187. <usage>
  188.     <p>Specify a user ID and group ID for a number of child processes.
  189.     The third argument, <var>num-children</var>, is the number of child
  190.     processes to start with the specified user and group. It does
  191.     <em>not</em> represent a specific child number. In order to use this
  192.     directive, the server must be run initially as <code>root</code>.
  193.     If you start the server as a non-root user, it will fail to change
  194.     to the lesser privileged user.</p>
  195.  
  196.     <p>If the total number of child processes, found by totaling all of the
  197.     third arguments to all <directive>ChildPerUserID</directive> directives
  198.     in the config file, is less than <directive module="perchild"
  199.     >NumServers</directive>, then all remaining children will inherit the
  200.     <directive module="mpm_common">User</directive> and <directive
  201.     module="mpm_common">Group</directive> settings from the main server.
  202.     See the section above for a <a href="#user-ids">configuration
  203.     example</a>.</p>
  204.  
  205.     <note type="warning"><title>Security</title>
  206.       <p>Don't set <var>user-id</var> (or <var>group-id</var>) to
  207.       <code>root</code> unless you know exactly what you are doing, and
  208.       what the dangers are.</p>
  209.     </note>
  210. </usage>
  211. </directivesynopsis>
  212.  
  213. <directivesynopsis>
  214. <name>MaxThreadsPerChild</name>
  215. <description>Maximum number of threads per child process</description>
  216. <syntax>MaxThreadsPerChild <var>number</var></syntax>
  217. <default>MaxThreadsPerChild 64</default>
  218. <contextlist><context>server config</context></contextlist>
  219.  
  220. <usage>
  221.     <p>This directive sets the maximum number of threads that will be
  222.     created in each child process. To increase this value beyond its
  223.     default, it is necessary to change the value of the <directive
  224.     module="mpm_common">ThreadLimit</directive> directive and stop and
  225.     re-start the server.</p>
  226. </usage>
  227. </directivesynopsis>
  228.  
  229. <directivesynopsis>
  230. <name>NumServers</name>
  231. <description>Total number of children alive at the same time</description>
  232. <syntax>NumServers <var>number</var></syntax>
  233. <default>NumServers 2</default>
  234. <contextlist><context>server config</context></contextlist>
  235.  
  236. <usage>
  237.     <p>The <directive>NumServers</directive> directive determines the number
  238.     of children alive at the same time. This number should be large enough to
  239.     handle the requests for the entire site. To increase this value beyond the
  240.     value of <code>8</code>, it is necessary to change the value of the
  241.     <directive module="mpm_common">ServerLimit</directive> directive and stop
  242.     and re-start the server. See the section above for a <a href="#user-ids"
  243.     >configuration example</a>.</p>
  244. </usage>
  245. </directivesynopsis>
  246.  
  247. </modulesynopsis>
  248.