home *** CD-ROM | disk | FTP | other *** search
/ Chip 2004 November / CMCD1104.ISO / Software / Complet / Apache / apache_2.0.52-win32-x86-no_ssl.msi / Data.Cab / F278314_mod_info.xml < prev    next >
Extensible Markup Language  |  2004-04-17  |  4KB  |  105 lines
  1. <?xml version="1.0"?>
  2. <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
  3. <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
  4. <!-- $Revision: 1.10.2.5 $ -->
  5.  
  6. <!--
  7.  Copyright 2002-2004 The Apache Software Foundation
  8.  
  9.  Licensed under the Apache License, Version 2.0 (the "License");
  10.  you may not use this file except in compliance with the License.
  11.  You may obtain a copy of the License at
  12.  
  13.      http://www.apache.org/licenses/LICENSE-2.0
  14.  
  15.  Unless required by applicable law or agreed to in writing, software
  16.  distributed under the License is distributed on an "AS IS" BASIS,
  17.  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18.  See the License for the specific language governing permissions and
  19.  limitations under the License.
  20. -->
  21.  
  22. <modulesynopsis metafile="mod_info.xml.meta">
  23.  
  24. <name>mod_info</name>
  25. <description>Provides a comprehensive overview of the server
  26. configuration</description>
  27. <status>Extension</status>
  28. <sourcefile>mod_info.c</sourcefile>
  29. <identifier>info_module</identifier>
  30.  
  31. <summary>
  32.     <p>To configure <module>mod_info</module>, add the following to your
  33.     <code>httpd.conf</code> file.</p>
  34.  
  35.     <example>
  36.       <Location /server-info><br />
  37.       <indent>
  38.         SetHandler server-info<br />
  39.       </indent>
  40.       </Location>
  41.     </example>
  42.  
  43.     <p>You may wish to add a 
  44.     <directive type="section" module="core">Limit</directive> 
  45.     clause inside the 
  46.     <directive type="section" module="core">Location</directive>
  47.     directive to limit access to your server configuration 
  48.     information.</p>
  49.  
  50.     <p>Once configured, the server information is obtained by
  51.     accessing <code>http://your.host.dom/server-info</code></p>
  52.  
  53.     <note>
  54.       Note that the configuration files are read by the
  55.       module at run-time, and therefore the display may
  56.       <em>not</em> reflect the running server's active
  57.       configuration if the files have been changed since the server
  58.       was last reloaded. Also, the configuration files must be
  59.       readable by the user as which the server is running (see the
  60.       <directive module="mpm_common">User</directive> directive), or
  61.       else the directive settings will not be listed.
  62.  
  63.       <p>It should also be noted that if
  64.       <module>mod_info</module> is compiled into the server, its
  65.       handler capability is available in <em>all</em> configuration
  66.       files, including per-directory files (<em>e.g.</em>,
  67.       <code>.htaccess</code>). This may have security-related
  68.       ramifications for your site.</p>
  69.  
  70.       <p>In particular, this module can leak sensitive information
  71.       from the configuration directives of other Apache modules such as
  72.       system paths, usernames/passwords, database names, etc.  Due to
  73.       the way this module works there is no way to block information
  74.       from it.  Therefore, this module should <strong>only</strong> be
  75.       used in a controlled environment and always with caution.</p>
  76.     </note>
  77. </summary>
  78.  
  79. <directivesynopsis>
  80. <name>AddModuleInfo</name>
  81. <description>Adds additional information to the module
  82. information displayed by the server-info handler</description>
  83. <syntax>AddModuleInfo <var>module-name</var> <var>string</var></syntax>
  84. <contextlist><context>server config</context><context>virtual host</context>
  85. </contextlist>
  86. <compatibility>Apache 1.3 and above</compatibility>
  87.  
  88. <usage>
  89.     <p>This allows the content of <var>string</var> to be shown as
  90.     HTML interpreted, <strong>Additional Information</strong> for
  91.     the module <var>module-name</var>. Example:</p>
  92.  
  93.     <example>
  94.       AddModuleInfo mod_auth.c 'See <a \<br />
  95.       <indent>
  96.         href="http://www.apache.org/docs-2.0/mod/mod_auth.html">\<br />
  97.         http://www.apache.org/docs-2.0/mod/mod_auth.html</a>'
  98.       </indent>
  99.     </example>
  100. </usage>
  101.  
  102. </directivesynopsis>
  103. </modulesynopsis>
  104.  
  105.