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