mod_log_referer.html revision e10c7703114de421bfd2772a0265691884bafdb8
6a55cc6751be1162fa737fa656ffae0729c2e2a0Krzysztof Kosiński<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
6a55cc6751be1162fa737fa656ffae0729c2e2a0Krzysztof Kosiński<HTML>
6a55cc6751be1162fa737fa656ffae0729c2e2a0Krzysztof Kosiński<HEAD>
6a55cc6751be1162fa737fa656ffae0729c2e2a0Krzysztof Kosiński<TITLE>Apache module mod_log_referer</TITLE>
6a55cc6751be1162fa737fa656ffae0729c2e2a0Krzysztof Kosiński</HEAD>
6a55cc6751be1162fa737fa656ffae0729c2e2a0Krzysztof Kosiński
6a55cc6751be1162fa737fa656ffae0729c2e2a0Krzysztof Kosiński<BODY>
6a55cc6751be1162fa737fa656ffae0729c2e2a0Krzysztof Kosiński<!--#include virtual="header.html" -->
6a55cc6751be1162fa737fa656ffae0729c2e2a0Krzysztof Kosiński<H1>Module mod_log_referer</h1>
6a55cc6751be1162fa737fa656ffae0729c2e2a0Krzysztof Kosiński
6a55cc6751be1162fa737fa656ffae0729c2e2a0Krzysztof KosińskiThis module is contained in the <code>mod_log_referer.c</code> file, and is not
6a55cc6751be1162fa737fa656ffae0729c2e2a0Krzysztof Kosińskicompiled in by default. It provides for logging of the documents which
6a55cc6751be1162fa737fa656ffae0729c2e2a0Krzysztof Kosińskireference documents on the server.
6a55cc6751be1162fa737fa656ffae0729c2e2a0Krzysztof Kosiński
6a55cc6751be1162fa737fa656ffae0729c2e2a0Krzysztof Kosiński<h2>Log file format</h2>
6a55cc6751be1162fa737fa656ffae0729c2e2a0Krzysztof KosińskiThe log file contains a separate line for each refer. Each line has the
6a55cc6751be1162fa737fa656ffae0729c2e2a0Krzysztof Kosińskiformat
6a55cc6751be1162fa737fa656ffae0729c2e2a0Krzysztof Kosiński<blockquote><em>uri</em> <code>-></code> <em>document</em></blockquote>
6a55cc6751be1162fa737fa656ffae0729c2e2a0Krzysztof Kosińskiwhere <em>uri</em> is the (%-escaped) URI for the document that references
6a55cc6751be1162fa737fa656ffae0729c2e2a0Krzysztof Kosińskithe one requested by the client, and <em>document</em> is the (%-decoded)
6a55cc6751be1162fa737fa656ffae0729c2e2a0Krzysztof Kosińskilocal URL to the document being referred to.
6a55cc6751be1162fa737fa656ffae0729c2e2a0Krzysztof Kosiński
1df6105803c4c56c020a56301c7c9c4890fd4158mathog
1df6105803c4c56c020a56301c7c9c4890fd4158mathog<h2>Directives</h2>
1df6105803c4c56c020a56301c7c9c4890fd4158mathog<ul>
1df6105803c4c56c020a56301c7c9c4890fd4158mathog<li><A HREF="#refererignore">RefererIgnore</A>
6a55cc6751be1162fa737fa656ffae0729c2e2a0Krzysztof Kosiński<li><A HREF="#refererlog">RefererLog</A>
6a55cc6751be1162fa737fa656ffae0729c2e2a0Krzysztof Kosiński</ul>
<hr>
<A name="refererignore"><h2>RefererIgnore</h2></A>
<!--%plaintext &lt;?INDEX {\tt RefererIgnore} directive&gt; -->
<strong>Syntax:</strong> RefererIgnore <em>string string ...</em><br>
<Strong>Context:</strong> server config, virtual host<br>
<strong>Status:</strong> Extension<br>
<strong>Module:</strong> mod_log_referer<p>
The RefererIgnore directive adds to the list of strings to ignore in
Referer headers. If any of the strings in the list is contained in
the Referer header, then no referrer information will be logged for the
request. Example:
<blockquote><code>RefererIgnore www.ncsa.uiuc.edu</code></blockquote>
This avoids logging references from www.ncsa.uiuc.edu.
<p><hr>
<A name="refererlog"><h2>RefererLog</h2></A>
<!--%plaintext &lt;?INDEX {\tt RefererLog} directive&gt; -->
<strong>Syntax:</strong> RefererLog <em>file-pipe</em><br>
<strong>Default:</strong> <code>RefererLog logs/referer_log</code><br>
<Strong>Context:</strong> server config, virtual host<br>
<strong>Status:</strong> Extension<br>
<strong>Module:</strong> mod_log_referer<p>
The RefererLog directive sets the name of the file to which the server will
log the Referer header of incoming requests. <em>File-pipe</em> is one
of
<dl><dt>A filename
<dd>A filename relative to the <A HREF="core.html#serverroot">ServerRoot</A>.
<dt> `|' followed by a command
<dd>A program to receive the referrer log information on its standard input.
Note the a new program will not be started for a VirtualHost if it inherits
the RefererLog from the main server.
</dl>
<strong>Security:</strong> if a program is used, then it will be
run under the user who started httpd. This will be root if the server
was started by root; be sure that the program is secure.<p>
<strong>Security:</strong> See the <A
HREF="/misc/security_tips.html">security tips</A> document for
details on why your security could be compromised if the directory
where logfiles are stored is writable by anyone other than the user
that starts the server.<P>
This directive is provided for compatibility with NCSA 1.4.<p>
<!--#include virtual="footer.html" -->
</BODY>
</HTML>