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

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
   4         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   5               This file is generated from xml source: DO NOT EDIT
   6         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   7       -->
   8 <title>mod_info - Apache HTTP Server</title>
   9 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
  10 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
  11 <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
  12 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  13 <body>
  14 <div id="page-header">
  15 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
  16 <p class="apache">Apache HTTP Server Version 2.1</p>
  17 <img alt="" src="../images/feather.gif" /></div>
  18 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  19 <div id="path">
  20 <a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs-project/">Documentation</a> &gt; <a href="../">Version 2.1</a> &gt; <a href="./">Modules</a></div>
  21 <div id="page-content">
  22 <div id="preamble"><h1>Apache Module mod_info</h1>
  23 <div class="toplang">
  24 <p><span>Available Languages: </span><a href="../en/mod/mod_info.html">&nbsp;en&nbsp;</a> | <a href="../ja/mod/mod_info.html">&nbsp;ja&nbsp;</a></p>
  25 </div>
  26 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Provides a comprehensive overview of the server
  27 configuration</td></tr>
  28 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  29 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>info_module</td></tr>
  30 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_info.c</td></tr></table>
  31 <h3>Summary</h3>
  32
  33     <p>To configure <code class="module"><a href="../mod/mod_info.html">mod_info</a></code>, add the following to your
  34     <code>httpd.conf</code> file.</p>
  35
  36     <div class="example"><p><code>
  37       &lt;Location /server-info&gt;<br />
  38       <span class="indent">
  39         SetHandler server-info<br />
  40       </span>
  41       &lt;/Location&gt;
  42     </code></p></div>
  43
  44     <p>You may wish to add a
  45     <code class="directive"><a href="../mod/core.html#limit">&lt;Limit&gt;</a></code>
  46     clause inside the
  47     <code class="directive"><a href="../mod/core.html#location">&lt;Location&gt;</a></code>
  48     directive to limit access to your server configuration
  49     information.</p>
  50
  51     <p>Once configured, the server information is obtained by
  52     accessing <code>http://your.host.dom/server-info</code></p>
  53
  54     <div class="note">
  55       Note that the configuration files are read by the
  56       module at run-time, and therefore the display may
  57       <em>not</em> reflect the running server's active
  58       configuration if the files have been changed since the server
  59       was last reloaded. Also, the configuration files must be
  60       readable by the user as which the server is running (see the
  61       <code class="directive"><a href="../mod/mpm_common.html#user">User</a></code> directive), or
  62       else the directive settings will not be listed.
  63
  64       <p>It should also be noted that if
  65       <code class="module"><a href="../mod/mod_info.html">mod_info</a></code> is compiled into the server, its
  66       handler capability is available in <em>all</em> configuration
  67       files, including per-directory files (<em>e.g.</em>,
  68       <code>.htaccess</code>). This may have security-related
  69       ramifications for your site.</p>
  70
  71       <p>In particular, this module can leak sensitive information
  72       from the configuration directives of other Apache modules such as
  73       system paths, usernames/passwords, database names, etc.  Due to
  74       the way this module works there is no way to block information
  75       from it.  Therefore, this module should <strong>only</strong> be
  76       used in a controlled environment and always with caution.</p>
  77     </div>
  78 </div>
  79 <div id="quickview"><h3 class="directives">Directives</h3>
  80 <ul id="toc">
  81 <li><img alt="" src="../images/down.gif" /> <a href="#addmoduleinfo">AddModuleInfo</a></li>
  82 </ul>
  83 </div>
  84
  85 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  86 <div class="directive-section"><h2><a name="AddModuleInfo" id="AddModuleInfo">AddModuleInfo</a> <a name="addmoduleinfo" id="addmoduleinfo">Directive</a></h2>
  87 <table class="directive">
  88 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Adds additional information to the module
  89 information displayed by the server-info handler</td></tr>
  90 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AddModuleInfo <var>module-name</var> <var>string</var></code></td></tr>
  91 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
  92 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  93 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_info</td></tr>
  94 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Apache 1.3 and above</td></tr>
  95 </table>
  96     <p>This allows the content of <var>string</var> to be shown as
  97     HTML interpreted, <strong>Additional Information</strong> for
  98     the module <var>module-name</var>. Example:</p>
  99
 100     <div class="example"><p><code>
 101       AddModuleInfo mod_deflate.c 'See &lt;a \<br />
 102       <span class="indent">
 103       href="http://www.apache.org/docs-2.1/mod/mod_deflate.html"&gt;\<br />
 104       http://www.apache.org/docs-2.1/mod/mod_deflate.html&lt;/a&gt;'
 105       </span>
 106     </code></p></div>
 107
 108 </div>
 109 </div>
 110 <div class="bottomlang">
 111 <p><span>Available Languages: </span><a href="../en/mod/mod_info.html">&nbsp;en&nbsp;</a> | <a href="../ja/mod/mod_info.html">&nbsp;ja&nbsp;</a></p>
 112 </div><div id="footer">
 113 <p class="apache">Maintained by the <a href="http://httpd.apache.org/docs-project/">Apache HTTP Server Documentation Project</a></p>
 114 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div>
 115 </body></html>