manual/mod/mod_info.xml

	mod_info.xml revision 72efd3996108e6e17834609af9cf84b95e4c586e
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz<?xml version="1.0"?>
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz<!DOCTYPE modulesynopsis SYSTEM "/style/modulesynopsis.dtd">
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz<?xml-stylesheet type="text/xsl" href="/style/manual.en.xsl"?>
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz<modulesynopsis>
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz<name>mod_info</name>
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz<description>Provides a comprehensive overview of the server
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarzconfiguration</description>
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz<status>Extension</status>
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz<sourcefile>mod_info.c</sourcefile>
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz<identifier>info_module</identifier>
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz<summary>
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz    <p>To configure <module>mod_info</module>, add the following to your
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz    <code>httpd.conf</code> file.</p>
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz    <example>
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz      &lt;Location /server-info&gt;<br />
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz      <indent>
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz        SetHandler server-info<br />
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz      </indent>
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz      &lt;/Location&gt;
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz    </example>
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz    <p>You may wish to add a
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz    <directive type="section" module="core">Limit</directive>
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz    clause inside the
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz    <directive type="section" module="core">Location</directive>
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz    directive to limit access to your server configuration
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz    information.</p>
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz    <p>Once configured, the server information is obtained by
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz    accessing <code>http://your.host.dom/server-info</code></p>
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz    <note>
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz      Note that the configuration files are read by the
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz      module at run-time, and therefore the display may
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz      <em>not</em> reflect the running server's active
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz      configuration if the files have been changed since the server
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz      was last reloaded. Also, the configuration files must be
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz      readable by the user as which the server is running (see the
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz      <directive module="mpm_common">User</directive> directive), or
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz      else the directive settings will not be listed.
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz      <p>It should also be noted that if
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz      <module>mod_info</module> is compiled into the server, its
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz      handler capability is available in <em>all</em> configuration
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz      files, including per-directory files (<em>e.g.</em>,
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz      <code>.htaccess</code>). This may have security-related
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz      ramifications for your site.</p>
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz      <p>In particular, this module can leak sensitive information
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz      from the configuration directives of other Apache modules such as
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz      system paths, usernames/passwords, database names, etc.  Due to
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz      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_authn_file.c 'See &lt;a \<br />
      <indent>
      href="http://www.apache.org/docs-2.0/mod/mod_authn_file.html"&gt;\<br />
      http://www.apache.org/docs-2.0/mod/mod_authn_file.html&lt;/a&gt;'
      </indent>
    </example>
</usage>

</directivesynopsis>
</modulesynopsis>