mod_info.xml revision d87e108084c51be918345aaa2e2c05803ee88a3d
817b1bcafff27cc67630dd0cbd36df708c05fcccStephen Gallagher<?xml version="1.0"?>
817b1bcafff27cc67630dd0cbd36df708c05fcccStephen Gallagher<!DOCTYPE modulesynopsis SYSTEM "/style/modulesynopsis.dtd">
817b1bcafff27cc67630dd0cbd36df708c05fcccStephen Gallagher<?xml-stylesheet type="text/xsl" href="/style/manual.en.xsl"?>
817b1bcafff27cc67630dd0cbd36df708c05fcccStephen Gallagher<modulesynopsis>
817b1bcafff27cc67630dd0cbd36df708c05fcccStephen Gallagher
817b1bcafff27cc67630dd0cbd36df708c05fcccStephen Gallagher<name>mod_info</name>
817b1bcafff27cc67630dd0cbd36df708c05fcccStephen Gallagher<description>Provides a comprehensive overview of the server
817b1bcafff27cc67630dd0cbd36df708c05fcccStephen Gallagherconfiguration</description>
817b1bcafff27cc67630dd0cbd36df708c05fcccStephen Gallagher<status>Extension</status>
817b1bcafff27cc67630dd0cbd36df708c05fcccStephen Gallagher<sourcefile>mod_info.c</sourcefile>
817b1bcafff27cc67630dd0cbd36df708c05fcccStephen Gallagher<identifier>info_module</identifier>
817b1bcafff27cc67630dd0cbd36df708c05fcccStephen Gallagher
817b1bcafff27cc67630dd0cbd36df708c05fcccStephen Gallagher
817b1bcafff27cc67630dd0cbd36df708c05fcccStephen Gallagher<summary>
817b1bcafff27cc67630dd0cbd36df708c05fcccStephen Gallagher
817b1bcafff27cc67630dd0cbd36df708c05fcccStephen Gallagher <p>To configure <module>mod_info</module>, add the following to your
817b1bcafff27cc67630dd0cbd36df708c05fcccStephen Gallagher <code>httpd.conf</code> file.</p>
817b1bcafff27cc67630dd0cbd36df708c05fcccStephen Gallagher
817b1bcafff27cc67630dd0cbd36df708c05fcccStephen Gallagher<example>
817b1bcafff27cc67630dd0cbd36df708c05fcccStephen Gallagher&lt;Location /server-info&gt;<br />
817b1bcafff27cc67630dd0cbd36df708c05fcccStephen GallagherSetHandler server-info<br />
817b1bcafff27cc67630dd0cbd36df708c05fcccStephen Gallagher&lt;/Location&gt;<br />
817b1bcafff27cc67630dd0cbd36df708c05fcccStephen Gallagher</example>
817b1bcafff27cc67630dd0cbd36df708c05fcccStephen Gallagher
817b1bcafff27cc67630dd0cbd36df708c05fcccStephen Gallagher <p>You may wish to add a
817b1bcafff27cc67630dd0cbd36df708c05fcccStephen Gallagher <directive module="core">&lt;Limit&gt;</directive>
9a7b6d3248c5aac460e164f2246b26131cfbc055Simo Sorce clause inside the
7d056853e4a5fe6daa5743e38d21b4493f4fca27Jakub Hrozek <directive module="core">&lt;location&gt;</directive>
7d056853e4a5fe6daa5743e38d21b4493f4fca27Jakub Hrozek directive to limit access to your server configuration
817b1bcafff27cc67630dd0cbd36df708c05fcccStephen Gallagher information.</p>
817b1bcafff27cc67630dd0cbd36df708c05fcccStephen Gallagher
817b1bcafff27cc67630dd0cbd36df708c05fcccStephen Gallagher <p>Once configured, the server information is obtained by
817b1bcafff27cc67630dd0cbd36df708c05fcccStephen Gallagher accessing <code>http://your.host.dom/server-info</code></p>
817b1bcafff27cc67630dd0cbd36df708c05fcccStephen Gallagher
817b1bcafff27cc67630dd0cbd36df708c05fcccStephen Gallagher <note>
817b1bcafff27cc67630dd0cbd36df708c05fcccStephen Gallagher Note that the configuration files are read by the
817b1bcafff27cc67630dd0cbd36df708c05fcccStephen Gallagher module at run-time, and therefore the display may
817b1bcafff27cc67630dd0cbd36df708c05fcccStephen Gallagher <em>not</em> reflect the running server's active
817b1bcafff27cc67630dd0cbd36df708c05fcccStephen Gallagher configuration if the files have been changed since the server
9a7b6d3248c5aac460e164f2246b26131cfbc055Simo Sorce was last reloaded. Also, the configuration files must be
817b1bcafff27cc67630dd0cbd36df708c05fcccStephen Gallagher readable by the user as which the server is running (see the
7d056853e4a5fe6daa5743e38d21b4493f4fca27Jakub Hrozek <directive module="mpm_common">User</directive> directive), or
9a7b6d3248c5aac460e164f2246b26131cfbc055Simo Sorce else the directive settings will not be listed.
817b1bcafff27cc67630dd0cbd36df708c05fcccStephen Gallagher
817b1bcafff27cc67630dd0cbd36df708c05fcccStephen Gallagher <p>It should also be noted that if
817b1bcafff27cc67630dd0cbd36df708c05fcccStephen Gallagher <module>mod_info</module> is compiled into the server, its
817b1bcafff27cc67630dd0cbd36df708c05fcccStephen Gallagher handler capability is available in <em>all</em> configuration
817b1bcafff27cc67630dd0cbd36df708c05fcccStephen Gallagher files, including <em>per</em>-directory files (<em>e.g.</em>,
817b1bcafff27cc67630dd0cbd36df708c05fcccStephen Gallagher <code>.htaccess</code>). This may have security-related
7d056853e4a5fe6daa5743e38d21b4493f4fca27Jakub Hrozek ramifications for your site.</p>
817b1bcafff27cc67630dd0cbd36df708c05fcccStephen Gallagher
817b1bcafff27cc67630dd0cbd36df708c05fcccStephen Gallagher <p>In particular, this module can leak sensitive information
817b1bcafff27cc67630dd0cbd36df708c05fcccStephen Gallagher from the configuration directives of other Apache modules such as
817b1bcafff27cc67630dd0cbd36df708c05fcccStephen Gallagher system paths, usernames/passwords, database names, etc. Due to
3a59cbd0b7b9c5dd3c62ac1679876070c264d80fMichal Zidek the way this module works there is no way to block information
3a59cbd0b7b9c5dd3c62ac1679876070c264d80fMichal Zidek from it. Therefore, this module should ONLY be used in a controlled
3a59cbd0b7b9c5dd3c62ac1679876070c264d80fMichal Zidek environment and always with caution.</p>
3a59cbd0b7b9c5dd3c62ac1679876070c264d80fMichal Zidek
3a59cbd0b7b9c5dd3c62ac1679876070c264d80fMichal Zidek </note>
3a59cbd0b7b9c5dd3c62ac1679876070c264d80fMichal Zidek</summary>
3a59cbd0b7b9c5dd3c62ac1679876070c264d80fMichal Zidek
3a59cbd0b7b9c5dd3c62ac1679876070c264d80fMichal Zidek<directivesynopsis>
3a59cbd0b7b9c5dd3c62ac1679876070c264d80fMichal Zidek<name>AddModuleInfo</name>
3a59cbd0b7b9c5dd3c62ac1679876070c264d80fMichal Zidek<description>Allows additional information to be added to the module
3a59cbd0b7b9c5dd3c62ac1679876070c264d80fMichal Zidekinformation displayed by the server-info handler</description>
3a59cbd0b7b9c5dd3c62ac1679876070c264d80fMichal Zidek<syntax>AddModuleInfo <em>module-name string</em></syntax>
3a59cbd0b7b9c5dd3c62ac1679876070c264d80fMichal Zidek<contextlist><context>server config</context> <context>virtual
3a59cbd0b7b9c5dd3c62ac1679876070c264d80fMichal Zidekhost</context></contextlist>
3a59cbd0b7b9c5dd3c62ac1679876070c264d80fMichal Zidek<compatibility>Apache 1.3 and above</compatibility>
7d056853e4a5fe6daa5743e38d21b4493f4fca27Jakub Hrozek
3a59cbd0b7b9c5dd3c62ac1679876070c264d80fMichal Zidek<usage>
3a59cbd0b7b9c5dd3c62ac1679876070c264d80fMichal Zidek <p>This allows the content of <em>string</em> to be shown as
3a59cbd0b7b9c5dd3c62ac1679876070c264d80fMichal Zidek HTML interpreted, <strong>Additional Information</strong> for
3a59cbd0b7b9c5dd3c62ac1679876070c264d80fMichal Zidek the module <em>module-name</em>. Example:</p>
3a59cbd0b7b9c5dd3c62ac1679876070c264d80fMichal Zidek
3a59cbd0b7b9c5dd3c62ac1679876070c264d80fMichal Zidek<example>
3a59cbd0b7b9c5dd3c62ac1679876070c264d80fMichal ZidekAddModuleInfo 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;'
3a59cbd0b7b9c5dd3c62ac1679876070c264d80fMichal Zidek</example>
3a59cbd0b7b9c5dd3c62ac1679876070c264d80fMichal Zidek</usage>
3a59cbd0b7b9c5dd3c62ac1679876070c264d80fMichal Zidek
3a59cbd0b7b9c5dd3c62ac1679876070c264d80fMichal Zidek</directivesynopsis>
3a59cbd0b7b9c5dd3c62ac1679876070c264d80fMichal Zidek</modulesynopsis>
7d056853e4a5fe6daa5743e38d21b4493f4fca27Jakub Hrozek
3a59cbd0b7b9c5dd3c62ac1679876070c264d80fMichal Zidek