diff options
| -rw-r--r-- | docs/manual/mod/core.xml | 26 | ||||
| -rw-r--r-- | docs/manual/mod/mod_ident.xml | 70 | ||||
| -rw-r--r-- | docs/manual/mod/mod_log_config.xml | 5 | ||||
| -rw-r--r-- | docs/manual/sitemap.xml | 1 |
4 files changed, 75 insertions, 27 deletions
diff --git a/docs/manual/mod/core.xml b/docs/manual/mod/core.xml index 3437e4c1d2..aa3c72623f 100644 --- a/docs/manual/mod/core.xml +++ b/docs/manual/mod/core.xml @@ -1152,32 +1152,6 @@ MIME content-type</description> </usage> </directivesynopsis> -<directivesynopsis> -<name>IdentityCheck</name> -<description>Enables logging of the RFC1413 identity of the remote -user</description> -<syntax>IdentityCheck On|Off</syntax> -<default>IdentityCheck Off</default> -<contextlist><context>server config</context><context>virtual host</context> -<context>directory</context></contextlist> -<usage> - <p>This directive enables RFC1413-compliant logging of the - remote user name for each connection, where the client machine - runs identd or something similar. This information is logged in - the access log.</p> - - <p>The information should not be trusted in any way except for - rudimentary usage tracking.</p> - - <p>Note that this can cause serious latency problems accessing - your server since every request requires one of these lookups - to be performed. When firewalls are involved each lookup might - possibly fail and add 30 seconds of latency to each hit. So in - general this is not very useful on public servers accessible - from the Internet.</p> -</usage> -</directivesynopsis> - <directivesynopsis type="section"> <name>IfDefine</name> <description>Encloses directives that will be processed only diff --git a/docs/manual/mod/mod_ident.xml b/docs/manual/mod/mod_ident.xml new file mode 100644 index 0000000000..f77e049e7d --- /dev/null +++ b/docs/manual/mod/mod_ident.xml @@ -0,0 +1,70 @@ +<?xml version="1.0"?> +<!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd"> +<?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?> +<modulesynopsis> + +<name>mod_ident</name> +<description>RFC 1413 ident lookups</description> +<status>Extension</status> +<sourcefile>mod_ident.c</sourcefile> +<identifier>ident_module</identifier> +<compatibility>Available in Apache 2.1 and later</compatibility> + +<summary> + <p>This module queries an <a href="http://www.ietf.org/rfc/rfc1413.txt" + >RFC 1413</a> compatible daemon on a remote host to look up the owner of + a connection.</p> +</summary> +<seealso><module>mod_log_config</module></seealso> + +<directivesynopsis> +<name>IdentityCheck</name> +<description>Enables logging of the RFC 1413 identity of the remote +user</description> +<syntax>IdentityCheck On|Off</syntax> +<default>IdentityCheck Off</default> +<contextlist><context>server config</context><context>virtual host</context> +<context>directory</context></contextlist> +<compatibility>Moved out of core in Apache 2.1</compatibility> + +<usage> + <p>This directive enables <a href="http://www.ietf.org/rfc/rfc1413.txt" + >RFC 1413</a>-compliant logging of the remote user name for each + connection, where the client machine runs identd or something similar. + This information is logged in the access log using the <code>%...l</code> + <a href="mod_log_config.html#formats">format string</a>.</p> + + <note> + The information should not be trusted in any way except for + rudimentary usage tracking. + </note> + + <p>Note that this can cause serious latency problems accessing + your server since every request requires one of these lookups + to be performed. When firewalls or proxy servers are involved, + each lookup might possibly fail and add a latency duration as + defined by the <directive module="mod_ident" + >IdentityCheckTimeout</directive> directive to each hit. So in + general this is not very useful on public servers accessible from + the Internet.</p> +</usage> +</directivesynopsis> + +<directivesynopsis> +<name>IdentityCheckTimeout</name> +<description>Determines the timeout duration for ident requests</description> +<syntax>IdentityCheckTimeout <var>seconds</var></syntax> +<default>IdentityCheckTimeout 30</default> +<contextlist><context>server config</context><context>virtual host</context> +<context>directory</context></contextlist> +<usage> + <p>This directive specifies the timeout duration of an ident + request. The default value of 30 seconds is recommended by <a + href="http://www.ietf.org/rfc/rfc1413.txt">RFC 1413</a>, mainly because + of possible network latency. However, you may want to adjust the + timeout value according to your local network speed.</p> +</usage> +</directivesynopsis> + +</modulesynopsis> + diff --git a/docs/manual/mod/mod_log_config.xml b/docs/manual/mod/mod_log_config.xml index bdd5d74809..8e349fca14 100644 --- a/docs/manual/mod/mod_log_config.xml +++ b/docs/manual/mod/mod_log_config.xml @@ -88,7 +88,10 @@ in the request sent to the server.</td></tr> <tr><td><code>%...l</code></td> - <td>Remote logname (from identd, if supplied)</td></tr> + <td>Remote logname (from identd, if supplied). This will return a + dash unless <module>mod_ident</module> is present and <directive + module="mod_ident">IdentityCheck</directive> is set + <code>On</code>.</td></tr> <tr><td><code>%...m</code></td> <td>The request method</td></tr> diff --git a/docs/manual/sitemap.xml b/docs/manual/sitemap.xml index a5005aa267..d2e9088d1d 100644 --- a/docs/manual/sitemap.xml +++ b/docs/manual/sitemap.xml @@ -159,6 +159,7 @@ Server on HPUX</page> <modulefile>mod_ext_filter.xml</modulefile> <modulefile>mod_file_cache.xml</modulefile> <modulefile>mod_headers.xml</modulefile> + <modulefile>mod_ident.xml</modulefile> <modulefile>mod_imap.xml</modulefile> <modulefile>mod_include.xml</modulefile> <modulefile>mod_info.xml</modulefile> |