mod_info.xml revision c3fcea07965f59723831e23da647a77518285b8e
23171986812b568beef50b28bdca284ab949e774rbowen<?xml version="1.0"?>
c3fcea07965f59723831e23da647a77518285b8eslive<!DOCTYPE modulesynopsis SYSTEM "/style/modulesynopsis.dtd">
23171986812b568beef50b28bdca284ab949e774rbowen<?xml-stylesheet type="text/xsl" href="/style/manual.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
23171986812b568beef50b28bdca284ab949e774rbowen<summary>
23171986812b568beef50b28bdca284ab949e774rbowen
c3fcea07965f59723831e23da647a77518285b8eslive <p>To configure <module>mod_info</module>, add the following to your
23171986812b568beef50b28bdca284ab949e774rbowen <code>httpd.conf</code> file.</p>
23171986812b568beef50b28bdca284ab949e774rbowen
23171986812b568beef50b28bdca284ab949e774rbowen<example>
23171986812b568beef50b28bdca284ab949e774rbowen&lt;Location /server-info&gt;<br />
23171986812b568beef50b28bdca284ab949e774rbowenSetHandler server-info<br />
23171986812b568beef50b28bdca284ab949e774rbowen&lt;/Location&gt;<br />
23171986812b568beef50b28bdca284ab949e774rbowen</example>
23171986812b568beef50b28bdca284ab949e774rbowen
c3fcea07965f59723831e23da647a77518285b8eslive <p>You may wish to add a
23171986812b568beef50b28bdca284ab949e774rbowen <directive module="core">&lt;Limit&gt;</directive>
23171986812b568beef50b28bdca284ab949e774rbowen clause inside the
23171986812b568beef50b28bdca284ab949e774rbowen <directive module="core">&lt;location&gt;</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
23171986812b568beef50b28bdca284ab949e774rbowen files, including <em>per</em>-directory files (<em>e.g.</em>,
23171986812b568beef50b28bdca284ab949e774rbowen <code>.htaccess</code>). This may have security-related
23171986812b568beef50b28bdca284ab949e774rbowen ramifications for your site.</p>
23171986812b568beef50b28bdca284ab949e774rbowen </note>
23171986812b568beef50b28bdca284ab949e774rbowen</summary>
23171986812b568beef50b28bdca284ab949e774rbowen
23171986812b568beef50b28bdca284ab949e774rbowen<directivesynopsis>
23171986812b568beef50b28bdca284ab949e774rbowen<name>AddModuleInfo</name>
23171986812b568beef50b28bdca284ab949e774rbowen<description>Allows additional information to be added to the module
23171986812b568beef50b28bdca284ab949e774rboweninformation displayed by the server-info handler</description>
23171986812b568beef50b28bdca284ab949e774rbowen<syntax>AddModuleInfo <em>module-name string</em></syntax>
23171986812b568beef50b28bdca284ab949e774rbowen<contextlist><context>server config</context> <context>virtual
23171986812b568beef50b28bdca284ab949e774rbowenhost</context></contextlist>
23171986812b568beef50b28bdca284ab949e774rbowen<compatibility>Apache 1.3 and above</compatibility>
23171986812b568beef50b28bdca284ab949e774rbowen
23171986812b568beef50b28bdca284ab949e774rbowen<usage>
23171986812b568beef50b28bdca284ab949e774rbowen <p>This allows the content of <em>string</em> to be shown as
23171986812b568beef50b28bdca284ab949e774rbowen HTML interpreted, <strong>Additional Information</strong> for
23171986812b568beef50b28bdca284ab949e774rbowen the module <em>module-name</em>. Example:</p>
23171986812b568beef50b28bdca284ab949e774rbowen
23171986812b568beef50b28bdca284ab949e774rbowen<example>
23171986812b568beef50b28bdca284ab949e774rbowenAddModuleInfo 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;'
23171986812b568beef50b28bdca284ab949e774rbowen</example>
23171986812b568beef50b28bdca284ab949e774rbowen</usage>
23171986812b568beef50b28bdca284ab949e774rbowen
23171986812b568beef50b28bdca284ab949e774rbowen</directivesynopsis>
23171986812b568beef50b28bdca284ab949e774rbowen</modulesynopsis>
23171986812b568beef50b28bdca284ab949e774rbowen