| <?xml version="1.0"?> |
| <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd"> |
| <?xml-stylesheet type="text/xsl" href="../style/manual.xsl"?> |
| <modulesynopsis> |
| |
| <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> |
| <Location /server-info><br /> |
| SetHandler server-info<br /> |
| </Location><br /> |
| </example> |
| |
| <p>You may wish to add a |
| <directive module="core"><Limit></directive> |
| clause inside the |
| <directive 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 <em>per</em>-directory files (<em>e.g.</em>, |
| <code>.htaccess</code>). This may have security-related |
| ramifications for your site.</p> |
| </note> |
| </summary> |
| |
| <directivesynopsis> |
| <name>AddModuleInfo</name> |
| <description>Allows additional information to be added to the module |
| information displayed by the server-info handler</description> |
| <syntax>AddModuleInfo <em>module-name string</em></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 <em>string</em> to be shown as |
| HTML interpreted, <strong>Additional Information</strong> for |
| the module <em>module-name</em>. Example:</p> |
| |
| <example> |
| AddModuleInfo mod_auth.c 'See <A HREF="http://www.apache.org/docs/mod/mod_auth.html">http://www.apache.org/docs/mod/mod_auth.html</A>' |
| </example> |
| </usage> |
| |
| </directivesynopsis> |
| </modulesynopsis> |
| |