github.com/krum110487/go-htaccess@v0.0.0-20240316004156-60641c8e7598/tests/data/apache_2_2_34/manual/mod/mod_info.html.en (about)

     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  <meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type" />
     5  <!--
     6          XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
     7                This file is generated from xml source: DO NOT EDIT
     8          XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
     9        -->
    10  <title>mod_info - Apache HTTP Server Version 2.2</title>
    11  <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
    12  <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
    13  <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" /><link rel="stylesheet" type="text/css" href="../style/css/prettify.css" />
    14  <script src="../style/scripts/prettify.min.js" type="text/javascript">
    15  </script>
    16  
    17  <link href="../images/favicon.ico" rel="shortcut icon" /><link href="http://httpd.apache.org/docs/current/mod/mod_info.html" rel="canonical" /></head>
    18  <body>
    19  <div id="page-header">
    20  <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
    21  <p class="apache">Apache HTTP Server Version 2.2</p>
    22  <img alt="" src="../images/feather.gif" /></div>
    23  <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
    24  <div id="path">
    25  <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/">Documentation</a> &gt; <a href="../">Version 2.2</a> &gt; <a href="./">Modules</a></div>
    26  <div id="page-content">
    27  <div class="retired"><h4>Please note</h4>
    28              <p> This document refers to a legacy release (<strong>2.2</strong>) of Apache httpd. The active release (<strong>2.4</strong>) is documented <a href="http://httpd.apache.org/docs/current">here</a>. If you have not already upgraded, please follow <a href="http://httpd.apache.org/docs/current/upgrading.html">this link</a> for more information.</p>
    29          <p>You may follow <a href="http://httpd.apache.org/docs/current/mod/mod_info.html">this link</a> to go to the current version of this document.</p></div><div id="preamble"><h1>Apache Module mod_info</h1>
    30  <div class="toplang">
    31  <p><span>Available Languages: </span><a href="../en/mod/mod_info.html" title="English">&nbsp;en&nbsp;</a> |
    32  <a href="../ja/mod/mod_info.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
    33  <a href="../ko/mod/mod_info.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
    34  </div>
    35  <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Provides a comprehensive overview of the server
    36  configuration</td></tr>
    37  <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
    38  <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>info_module</td></tr>
    39  <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_info.c</td></tr></table>
    40  <h3>Summary</h3>
    41  
    42      <p>To configure <code class="module"><a href="../mod/mod_info.html">mod_info</a></code>, add the following to your
    43      <code>httpd.conf</code> file.</p>
    44  
    45      <div class="example"><p><code>
    46        &lt;Location /server-info&gt;<br />
    47        <span class="indent">
    48          SetHandler server-info<br />
    49        </span>
    50        &lt;/Location&gt;
    51      </code></p></div>
    52  
    53      <p>You may wish to use <code class="module"><a href="../mod/mod_authz_host.html">mod_authz_host</a></code> inside the
    54      <code class="directive"><a href="../mod/core.html#location">&lt;Location&gt;</a></code>
    55      directive to limit access to your server configuration
    56      information:</p>
    57  
    58      <div class="example"><p><code>
    59        &lt;Location /server-info&gt;<br />
    60        <span class="indent">
    61          SetHandler server-info<br />
    62          Order deny,allow<br />
    63          Deny from all<br />
    64          Allow from yourcompany.com<br />
    65        </span>
    66        &lt;/Location&gt;
    67      </code></p></div>
    68  
    69      <p>Once configured, the server information is obtained by
    70      accessing <code>http://your.host.example.com/server-info</code></p>
    71  </div>
    72  <div id="quickview"><h3>Topics</h3>
    73  <ul id="topics">
    74  <li><img alt="" src="../images/down.gif" /> <a href="#security">Security Issues</a></li>
    75  <li><img alt="" src="../images/down.gif" /> <a href="#queries">Selecting the information shown</a></li>
    76  <li><img alt="" src="../images/down.gif" /> <a href="#limitations">Known Limitations</a></li>
    77  </ul><h3 class="directives">Directives</h3>
    78  <ul id="toc">
    79  <li><img alt="" src="../images/down.gif" /> <a href="#addmoduleinfo">AddModuleInfo</a></li>
    80  </ul>
    81  <ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
    82  <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
    83  <div class="section">
    84  <h2><a name="security" id="security">Security Issues</a></h2>
    85      <p>Once <code class="module"><a href="../mod/mod_info.html">mod_info</a></code> is loaded into the server, its
    86      handler capability is available in <em>all</em> configuration
    87      files, including per-directory files (<em>e.g.</em>,
    88      <code>.htaccess</code>). This may have security-related
    89      ramifications for your site.</p>
    90  
    91      <p>In particular, this module can leak sensitive information
    92      from the configuration directives of other Apache modules such as
    93      system paths, usernames/passwords, database names, etc. Therefore,
    94      this module should <strong>only</strong> be
    95      used in a controlled environment and always with caution.</p>
    96  
    97      <p>You will probably want to use <code class="module"><a href="../mod/mod_authz_host.html">mod_authz_host</a></code> 
    98      to limit access to your server configuration information.</p>
    99        
   100      <div class="example"><h3>Access control</h3><p><code>
   101        &lt;Location /server-info&gt;<br />
   102        <span class="indent">
   103          SetHandler server-info<br />
   104          Order allow,deny<br />
   105          # Allow access from server itself<br />
   106          Allow from 127.0.0.1<br />
   107          # Additionally, allow access from local workstation<br />
   108          Allow from 192.168.1.17<br />
   109        </span>
   110        &lt;/Location&gt;
   111      </code></p></div>
   112  </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
   113  <div class="section">
   114  <h2><a name="queries" id="queries">Selecting the information shown</a></h2>
   115      <p>By default, the server information includes a list of
   116      all enabled modules, and for each module, a description of
   117      the directives understood by that module, the hooks implemented
   118      by that module, and the relevant directives from the current
   119      configuration.</p>
   120      
   121      <p>Other views of the configuration information are available by
   122      appending a query to the <code>server-info</code> request. For
   123      example, <code>http://your.host.example.com/server-info?config</code>
   124      will show all configuration directives.</p>
   125      
   126      <dl>
   127          <dt><code>?&lt;module-name&gt;</code></dt>
   128              <dd>Only information relevant to the named module</dd>
   129          <dt><code>?config</code></dt>
   130              <dd>Just the configuration directives, not sorted by module</dd>
   131          <dt><code>?hooks</code></dt>
   132              <dd>Only the list of Hooks each module is attached to</dd>
   133          <dt><code>?list</code></dt>
   134              <dd>Only a simple list of enabled modules</dd>
   135          <dt><code>?server</code></dt>
   136              <dd>Only the basic server information</dd>
   137      </dl>
   138  </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
   139  <div class="section">
   140  <h2><a name="limitations" id="limitations">Known Limitations</a></h2>
   141      <p><code class="module"><a href="../mod/mod_info.html">mod_info</a></code> provides its information by reading the
   142      parsed configuration, rather than reading the original configuration
   143      file. There are a few limitations as a result of the way the parsed
   144      configuration tree is created:</p>
   145      <ul>
   146        <li>Directives which are executed immediately rather than being
   147            stored in the parsed configuration are not listed. These include
   148            <code class="directive"><a href="../mod/core.html#serverroot">ServerRoot</a></code>,
   149            <code class="directive"><a href="../mod/mod_so.html#loadmodule">LoadModule</a></code>, and
   150            <code class="directive"><a href="../mod/mod_so.html#loadfile">LoadFile</a></code>.</li>
   151        <li>Directives which control the configuration file itself, such as
   152            <code class="directive"><a href="../mod/core.html#include">Include</a></code>,
   153            <code class="directive"><a href="../mod/core.html#ifmodule">&lt;IfModule&gt;</a></code> and
   154            <code class="directive"><a href="../mod/core.html#ifdefine">&lt;IfDefine&gt;</a></code> are not
   155            listed, but the included configuration directives are.</li>
   156        <li>Comments are not listed. (This may be considered a feature.)</li>
   157        <li>Configuration directives from <code>.htaccess</code> files are
   158            not listed (since they do not form part of the permanent server
   159            configuration).</li>
   160        <li>Container directives such as <code class="directive"><a href="../mod/core.html#directory">&lt;Directory&gt;</a></code> are listed normally, but
   161        <code class="module"><a href="../mod/mod_info.html">mod_info</a></code> cannot figure out the line number for the
   162        closing <code class="directive"><a href="../mod/core.html#directory">&lt;/Directory&gt;</a></code>.</li>
   163        <li>Directives generated by third party modules such as
   164            <a href="http://perl.apache.org">mod_perl</a>
   165            might not be listed.</li>
   166      </ul>
   167  </div>
   168  <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
   169  <div class="directive-section"><h2><a name="AddModuleInfo" id="AddModuleInfo">AddModuleInfo</a> <a name="addmoduleinfo" id="addmoduleinfo">Directive</a></h2>
   170  <table class="directive">
   171  <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Adds additional information to the module
   172  information displayed by the server-info handler</td></tr>
   173  <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AddModuleInfo <var>module-name</var> <var>string</var></code></td></tr>
   174  <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
   175  <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
   176  <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_info</td></tr>
   177  <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Apache 1.3 and above</td></tr>
   178  </table>
   179      <p>This allows the content of <var>string</var> to be shown as
   180      HTML interpreted, <strong>Additional Information</strong> for
   181      the module <var>module-name</var>. Example:</p>
   182  
   183      <div class="example"><p><code>
   184        AddModuleInfo mod_deflate.c 'See &lt;a \<br />
   185        <span class="indent">
   186          href="http://www.apache.org/docs/2.2/mod/mod_deflate.html"&gt;\<br />
   187          http://www.apache.org/docs/2.2/mod/mod_deflate.html&lt;/a&gt;'
   188        </span>
   189      </code></p></div>
   190  
   191  </div>
   192  </div>
   193  <div class="bottomlang">
   194  <p><span>Available Languages: </span><a href="../en/mod/mod_info.html" title="English">&nbsp;en&nbsp;</a> |
   195  <a href="../ja/mod/mod_info.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
   196  <a href="../ko/mod/mod_info.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
   197  </div><div class="top"><a href="#page-header"><img src="../images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">Comments</a></h2><div class="warning"><strong>Notice:</strong><br />This is not a Q&amp;A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed again by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Freenode, or sent to our <a href="http://httpd.apache.org/lists.html">mailing lists</a>.</div>
   198  <script type="text/javascript"><!--//--><![CDATA[//><!--
   199  var comments_shortname = 'httpd';
   200  var comments_identifier = 'http://httpd.apache.org/docs/2.2/mod/mod_info.html';
   201  (function(w, d) {
   202      if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
   203          d.write('<div id="comments_thread"><\/div>');
   204          var s = d.createElement('script');
   205          s.type = 'text/javascript';
   206          s.async = true;
   207          s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
   208          (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
   209      }
   210      else { 
   211          d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
   212      }
   213  })(window, document);
   214  //--><!]]></script></div><div id="footer">
   215  <p class="apache">Copyright 2017 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
   216  <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!--
   217  if (typeof(prettyPrint) !== 'undefined') {
   218      prettyPrint();
   219  }
   220  //--><!]]></script>
   221  </body></html>