granicus.if.org Git - apache/blob - docs/manual/server-wide.xml

   1 <?xml version='1.0' encoding='UTF-8' ?>
   2 <!DOCTYPE manualpage SYSTEM "./style/manualpage.dtd">
   3 <?xml-stylesheet type="text/xsl" href="./style/manual.en.xsl"?>
   4 <!-- $LastChangedRevision$ -->
   5
   6 <!--
   7  Copyright 2002-2004 The Apache Software Foundation
   8
   9  Licensed under the Apache License, Version 2.0 (the "License");
  10  you may not use this file except in compliance with the License.
  11  You may obtain a copy of the License at
  12
  13      http://www.apache.org/licenses/LICENSE-2.0
  14
  15  Unless required by applicable law or agreed to in writing, software
  16  distributed under the License is distributed on an "AS IS" BASIS,
  17  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18  See the License for the specific language governing permissions and
  19  limitations under the License.
  20 -->
  21
  22 <manualpage metafile="server-wide.xml.meta">
  23
  24   <title>Server-Wide Configuration</title>
  25
  26 <summary>
  27 <p>This document explains some of the directives provided by
  28 the <module>core</module> server which are used to configure
  29 the basic operations of the server.</p>
  30 </summary>
  31
  32   <section id="identification">
  33     <title>Server Identification</title>
  34
  35     <related>
  36       <directivelist>
  37         <directive module="core">ServerName</directive>
  38         <directive module="core">ServerAdmin</directive>
  39         <directive module="core">ServerSignature</directive>
  40         <directive module="core">ServerTokens</directive>
  41         <directive module="core">UseCanonicalName</directive>
  42       </directivelist>
  43     </related>
  44
  45     <p>The <directive module="core">ServerAdmin</directive> and
  46     <directive module="core">ServerTokens</directive> directives
  47     control what information about the server will be presented
  48     in server-generated documents such as error messages. The
  49     <directive module="core">ServerTokens</directive> directive
  50     sets the value of the Server HTTP response header field.</p>
  51
  52     <p>The <directive module="core">ServerName</directive> and
  53     <directive module="core">UseCanonicalName</directive>
  54     directives are used by the server to determine how to construct
  55     self-referential URLs. For example, when a client requests a
  56     directory, but does not include the trailing slash in the
  57     directory name, Apache must redirect the client to the full
  58     name including the trailing slash so that the client will
  59     correctly resolve relative references in the document.</p>
  60   </section>
  61
  62   <section id="locations">
  63     <title>File Locations</title>
  64
  65     <related>
  66       <directivelist>
  67         <directive module="mpm_common">CoreDumpDirectory</directive>
  68         <directive module="core">DocumentRoot</directive>
  69         <directive module="core">ErrorLog</directive>
  70         <directive module="mpm_common">LockFile</directive>
  71         <directive module="mpm_common">PidFile</directive>
  72         <directive module="mpm_common">ScoreBoardFile</directive>
  73         <directive module="core">ServerRoot</directive>
  74       </directivelist>
  75     </related>
  76
  77     <p>These directives control the locations of the various files
  78     that Apache needs for proper operation. When the pathname used
  79     does not begin with a slash (/), the files are located relative
  80     to the <directive module="core">ServerRoot</directive>. Be careful
  81     about locating files in paths which are writable by non-root users.
  82     See the <a href="misc/security_tips.html#serverroot">security tips</a>
  83     documentation for more details.</p>
  84   </section>
  85
  86   <section id="resource">
  87     <title>Limiting Resource Usage</title>
  88
  89     <related>
  90       <directivelist>
  91         <directive module="core">LimitRequestBody</directive>
  92         <directive module="core">LimitRequestFields</directive>
  93         <directive module="core">LimitRequestFieldsize</directive>
  94         <directive module="core">LimitRequestLine</directive>
  95         <directive module="core">RLimitCPU</directive>
  96         <directive module="core">RLimitMEM</directive>
  97         <directive module="core">RLimitNPROC</directive>
  98         <directive module="mpm_common">ThreadStackSize</directive>
  99       </directivelist>
 100     </related>
 101
 102     <p>The <directive>LimitRequest</directive>*
 103     directives are used to place limits on the amount of resources
 104     Apache will use in reading requests from clients. By limiting
 105     these values, some kinds of denial of service attacks can be
 106     mitigated.</p>
 107
 108     <p>The <directive>RLimit</directive>* directives
 109     are used to limit the amount of resources which can be used by
 110     processes forked off from the Apache children. In particular,
 111     this will control resources used by CGI scripts and SSI exec
 112     commands.</p>
 113
 114     <p>The <directive module="mpm_common">ThreadStackSize</directive>
 115     directive is used with some platforms to control the stack size.</p>
 116   </section>
 117 </manualpage>