granicus.if.org Git - apache/blob - docs/manual/mod/mod_info.html.en

   1 <html xmlns="http://www.w3.org/TR/xhtml1/strict"><head><!--
   2           XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   3                 This file is generated from xml source: DO NOT EDIT
   4           XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   5         --><title>mod_info- Apache HTTP Server</title><link href="../style/manual.css" type="text/css" rel="stylesheet"/></head><body><blockquote><div align="center"><img src="../images/sub.gif" alt="[APACHE DOCUMENTATION]"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mod_info</h1><table cellspacing="1" cellpadding="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td>Provides a comprehensive overview of the server
   6 configuration</td></tr><tr><td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="module-dict.html#ModuleIdentifier" class="help">Module&nbsp;Identifier:</a></td><td>info_module</td></tr></table></td></tr></table><h2>Summary</h2>
   7
   8     <p>To configure <code><a href="mod_info.html">mod_info</a></code>, add the following to your
   9     <code>httpd.conf</code> file.</p>
  10
  11 <blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
  12 &lt;Location /server-info&gt;<br>
  13 SetHandler server-info<br>
  14 &lt;/Location&gt;<br>
  15 </code></td></tr></table></blockquote>
  16
  17     <p>You may wish to add a
  18     <a href="core.html#<limit>" class="directive"><code class="directive">&lt;Limit&gt;</code></a>
  19     clause inside the
  20     <a href="core.html#<location>" class="directive"><code class="directive">&lt;location&gt;</code></a>
  21     directive to limit access to your server configuration
  22     information.</p>
  23
  24     <p>Once configured, the server information is obtained by
  25     accessing <code>http://your.host.dom/server-info</code></p>
  26
  27     <blockquote><table><tr><td bgcolor="#e0e5f5">
  28       Note that the configuration files are read by the
  29       module at run-time, and therefore the display may
  30       <em>not</em> reflect the running server's active
  31       configuration if the files have been changed since the server
  32       was last reloaded. Also, the configuration files must be
  33       readable by the user as which the server is running (see the
  34       <a href="mpm_common.html#user" class="directive"><code class="directive">User</code></a> directive), or
  35       else the directive settings will not be listed.
  36
  37       <p>It should also be noted that if
  38       <code><a href="mod_info.html">mod_info</a></code> is compiled into the server, its
  39       handler capability is available in <em>all</em> configuration
  40       files, including <em>per</em>-directory files (<em>e.g.</em>,
  41       <code>.htaccess</code>). This may have security-related
  42       ramifications for your site.</p>
  43     </td></tr></table></blockquote>
  44 <h2>Directives</h2><ul><li><a href="#addmoduleinfo">AddModuleInfo</a></li></ul><hr/><h2><a name="AddModuleInfo">AddModuleInfo</a> <a name="addmoduleinfo">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Allows additional information to be added to the module
  45 information displayed by the server-info handler</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>AddModuleInfo <em>module-name string</em></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual
  46 host</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_info</td></tr><tr><td align="left" valign="top"><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>Apache 1.3 and above</td></tr></table></td></tr></table>
  47     <p>This allows the content of <em>string</em> to be shown as
  48     HTML interpreted, <strong>Additional Information</strong> for
  49     the module <em>module-name</em>. Example:</p>
  50
  51 <blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
  52 AddModuleInfo 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;'
  53 </code></td></tr></table></blockquote>
  54 <hr/></blockquote><h3 align="center">Apache HTTP Server Version 2.0</h3><a href="./"><img src="../images/index.gif" alt="Index"/></a><a href="../"><img src="../images/home.gif" alt="Home"/></a></body></html>