<?xml version="1.0"?>
<!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
<?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
<modulesynopsis metafile="mod_info.xml.meta">

<name>mod_info</name>
<description>Provides a comprehensive overview of the server
configuration</description>
<status>Extension</status>
<sourcefile>mod_info.c</sourcefile>
<identifier>info_module</identifier>

<summary>
    <p>To configure <module>mod_info</module>, add the following to your
    <code>httpd.conf</code> file.</p>

    <example>
      &lt;Location /server-info&gt;<br />
      <indent>
        SetHandler server-info<br />
      </indent>
      &lt;/Location&gt;
    </example>

    <p>You may wish to add a 
    <directive type="section" module="core">Limit</directive> 
    clause inside the 
    <directive type="section" module="core">Location</directive>
    directive to limit access to your server configuration 
    information.</p>

    <p>Once configured, the server information is obtained by
    accessing <code>http://your.host.dom/server-info</code></p>

    <note>
      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
      <directive module="mpm_common">User</directive> directive), or
      else the directive settings will not be listed.

      <p>It should also be noted that if
      <module>mod_info</module> is compiled into the server, its
      handler capability is available in <em>all</em> configuration
      files, including per-directory files (<em>e.g.</em>,
      <code>.htaccess</code>). This may have security-related
      ramifications for your site.</p>

      <p>In particular, this module can leak sensitive information
      from the configuration directives of other Apache modules such as
      system paths, usernames/passwords, database names, etc.  Due to
      the way this module works there is no way to block information
      from it.  Therefore, this module should <strong>only</strong> be
      used in a controlled environment and always with caution.</p>
    </note>
</summary>

<directivesynopsis>
<name>AddModuleInfo</name>
<description>Adds additional information to the module
information displayed by the server-info handler</description>
<syntax>AddModuleInfo <var>module-name</var> <var>string</var></syntax>
<contextlist><context>server config</context><context>virtual host</context>
</contextlist>
<compatibility>Apache 1.3 and above</compatibility>

<usage>
    <p>This allows the content of <var>string</var> to be shown as
    HTML interpreted, <strong>Additional Information</strong> for
    the module <var>module-name</var>. Example:</p>

    <example>
      AddModuleInfo mod_auth.c 'See &lt;a \<br />
      <indent>
        href="http://www.apache.org/docs-2.0/mod/mod_auth.html"&gt;\<br />
        http://www.apache.org/docs-2.0/mod/mod_auth.html&lt;/a&gt;'
      </indent>
    </example>
</usage>

</directivesynopsis>
</modulesynopsis>

