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