mod_info.xml revision 4e191199a0aeab09d78df8f5579e745572e8b7bc
23171986812b568beef50b28bdca284ab949e774rbowen<?xml version="1.0"?>
c3fcea07965f59723831e23da647a77518285b8eslive<!DOCTYPE modulesynopsis SYSTEM "/style/modulesynopsis.dtd">
e942c741056732f50da2074b36fe59805d370650slive<?xml-stylesheet type="text/xsl" href="/style/manual.en.xsl"?>
23171986812b568beef50b28bdca284ab949e774rbowen<modulesynopsis>
23171986812b568beef50b28bdca284ab949e774rbowen
23171986812b568beef50b28bdca284ab949e774rbowen<name>mod_info</name>
c3fcea07965f59723831e23da647a77518285b8eslive<description>Provides a comprehensive overview of the server
c3fcea07965f59723831e23da647a77518285b8esliveconfiguration</description>
23171986812b568beef50b28bdca284ab949e774rbowen<status>Extension</status>
23171986812b568beef50b28bdca284ab949e774rbowen<sourcefile>mod_info.c</sourcefile>
c3fcea07965f59723831e23da647a77518285b8eslive<identifier>info_module</identifier>
23171986812b568beef50b28bdca284ab949e774rbowen
23171986812b568beef50b28bdca284ab949e774rbowen<summary>
c3fcea07965f59723831e23da647a77518285b8eslive <p>To configure <module>mod_info</module>, add the following to your
23171986812b568beef50b28bdca284ab949e774rbowen <code>httpd.conf</code> file.</p>
23171986812b568beef50b28bdca284ab949e774rbowen
72efd3996108e6e17834609af9cf84b95e4c586end <example>
72efd3996108e6e17834609af9cf84b95e4c586end &lt;Location /server-info&gt;<br />
72efd3996108e6e17834609af9cf84b95e4c586end <indent>
72efd3996108e6e17834609af9cf84b95e4c586end SetHandler server-info<br />
72efd3996108e6e17834609af9cf84b95e4c586end </indent>
72efd3996108e6e17834609af9cf84b95e4c586end &lt;/Location&gt;
72efd3996108e6e17834609af9cf84b95e4c586end </example>
23171986812b568beef50b28bdca284ab949e774rbowen
c3fcea07965f59723831e23da647a77518285b8eslive <p>You may wish to add a
ca0d928ec8e2519c9ef548469de80d80efd0fdband <directive type="section" module="core">Limit</directive>
23171986812b568beef50b28bdca284ab949e774rbowen clause inside the
ca0d928ec8e2519c9ef548469de80d80efd0fdband <directive type="section" module="core">Location</directive>
23171986812b568beef50b28bdca284ab949e774rbowen directive to limit access to your server configuration
c3fcea07965f59723831e23da647a77518285b8eslive information.</p>
23171986812b568beef50b28bdca284ab949e774rbowen
23171986812b568beef50b28bdca284ab949e774rbowen <p>Once configured, the server information is obtained by
23171986812b568beef50b28bdca284ab949e774rbowen accessing <code>http://your.host.dom/server-info</code></p>
23171986812b568beef50b28bdca284ab949e774rbowen
23171986812b568beef50b28bdca284ab949e774rbowen <note>
23171986812b568beef50b28bdca284ab949e774rbowen Note that the configuration files are read by the
23171986812b568beef50b28bdca284ab949e774rbowen module at run-time, and therefore the display may
23171986812b568beef50b28bdca284ab949e774rbowen <em>not</em> reflect the running server's active
23171986812b568beef50b28bdca284ab949e774rbowen configuration if the files have been changed since the server
23171986812b568beef50b28bdca284ab949e774rbowen was last reloaded. Also, the configuration files must be
23171986812b568beef50b28bdca284ab949e774rbowen readable by the user as which the server is running (see the
23171986812b568beef50b28bdca284ab949e774rbowen <directive module="mpm_common">User</directive> directive), or
23171986812b568beef50b28bdca284ab949e774rbowen else the directive settings will not be listed.
23171986812b568beef50b28bdca284ab949e774rbowen
23171986812b568beef50b28bdca284ab949e774rbowen <p>It should also be noted that if
23171986812b568beef50b28bdca284ab949e774rbowen <module>mod_info</module> is compiled into the server, its
23171986812b568beef50b28bdca284ab949e774rbowen handler capability is available in <em>all</em> configuration
72efd3996108e6e17834609af9cf84b95e4c586end files, including per-directory files (<em>e.g.</em>,
23171986812b568beef50b28bdca284ab949e774rbowen <code>.htaccess</code>). This may have security-related
23171986812b568beef50b28bdca284ab949e774rbowen ramifications for your site.</p>
d87e108084c51be918345aaa2e2c05803ee88a3djwoolley
d87e108084c51be918345aaa2e2c05803ee88a3djwoolley <p>In particular, this module can leak sensitive information
d87e108084c51be918345aaa2e2c05803ee88a3djwoolley from the configuration directives of other Apache modules such as
d87e108084c51be918345aaa2e2c05803ee88a3djwoolley system paths, usernames/passwords, database names, etc. Due to
d87e108084c51be918345aaa2e2c05803ee88a3djwoolley the way this module works there is no way to block information
72efd3996108e6e17834609af9cf84b95e4c586end from it. Therefore, this module should <strong>only</strong> be
72efd3996108e6e17834609af9cf84b95e4c586end used in a controlled environment and always with caution.</p>
23171986812b568beef50b28bdca284ab949e774rbowen </note>
23171986812b568beef50b28bdca284ab949e774rbowen</summary>
23171986812b568beef50b28bdca284ab949e774rbowen
23171986812b568beef50b28bdca284ab949e774rbowen<directivesynopsis>
23171986812b568beef50b28bdca284ab949e774rbowen<name>AddModuleInfo</name>
15ba1801088da1aad6d20609cf3f7b0b1eefce8aslive<description>Adds additional information to the module
23171986812b568beef50b28bdca284ab949e774rboweninformation displayed by the server-info handler</description>
72efd3996108e6e17834609af9cf84b95e4c586end<syntax>AddModuleInfo <var>module-name</var> <var>string</var></syntax>
72efd3996108e6e17834609af9cf84b95e4c586end<contextlist><context>server config</context><context>virtual host</context>
72efd3996108e6e17834609af9cf84b95e4c586end</contextlist>
23171986812b568beef50b28bdca284ab949e774rbowen<compatibility>Apache 1.3 and above</compatibility>
23171986812b568beef50b28bdca284ab949e774rbowen
23171986812b568beef50b28bdca284ab949e774rbowen<usage>
72efd3996108e6e17834609af9cf84b95e4c586end <p>This allows the content of <var>string</var> to be shown as
23171986812b568beef50b28bdca284ab949e774rbowen HTML interpreted, <strong>Additional Information</strong> for
72efd3996108e6e17834609af9cf84b95e4c586end the module <var>module-name</var>. Example:</p>
72efd3996108e6e17834609af9cf84b95e4c586end
72efd3996108e6e17834609af9cf84b95e4c586end <example>
b9b166bce28378f88ecba40c17f788f510b8357and AddModuleInfo mod_deflate.c 'See &lt;a \<br />
72efd3996108e6e17834609af9cf84b95e4c586end <indent>
4e191199a0aeab09d78df8f5579e745572e8b7bcwsanchez href="http://www.apache.org/docs-2.1/mod/mod_deflate.html"&gt;\<br />
4e191199a0aeab09d78df8f5579e745572e8b7bcwsanchez http://www.apache.org/docs-2.1/mod/mod_deflate.html&lt;/a&gt;'
72efd3996108e6e17834609af9cf84b95e4c586end </indent>
72efd3996108e6e17834609af9cf84b95e4c586end </example>
23171986812b568beef50b28bdca284ab949e774rbowen</usage>
23171986812b568beef50b28bdca284ab949e774rbowen
23171986812b568beef50b28bdca284ab949e774rbowen</directivesynopsis>
23171986812b568beef50b28bdca284ab949e774rbowen</modulesynopsis>
23171986812b568beef50b28bdca284ab949e774rbowen