mod_info.html revision 4e59fdbc3e0d0c17a28469c9efbc0a071622d5ec
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<HTML>
<HEAD>
<TITLE>Apache module mod_info</TITLE>
</HEAD>
<!-- Background white, links blue (unvisited), navy (visited), red (active) -->
<BODY
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#000080"
ALINK="#FF0000"
>
<!--#include virtual="header.html" -->
<H1 ALIGN="CENTER">Module mod_info</H1>
<p>This module provides a comprehensive overview of the server
configuration including all installed modules and directives in the
configuration files.</p>
<P><A
HREF="module-dict.html#Status"
REL="Help"
><STRONG>Status:</STRONG></A> Extension
<BR>
<A
HREF="module-dict.html#SourceFile"
REL="Help"
><STRONG>Source File:</STRONG></A> mod_info.c
<BR>
<A
HREF="module-dict.html#ModuleIdentifier"
REL="Help"
><STRONG>Module Identifier:</STRONG></A> info_module
<BR>
<A
HREF="module-dict.html#compatibility"
REL="Help"
><STRONG>Compatibility:</STRONG></A> Available in Apache 1.1 and later.
</P>
<H2>Directives</H2>
<UL>
<LI><A HREF="#addmoduleinfo">AddModuleInfo</A>
</UL>
<h2>Using mod_info</h2>
<P>
To configure it, add the following to your <CODE>access.conf</CODE> file.
<PRE>
&lt;Location /server-info&gt;
SetHandler server-info
&lt;/Location&gt;
</PRE>
You may wish to add a
<A
HREF="core.html#limit"
>&lt;Limit&gt;</A>
clause inside the
<A
HREF="core.html#location"
>location</A>
directive to limit access to your server configuration information.<P>
Once configured, the server information is obtained by accessing
<TT>http://your.host.dom/server-info</TT><P>
<BLOCKQUOTE>
<STRONG>
Note that the configuration files are read by the module at run-time,
and therefore the display may <EM>not</EM> reflect the running
server's active configuration if the files have been changed since the
server was last reloaded. Also, the configuration files must be
readable by the user as which the server is running (see the
<A
HREF="core.html#user"
><SAMP>User</SAMP></A>
directive), or else the directive settings will not be listed.
<P>
It should also be noted that if <SAMP>mod_info</SAMP> is compiled into
the server, its handler capability is available in <EM>all</EM>
configuration files, including <EM>per</EM>-directory files
(<EM>e.g.</EM>, <SAMP>.htaccess</SAMP>). This may have
security-related ramifications for your site.
</P>
</STRONG>
</BLOCKQUOTE>
<HR>
<H2><A NAME="addmoduleinfo">AddModuleInfo</A></H2>
<A
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A> AddModuleInfo <EM>module-name string</EM><BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
><STRONG>Context:</STRONG></A> server config, virtual host<BR>
<A
HREF="directive-dict.html#Status"
REL="Help"
><STRONG>Status:</STRONG></A> Extension<BR>
<A
HREF="directive-dict.html#Module"
REL="Help"
><STRONG>Module:</STRONG></A> mod_info<BR>
<A
HREF="directive-dict.html#Compatibility"
REL="Help"
><STRONG>Compatibility:</STRONG></A> Apache 1.3 and above<P>
This allows the content of <EM>string</EM> to be shown as
HTML interpreted,
<STRONG>Additional Information</STRONG> for the module <EM>module-name</EM>.
Example:
<BLOCKQUOTE>
<PRE>
AddModuleInfo mod_auth.c 'See &lt;A HREF="http://www.apache.org/docs/mod/mod_auth.html"&gt;http://www.apache.org/docs/mod/mod_auth.html&lt;/A&gt;'
</PRE>
</BLOCKQUOTE>
<!--#include virtual="footer.html" -->
</BODY>
</HTML>