From: Richard Bowen Date: Sat, 23 Mar 2002 03:23:15 +0000 (+0000) Subject: Completed going through mod/code.xml ensuring that every directive X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=b37aadbb74652a837772439ea61aaa8929595785;p=apache Completed going through mod/code.xml ensuring that every directive contains at least one example. A little additional clarification a few places. Updates STATUS to reflect the status of this task. git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@94144 13f79535-47bb-0310-9956-ffa450edef68 --- diff --git a/docs/STATUS b/docs/STATUS index 1577146f5c..4eb1f5be9d 100644 --- a/docs/STATUS +++ b/docs/STATUS @@ -1,5 +1,5 @@ Apache HTTP Server 2.0 Documentation Status File. -Last modified: $Date: 2002/02/17 21:09:03 $ +Last modified: $Date: 2002/03/23 03:23:15 $ If you are interested in helping accomplish some of the tasks on this list or otherwise improving the documentation, please join the @@ -136,9 +136,9 @@ Documentation improvements - Every directive should have at least one example of usage, except those directives which list all possible usages in the Syntax - description. Some module docs have been reviewed for this, and - mod/core.html has been checked up through the directive. - --rcb + description. And maybe some of those too. People like examples. + mod/core.html has been checked all the way through, as have a few + of the modules. * Making site-specific enhancements easier, including a documented and robust way for 3P module docco to be added -- and have it diff --git a/docs/manual/mod/core.xml b/docs/manual/mod/core.xml index dbc404f20f..c5c6f3fb98 100644 --- a/docs/manual/mod/core.xml +++ b/docs/manual/mod/core.xml @@ -1161,14 +1161,23 @@ except the named ones

LimitExcept and - </LimitExcept> are used to enclose a group of - access control directives which will then apply to any HTTP access - method not listed in the arguments; i.e., it is - the opposite of a </LimitExcept> are used to enclose + a group of access control directives which will then apply to any + HTTP access method not listed in the arguments; + i.e., it is the opposite of a Limit section and can be used to control both standard and nonstandard/unrecognized methods. See the documentation for Limit for more details.

+ +

For example:

+ + + <LimitExcept POST GET>
+ Require valid-user
+ <LimitExcept> + + @@ -1206,6 +1215,15 @@ from the client control over abnormal client request behavior, which may be useful for avoiding some forms of denial-of-service attacks.

+ +

If, for example, you are permitting file upload to a particular + location, and wich to limit the size of the uploaded file to 100K, + you might use the following directive:

+ + + LimitRequestBody 102400 + + @@ -1240,6 +1258,13 @@ will be accepted from the client The value should be increased if normal clients see an error response from the server that indicates too many fields were sent in the request.

+ +

For example:

+ + + LimitRequestFields 50 + + @@ -1270,9 +1295,17 @@ client

This directive gives the server administrator greater control over abnormal client request behavior, which may be - useful for avoiding some forms of denial-of-service attacks. - Under normal conditions, the value should not be changed from - the default.

+ useful for avoiding some forms of denial-of-service attacks.

+ +

For example:

+ + + LimitRequestFieldSize 16380 + + + Under normal conditions, the value should not be changed from + the default. + @@ -1303,9 +1336,16 @@ from the client

This directive gives the server administrator greater control over abnormal client request behavior, which may be - useful for avoiding some forms of denial-of-service attacks. - Under normal conditions, the value should not be changed from - the default.

+ useful for avoiding some forms of denial-of-service attacks.

+ +

For example:

+ + + LimitRequestLine 16380 + + + Under normal conditions, the value should not be changed from + the default. @@ -1319,6 +1359,13 @@ from the client

Limit (in bytes) on maximum size of an XML-based request body. A value of 0 will disable any checking.

+ +

Example:

+ + + LimitXMLRequestBody 0 + + @@ -1327,7 +1374,7 @@ from the client Applies the enclosed directives only to matching URLs <Location - URL-path|URL> ... </Location> + URL-path|URL> ... </Location> server configvirtual host @@ -1456,16 +1503,11 @@ matching URLs levels are available, in order of decreasing significance:

- +
- - - - @@ -1474,11 +1516,6 @@ matching URLs - - - - @@ -1487,11 +1524,6 @@ matching URLs - - - - @@ -1500,11 +1532,6 @@ matching URLs - - - - @@ -1513,11 +1540,6 @@ matching URLs - - - - @@ -1526,11 +1548,6 @@ matching URLs - - - - @@ -1540,11 +1557,6 @@ matching URLs - - - - @@ -1554,11 +1566,6 @@ matching URLs - - - - @@ -1568,11 +1575,6 @@ matching URLs - - - - @@ -1586,6 +1588,11 @@ matching URLs

Using a level of at least crit is recommended.

+ +

For example:

+ + LogLevel notice + @@ -1604,6 +1611,10 @@ connection set to "0", unlimited requests will be allowed. We recommend that this setting be kept to a high value for maximum server performance.

+ +

For example:

+ + MaxKeepAliveRequests 500 @@ -1650,6 +1661,9 @@ hostingNameVirtualHost [fe80::a00:20ff:fea7:ccea]:8080 +See also: Virtual Hosts +documentation + @@ -1971,7 +1985,21 @@ interact valid username and password. This can be used to password restrict an area, but to let clients from particular addresses in without prompting for a password.

+ +

For example, if you wanted to let people on your network have + unrestricted access to a portion of your website, but require that + people outside of your network provide a password, you could use a + configuration similar to the following:

+ + + Require valid-user
+ Allow from 192.168.1
+ Satisfy any + + + Allow + Require @@ -2480,4 +2508,4 @@ hostname or IP address request is received - \ No newline at end of file +
Level Description
- Example
emerg Emergencies - system is unusable.
- "Child cannot open lock file. Exiting"
alert Action must be taken immediately.
- "getpwuid: couldn't determine user name from uid"
crit Critical Conditions.
- "socket: Failed to get a socket, exiting child"
error Error conditions.
- "Premature end of script headers"
warn Warning conditions.
- "child process 1234 did not exit, sending another SIGHUP" notice Normal but significant condition.
- "httpd: caught SIGBUS, attempting to dump core in ..." info Informational.
- "Server seems busy, (you may need to increase StartServers, or Min/MaxSpareServers)..." debug Debug-level messages
- "Opening config file ..."