home *** CD-ROM | disk | FTP | other *** search
/ PC World 2003 May / PCWorld_2003-05_cd.bin / Komunik / apache / apache_2.0.45-win32-x86-no_ssl.msi / Data.Cab / F232729_htaccess.html.en < prev    next >
Extensible Markup Language  |  2003-03-30  |  20KB  |  345 lines

  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>Apache Tutorial: .htaccess files - 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 id="manual-page"><div id="page-header">
  14. <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>
  15. <p class="apache">Apache HTTP Server Version 2.0</p>
  16. <img alt="" src="../images/feather.gif" /></div>
  17. <div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div>
  18. <div id="path">
  19. <a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs-project/">Documentation</a> > <a href="../">Version 2.0</a> > <a href="./">How-To / Tutorials</a></div><div id="page-content"><div id="preamble"><h1>Apache Tutorial: .htaccess files</h1>
  20. <p><code>.htaccess</code> files provide a way to make configuration
  21. changes on a per-directory basis.</p>
  22. </div>
  23. <div id="quickview"><ul id="toc"><li><img alt="" src="../images/down.gif" /> <a href="#related">.htaccess files</a></li>
  24. <li><img alt="" src="../images/down.gif" /> <a href="#what">What they are/How to use them</a></li>
  25. <li><img alt="" src="../images/down.gif" /> <a href="#when">When (not) to use .htaccess files</a></li>
  26. <li><img alt="" src="../images/down.gif" /> <a href="#how">How directives are applied</a></li>
  27. <li><img alt="" src="../images/down.gif" /> <a href="#auth">Authentication example</a></li>
  28. <li><img alt="" src="../images/down.gif" /> <a href="#ssi">Server Side Includes example</a></li>
  29. <li><img alt="" src="../images/down.gif" /> <a href="#cgi">CGI example</a></li>
  30. <li><img alt="" src="../images/down.gif" /> <a href="#troubleshoot">Troubleshooting</a></li>
  31. </ul></div>
  32. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  33. <div class="section">
  34. <h2><a name="related" id="related">.htaccess files</a></h2>
  35.     <table class="related"><tr><th>Related Modules</th><th>Related Directives</th></tr><tr><td><ul><li><code class="module"><a href="../mod/core.html">core</a></code></li><li><code class="module"><a href="../mod/mod_auth.html">mod_auth</a></code></li><li><code class="module"><a href="../mod/mod_cgi.html">mod_cgi</a></code></li><li><code class="module"><a href="../mod/mod_include.html">mod_include</a></code></li><li><code class="module"><a href="../mod/mod_mime.html">mod_mime</a></code></li></ul></td><td><ul><li><code class="directive"><a href="../mod/core.html#accessfilename">AccessFileName</a></code></li><li><code class="directive"><a href="../mod/core.html#allowoverride">AllowOverride</a></code></li><li><code class="directive"><a href="../mod/core.html#options">Options</a></code></li><li><code class="directive"><a href="../mod/mod_mime.html#addhandler">AddHandler</a></code></li><li><code class="directive"><a href="../mod/core.html#sethandler">SetHandler</a></code></li><li><code class="directive"><a href="../mod/core.html#authtype">AuthType</a></code></li><li><code class="directive"><a href="../mod/core.html#authname">AuthName</a></code></li><li><code class="directive"><a href="../mod/mod_auth.html#authuserfile">AuthUserFile</a></code></li><li><code class="directive"><a href="../mod/mod_auth.html#authgroupfile">AuthGroupFile</a></code></li><li><code class="directive"><a href="../mod/core.html#require">Require</a></code></li></ul></td></tr></table>
  36. </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  37. <div class="section">
  38. <h2><a name="what" id="what">What they are/How to use them</a></h2>
  39.  
  40.  
  41.     <p><code>.htaccess</code> files (or "distributed configuration files")
  42.     provide a way to make configuration changes on a per-directory basis. A
  43.     file, containing one or more configuration directives, is placed in a
  44.     particular document directory, and the directives apply to that
  45.     directory, and all subdirectories thereof.</p>
  46.  
  47.     <div class="note"><h3>Note:</h3>
  48.       <p>If you want to call your <code>.htaccess</code> file something
  49.       else, you can change the name of the file using the <code class="directive"><a href="../mod/core.html#accessfilename">AccessFileName</a></code> directive. For example,
  50.       if you would rather call the file <code>.config</code> then you
  51.       can put the following in your server configuration file:</p>
  52.  
  53.       <div class="example"><p><code>
  54.         AccessFileName .config
  55.       </code></p></div>
  56.     </div>
  57.  
  58.     <p>What you can put in these files is determined by the <code class="directive"><a href="../mod/core.html#allowoverride">AllowOverride</a></code>
  59.     directive. This directive specifies, in categories, what directives
  60.     will be honored if they are found in a <code>.htaccess</code> file. If
  61.     a directive is permitted in a <code>.htaccess</code> file, the
  62.     documentation for that directive will contain an Override section,
  63.     specifying what value must be in <code class="directive"><a href="../mod/core.html#allowoverride">AllowOverride</a></code> in order
  64.     for that directive to be permitted.</p>
  65.  
  66.     <p>For example, if you look at the documentation for the <code class="directive"><a href="../mod/core.html#adddefaultcharset">AddDefaultCharset</a></code>
  67.     directive, you will find that it is permitted in <code>.htaccess</code>
  68.     files. (See the Context line in the directive summary.) The <a href="../mod/directive-dict.html#Context">Override</a> line reads
  69.     <code>FileInfo</code>. Thus, you must have at least
  70.     <code>AllowOverride FileInfo</code> in order for this directive to be
  71.     honored in <code>.htaccess</code> files.</p>
  72.  
  73.     <div class="example"><h3>Example:</h3><table>
  74.         <tr>
  75.           <td><a href="../mod/directive-dict.html#Context">Context:</a></td>
  76.           <td>server config, virtual host, directory, .htaccess</td>
  77.         </tr>
  78.  
  79.         <tr>
  80.           <td><a href="../mod/directive-dict.html#Override">Override:</a></td>
  81.           <td>FileInfo</td>
  82.         </tr>
  83.       </table></div>
  84.  
  85.     <p>If you are unsure whether a particular directive is permitted in a
  86.     <code>.htaccess</code> file, look at the documentation for that
  87.     directive, and check the Context line for ".htaccess".</p>
  88.     </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  89. <div class="section">
  90. <h2><a name="when" id="when">When (not) to use .htaccess files</a></h2>
  91.  
  92.     <p>In general, you should never use <code>.htaccess</code> files unless
  93.     you don't have access to the main server configuration file. There is,
  94.     for example, a prevailing misconception that user authentication should
  95.     always be done in <code>.htaccess</code> files. This is simply not the
  96.     case. You can put user authentication configurations in the main server
  97.     configuration, and this is, in fact, the preferred way to do
  98.     things.</p>
  99.  
  100.     <p><code>.htaccess</code> files should be used in a case where the
  101.     content providers need to make configuration changes to the server on a
  102.     per-directory basis, but do not have root access on the server system.
  103.     In the event that the server administrator is not willing to make
  104.     frequent configuration changes, it might be desirable to permit
  105.     individual users to make these changes in <code>.htaccess</code> files
  106.     for themselves. This is particularly true, for example, in cases where
  107.     ISPs are hosting multiple user sites on a single machine, and want
  108.     their users to be able to alter their configuration.</p>
  109.  
  110.     <p>However, in general, use of <code>.htaccess</code> files should be
  111.     avoided when possible. Any configuration that you would consider
  112.     putting in a <code>.htaccess</code> file, can just as effectively be
  113.     made in a <code class="directive"><a href="../mod/core.html#directory"><Directory></a></code> section in your main server 
  114.     configuration file.</p>
  115.  
  116.     <p>There are two main reasons to avoid the use of
  117.     <code>.htaccess</code> files.</p>
  118.  
  119.     <p>The first of these is performance. When <code class="directive"><a href="../mod/core.html#allowoverride">AllowOverride</a></code>
  120.     is set to allow the use of <code>.htaccess</code> files, Apache will
  121.     look in every directory for <code>.htaccess</code> files. Thus,
  122.     permitting <code>.htaccess</code> files causes a performance hit,
  123.     whether or not you actually even use them! Also, the
  124.     <code>.htaccess</code> file is loaded every time a document is
  125.     requested.</p>
  126.  
  127.     <p>Further note that Apache must look for <code>.htaccess</code> files
  128.     in all higher-level directories, in order to have a full complement of
  129.     directives that it must apply. (See section on <a href="#how">how
  130.     directives are applied</a>.) Thus, if a file is requested out of a
  131.     directory <code>/www/htdocs/example</code>, Apache must look for the
  132.     following files:</p>
  133.  
  134.    <div class="example"><p><code>
  135.       /.htaccess<br />
  136.       /www/.htaccess<br />
  137.       /www/htdocs/.htaccess<br />
  138.       /www/htdocs/example/.htaccess
  139.    </code></p></div>
  140.  
  141.     <p>And so, for each file access out of that directory, there are 4
  142.     additional file-system accesses, even if none of those files are
  143.     present. (Note that this would only be the case if
  144.     <code>.htaccess</code> files were enabled for <code>/</code>, which
  145.     is not usually the case.)</p>
  146.  
  147.     <p>The second consideration is one of security. You are permitting
  148.     users to modify server configuration, which may result in changes over
  149.     which you have no control. Carefully consider whether you want to give
  150.     your users this privilege. Note also that giving users less
  151.     privileges than they need will lead to additional technical support
  152.     requests. Make sure you clearly tell your users what level of
  153.     privileges you have given them. Specifying exactly what you have set
  154.     <code class="directive"><a href="../mod/core.html#allowoverride">AllowOverride</a></code> to, and pointing them
  155.     to the relevant documentation, will save yourself a lot of confusion
  156.     later.</p>
  157.  
  158.     <p>Note that it is completely equivalent to put a <code>.htaccess</code>
  159.     file in a directory <code>/www/htdocs/example</code> containing a
  160.     directive, and to put that same directive in a Directory section
  161.     <code><Directory /www/htdocs/example></code> in your main server
  162.     configuration:</p>
  163.  
  164.     <p><code>.htaccess</code> file in <code>/www/htdocs/example</code>:</p>
  165.  
  166.     <div class="example"><h3>Contents of .htaccess file in
  167.     <code>/www/htdocs/example</code></h3><p><code>
  168.         AddType text/example .exm
  169.     </code></p></div>
  170.  
  171.     <div class="example"><h3>Section from your <code>httpd.conf</code>
  172.     file</h3><p><code>
  173.       <Directory /www/htdocs/example><br />
  174.       <span class="indent">
  175.         AddType text/example .exm<br />
  176.       </span>
  177.       </Directory>
  178.     </code></p></div>
  179.  
  180.     <p>However, putting this configuration in your server configuration
  181.     file will result in less of a performance hit, as the configuration is
  182.     loaded once when Apache starts, rather than every time a file is
  183.     requested.</p>
  184.  
  185.     <p>The use of <code>.htaccess</code> files can be disabled completely
  186.     by setting the <code class="directive"><a href="../mod/core.html#allowoverride">AllowOverride</a></code>
  187.     directive to <code>none</code>:</p>
  188.  
  189.     <div class="example"><p><code>
  190.       AllowOverride None
  191.     </code></p></div>
  192. </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  193. <div class="section">
  194. <h2><a name="how" id="how">How directives are applied</a></h2>
  195.  
  196.     <p>The configuration directives found in a <code>.htaccess</code> file
  197.     are applied to the directory in which the <code>.htaccess</code> file
  198.     is found, and to all subdirectories thereof. However, it is important
  199.     to also remember that there may have been <code>.htaccess</code> files
  200.     in directories higher up. Directives are applied in the order that they
  201.     are found. Therefore, a <code>.htaccess</code> file in a particular
  202.     directory may override directives found in <code>.htaccess</code> files
  203.     found higher up in the directory tree. And those, in turn, may have
  204.     overridden directives found yet higher up, or in the main server
  205.     configuration file itself.</p>
  206.  
  207.     <p>Example:</p>
  208.  
  209.     <p>In the directory <code>/www/htdocs/example1</code> we have a
  210.     <code>.htaccess</code> file containing the following:</p>
  211.  
  212.     <div class="example"><p><code>
  213.        Options +ExecCGI
  214.     </code></p></div>
  215.  
  216.     <p>(Note: you must have "<code>AllowOverride Options</code>" in effect
  217.     to permit the use of the "<code class="directive"><a href="../mod/core.html#options">Options</a></code>" directive in
  218.     <code>.htaccess</code> files.)</p>
  219.  
  220.     <p>In the directory <code>/www/htdocs/example1/example2</code> we have
  221.     a <code>.htaccess</code> file containing:</p>
  222.  
  223.     <div class="example"><p><code>
  224.        Options Includes
  225.     </code></p></div>
  226.  
  227.     <p>Because of this second <code>.htaccess</code> file, in the directory
  228.     <code>/www/htdocs/example1/example2</code>, CGI execution is not
  229.     permitted, as only <code>Options Includes</code> is in effect, which
  230.     completely overrides any earlier setting that may have been in
  231.     place.</p>
  232. </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  233. <div class="section">
  234. <h2><a name="auth" id="auth">Authentication example</a></h2>
  235.  
  236.     <p>If you jumped directly to this part of the document to find out how
  237.     to do authentication, it is important to note one thing. There is a
  238.     common misconception that you are required to use
  239.     <code>.htaccess</code> files in order to implement password
  240.     authentication. This is not the case. Putting authentication directives
  241.     in a <code class="directive"><a href="../mod/core.html#directory"><Directory></a></code>
  242.     section, in your main server configuration file, is the preferred way
  243.     to implement this, and <code>.htaccess</code> files should be used only
  244.     if you don't have access to the main server configuration file. See <a href="#when">above</a> for a discussion of when you should and should
  245.     not use <code>.htaccess</code> files.</p>
  246.  
  247.     <p>Having said that, if you still think you need to use a
  248.     <code>.htaccess</code> file, you may find that a configuration such as
  249.     what follows may work for you.</p>
  250.  
  251.     <p>You must have "<code>AllowOverride AuthConfig</code>" in effect for
  252.     these directives to be honored.</p>
  253.  
  254.     <p><code>.htaccess</code> file contents:</p>
  255.  
  256.     <div class="example"><p><code>
  257.           AuthType Basic<br />
  258.            AuthName "Password Required"<br />
  259.            AuthUserFile /www/passwords/password.file<br />
  260.            AuthGroupFile /www/passwords/group.file<br />
  261.            Require Group admins
  262.     </code></p></div>
  263.  
  264.     <p>Note that <code>AllowOverride AuthConfig</code> must be in effect
  265.     for these directives to have any effect.</p>
  266.  
  267.     <p>Please see the <a href="auth.html">authentication tutorial</a> for a
  268.     more complete discussion of authentication and authorization.</p>
  269. </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  270. <div class="section">
  271. <h2><a name="ssi" id="ssi">Server Side Includes example</a></h2>
  272.  
  273.     <p>Another common use of <code>.htaccess</code> files is to enable
  274.     Server Side Includes for a particular directory. This may be done with
  275.     the following configuration directives, placed in a
  276.     <code>.htaccess</code> file in the desired directory:</p>
  277.  
  278.     <div class="example"><p><code>
  279.        Options +Includes<br />
  280.        AddType text/html shtml<br />
  281.        AddHandler server-parsed shtml
  282.     </code></p></div>
  283.  
  284.     <p>Note that <code>AllowOverride Options</code> and <code>AllowOverride
  285.     FileInfo</code> must both be in effect for these directives to have any
  286.     effect.</p>
  287.  
  288.     <p>Please see the <a href="ssi.html">SSI tutorial</a> for a more
  289.     complete discussion of server-side includes.</p>
  290. </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  291. <div class="section">
  292. <h2><a name="cgi" id="cgi">CGI example</a></h2>
  293.  
  294.     <p>Finally, you may wish to use a <code>.htaccess</code> file to permit
  295.     the execution of CGI programs in a particular directory. This may be
  296.     implemented with the following configuration:</p>
  297.  
  298.     <div class="example"><p><code>
  299.        Options +ExecCGI<br />
  300.        AddHandler cgi-script cgi pl
  301.     </code></p></div>
  302.  
  303.     <p>Alternately, if you wish to have all files in the given directory be
  304.     considered to be CGI programs, this may be done with the following
  305.     configuration:</p>
  306.  
  307.     <div class="example"><p><code>
  308.        Options +ExecCGI<br />
  309.        SetHandler cgi-script
  310.     </code></p></div>
  311.  
  312.     <p>Note that <code>AllowOverride Options</code> and <code>AllowOverride
  313.     FileInfo</code> must both be in effect for these directives to have any
  314.     effect.</p>
  315.  
  316.     <p>Please see the <a href="cgi.html">CGI tutorial</a> for a more
  317.     complete discussion of CGI programming and configuration.</p>
  318.  
  319. </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  320. <div class="section">
  321. <h2><a name="troubleshoot" id="troubleshoot">Troubleshooting</a></h2>
  322.  
  323.     <p>When you put configuration directives in a <code>.htaccess</code>
  324.     file, and you don't get the desired effect, there are a number of
  325.     things that may be going wrong.</p>
  326.  
  327.     <p>Most commonly, the problem is that <code class="directive"><a href="../mod/core.html#allowoverride">AllowOverride</a></code> is not
  328.     set such that your configuration directives are being honored. Make
  329.     sure that you don't have a <code>AllowOverride None</code> in effect
  330.     for the file scope in question. A good test for this is to put garbage
  331.     in your <code>.htaccess</code> file and reload. If a server error is
  332.     not generated, then you almost certainly have <code>AllowOverride
  333.     None</code> in effect.</p>
  334.  
  335.     <p>If, on the other hand, you are getting server errors when trying to
  336.     access documents, check your Apache error log. It will likely tell you
  337.     that the directive used in your <code>.htaccess</code> file is not
  338.     permitted. Alternately, it may tell you that you had a syntax error,
  339.     which you will then need to fix.</p>
  340.  
  341. </div></div>
  342. <div id="footer">
  343. <p class="apache">Maintained by the <a href="http://httpd.apache.org/docs-project/">Apache HTTP Server Documentation Project</a></p>
  344. <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>
  345. </body></html>