Apache HTTP Server Tutorial: .htaccess files
.htaccess files provide a way to make configuration changes on a per-directory basis.
- .htaccess files
- What they are/How to use them
- When (not) to use .htaccess files
- How directives are applied
- Authentication example
- Server Side Includes example
- Rewrite Rules in .htaccess files
- CGI example
- Troubleshooting
See also
.htaccess files
- core
- mod_authn_file
- mod_authz_groupfile
- mod_cgi
- mod_include
- mod_mime
- AccessFileName
- AllowOverride
- Options
- AddHandler
- SetHandler
- AuthType
- AuthName
- AuthUserFile
- AuthGroupFile
- Require
What they are/How to use them
.htaccess files (or «distributed configuration files») provide a way to make configuration changes on a per-directory basis. A file, containing one or more configuration directives, is placed in a particular document directory, and the directives apply to that directory, and all subdirectories thereof.
If you want to call your .htaccess file something else, you can change the name of the file using the AccessFileName directive. For example, if you would rather call the file .config then you can put the following in your server configuration file:
In general, .htaccess files use the same syntax as the main configuration files. What you can put in these files is determined by the AllowOverride directive. This directive specifies, in categories, what directives will be honored if they are found in a .htaccess file. If a directive is permitted in a .htaccess file, the documentation for that directive will contain an Override section, specifying what value must be in AllowOverride in order for that directive to be permitted.
For example, if you look at the documentation for the AddDefaultCharset directive, you will find that it is permitted in .htaccess files. (See the Context line in the directive summary.) The Override line reads FileInfo . Thus, you must have at least AllowOverride FileInfo in order for this directive to be honored in .htaccess files.
Example:
| Context: | server config, virtual host, directory, .htaccess |
| Override: | FileInfo |
If you are unsure whether a particular directive is permitted in a .htaccess file, look at the documentation for that directive, and check the Context line for «.htaccess».
When (not) to use .htaccess files
In general, you should only use .htaccess files when you don’t have access to the main server configuration file. There is, for example, a common misconception that user authentication should always be done in .htaccess files, and, in more recent years, another misconception that mod_rewrite directives must go in .htaccess files. This is simply not the case. You can put user authentication configurations in the main server configuration, and this is, in fact, the preferred way to do things. Likewise, mod_rewrite directives work better, in many respects, in the main server configuration.
.htaccess files should be used in a case where the content providers need to make configuration changes to the server on a per-directory basis, but do not have root access on the server system. In the event that the server administrator is not willing to make frequent configuration changes, it might be desirable to permit individual users to make these changes in .htaccess files for themselves. This is particularly true, for example, in cases where ISPs are hosting multiple user sites on a single machine, and want their users to be able to alter their configuration.
However, in general, use of .htaccess files should be avoided when possible. Any configuration that you would consider putting in a .htaccess file, can just as effectively be made in a <Directory> section in your main server configuration file.
There are two main reasons to avoid the use of .htaccess files.
The first of these is performance. When AllowOverride is set to allow the use of .htaccess files, httpd will look in every directory for .htaccess files. Thus, permitting .htaccess files causes a performance hit, whether or not you actually even use them! Also, the .htaccess file is loaded every time a document is requested.
Further note that httpd must look for .htaccess files in all higher-level directories, in order to have a full complement of directives that it must apply. (See section on how directives are applied.) Thus, if a file is requested out of a directory /www/htdocs/example , httpd must look for the following files:
/.htaccess
/www/.htaccess
/www/htdocs/.htaccess
/www/htdocs/example/.htaccess
And so, for each file access out of that directory, there are 4 additional file-system accesses, even if none of those files are present. (Note that this would only be the case if .htaccess files were enabled for / , which is not usually the case.)
In the case of RewriteRule directives, in .htaccess context these regular expressions must be re-compiled with every request to the directory, whereas in main server configuration context they are compiled once and cached. Additionally, the rules themselves are more complicated, as one must work around the restrictions that come with per-directory context and mod_rewrite . Consult the Rewrite Guide for more detail on this subject.
The second consideration is one of security. You are permitting users to modify server configuration, which may result in changes over which you have no control. Carefully consider whether you want to give your users this privilege. Note also that giving users less privileges than they need will lead to additional technical support requests. Make sure you clearly tell your users what level of privileges you have given them. Specifying exactly what you have set AllowOverride to, and pointing them to the relevant documentation, will save yourself a lot of confusion later.
Note that it is completely equivalent to put a .htaccess file in a directory /www/htdocs/example containing a directive, and to put that same directive in a Directory section <Directory «/www/htdocs/example»> in your main server configuration:
.htaccess file in /www/htdocs/example :
Contents of .htaccess file in /www/htdocs/example
Section from your httpd.conf file
However, putting this configuration in your server configuration file will result in less of a performance hit, as the configuration is loaded once when httpd starts, rather than every time a file is requested.
The use of .htaccess files can be disabled completely by setting the AllowOverride directive to none :
How directives are applied
The configuration directives found in a .htaccess file are applied to the directory in which the .htaccess file is found, and to all subdirectories thereof. However, it is important to also remember that there may have been .htaccess files in directories higher up. Directives are applied in the order that they are found. Therefore, a .htaccess file in a particular directory may override directives found in .htaccess files found higher up in the directory tree. And those, in turn, may have overridden directives found yet higher up, or in the main server configuration file itself.
In the directory /www/htdocs/example1 we have a .htaccess file containing the following:
(Note: you must have » AllowOverride Options » in effect to permit the use of the » Options » directive in .htaccess files.)
In the directory /www/htdocs/example1/example2 we have a .htaccess file containing:
Because of this second .htaccess file, in the directory /www/htdocs/example1/example2 , CGI execution is not permitted, as only Options Includes is in effect, which completely overrides any earlier setting that may have been in place.
Merging of .htaccess with the main configuration files
As discussed in the documentation on Configuration Sections, .htaccess files can override the <Directory> sections for the corresponding directory, but will be overridden by other types of configuration sections from the main configuration files. This fact can be used to enforce certain configurations, even in the presence of a liberal AllowOverride setting. For example, to prevent script execution while allowing anything else to be set in .htaccess you can use:
Authentication example
If you jumped directly to this part of the document to find out how to do authentication, it is important to note one thing. There is a common misconception that you are required to use .htaccess files in order to implement password authentication. This is not the case. Putting authentication directives in a <Directory> section, in your main server configuration file, is the preferred way to implement this, and .htaccess files should be used only if you don’t have access to the main server configuration file. See above for a discussion of when you should and should not use .htaccess files.
Having said that, if you still think you need to use a .htaccess file, you may find that a configuration such as what follows may work for you.
.htaccess file contents:
Note that AllowOverride AuthConfig must be in effect for these directives to have any effect.
Please see the authentication tutorial for a more complete discussion of authentication and authorization.
Server Side Includes example
Another common use of .htaccess files is to enable Server Side Includes for a particular directory. This may be done with the following configuration directives, placed in a .htaccess file in the desired directory:
Note that AllowOverride Options and AllowOverride FileInfo must both be in effect for these directives to have any effect.
Please see the SSI tutorial for a more complete discussion of server-side includes.
Rewrite Rules in .htaccess files
When using RewriteRule in .htaccess files, be aware that the per-directory context changes things a bit. In particular, rules are taken to be relative to the current directory, rather than being the original requested URI. Consider the following examples:
In a .htaccess in your document directory, the leading slash is removed from the value supplied to RewriteRule , and in the images subdirectory, /images/ is removed from it. Thus, your regular expression needs to omit that portion as well.
Consult the mod_rewrite documentation for further details on using mod_rewrite .
CGI example
Finally, you may wish to use a .htaccess file to permit the execution of CGI programs in a particular directory. This may be implemented with the following configuration:
Alternately, if you wish to have all files in the given directory be considered to be CGI programs, this may be done with the following configuration:
Note that AllowOverride Options and AllowOverride FileInfo must both be in effect for these directives to have any effect.
Please see the CGI tutorial for a more complete discussion of CGI programming and configuration.
Troubleshooting
When you put configuration directives in a .htaccess file, and you don’t get the desired effect, there are a number of things that may be going wrong.
Most commonly, the problem is that AllowOverride is not set such that your configuration directives are being honored. Make sure that you don’t have a AllowOverride None in effect for the file scope in question. A good test for this is to put garbage in your .htaccess file and reload the page. If a server error is not generated, then you almost certainly have AllowOverride None in effect.
If, on the other hand, you are getting server errors when trying to access documents, check your httpd error log. It will likely tell you that the directive used in your .htaccess file is not permitted.
[Fri Sep 17 18:43:16 2010] [alert] [client 192.168.200.51] /var/www/html/.htaccess: DirectoryIndex not allowed here
This will indicate either that you’ve used a directive that is never permitted in .htaccess files, or that you simply don’t have AllowOverride set to a level sufficient for the directive you’ve used. Consult the documentation for that particular directive to determine which is the case.
Alternately, it may tell you that you had a syntax error in your usage of the directive itself.
[Sat Aug 09 16:22:34 2008] [alert] [client 192.168.200.51] /var/www/html/.htaccess: RewriteCond: bad flag delimiters
In this case, the error message should be specific to the particular syntax error that you have committed.
Comments
Copyright 2023 The Apache Software Foundation.
Licensed under the Apache License, Version 2.0.
How to Enable & Set Up .htaccess File on Apache
The .htaccess file in Apache is a tool that allows configurations at the directory and subdirectory level. Using .htaccess enables you to configure website permissions without altering server configuration files.
This tutorial will show you how to set up and enable htaccess on Apache. Also, it instructs on how to restrict access to specific localizations on the server, manage IP addresses, and redirect traffic.
Note: If you do not have Apache on your system, you can find a step-by-step instruction guide on installing Apache on Ubuntu.
- A working Apache web server
- Access to a terminal window/command line
- Access to a user account with sudo privileges
- A text editor, such as Nano, included by default
Step 1: Enable Apache .htaccess
By default, the .htaccess file is not enabled.
1. Open the default host configuration file by entering the following command in the terminal:
2. Locate the section labeled <Directory /var/www>.
In that section, change the AllowOverride None entry to all:
AllowOverride All

Save the file and exit.
3. Next, restart the Apache service:
Step 2: Create .htaccess File
Like most Linux software packages, Apache functions on configuration files. The .htaccess file is one of these. It works by specifying a setting along with a value.
To create and open the .htaccess file for editing, enter:
Replace my_website with the name of your actual website. If this file doesn’t exist, your text editor will create it.
Step 3: Restrict Directory Listings
There may be locations on your server that you want to restrict access to. You can do this by creating a list of usernames and passwords that are authorized to have access.
1. Start by creating a new file, .htpasswd in a different directory:
Enter a username and password for each user that you want to create. Make sure to use strong passwords, and enter only one username/password pair per line.
Save the file and exit.
2. Next edit .htaccess to enable authentication:

Replace /user/safe_location/htpasswd with the location of your choice. Don’t store it in the same directory as your web content, for security reasons.
AuthUserFile — This sets the location for your .htpasswd file.
AuthGroupFile — We’re not using a group, so this is a placeholder.
AuthName — This is the prompt to the user – you may rephrase if you’d like.
AuthType — Type of authentication used – don’t change this.
Require valid-user – Allows any one of several authorized people to log on. You could change this to Require user new_user to restrict access only to someone with the username new_user.
Manage IP Addresses
There are many ways you can manage IP addresses:
- Allow only specific IPs.
- Block specific IP addresses.
- Block visitors by the referrer.
Allow IP Addresses
To allow IP addresses, you can switch the behavior to allow a few designated IP addresses, and block the rest.
Enter the commands:

Block IP Addresses
To block IP addresses in htaccess, enter: order allow, deny
To block a single IP address, enter this code next: deny from 192.168.0.54
If you leave off the final digit, it will block all IP addresses in the 0 — 255 range:
For Example: deny from 192.168.0

Note: You can save your .htaccess file after each operation listed below. If you’re done making changes, just reload your Apache service before testing. Also, when editing the file, it’s helpful to make comments. Use the # sign to mark a line as a comment, which will let you make notes that the system won’t read as commands.
Block Visitors by Referrer
You may want to prevent people from being redirected from a specific site to your server. This might be helpful if you want to isolate traffic patterns. You might also use it if you were getting excess server traffic from a questionable source.
Open the .htaccess file and add the following block:
The NC option instructs to ignore the upper or lower case so that the rule can’t be bypassed by entering BlockedDomain.com.
If you want to add more domains, note the following:
The OR flag tells the system that you’re not done adding blocked referrers yet. Omit this option on the last entry.
Redirect Traffic
You can use the .htaccess file to redirect traffic.
Open the file and enter the following:
This command takes any traffic that’s searching for Other_Website.com and redirects it to My_Website.com.
Set a 404 Page
You can use the .htaccess file to point basic functions to a new location. One example is the 404 page.
1. Open the .htaccess file and enter:
This line tells the system to look at the website’s content directory for a /404.html file as the error page.
2. Create the 404 page using this command:
This should open the 404.html file in your text editor.
3. Next, add the following code:

This page can now be customized to display any kind of error message you want. You can also customize any other error pages you’d like. Just specify the ErrorDocument number, for example, Error 500 than point .htaccess to the new error.html file that you create.
Enabling .htaccess can be an incredibly valuable tool for managing your Apache web server.
This guide provides basic commands and settings, with some of the most likely scenarios you might encounter.
.htaccess in apache2.2/2.4 on Ubuntu LAMP setup
htaccess files don’t work on Apache server server by default and anybody who moved from using wamp/xampp to apache encounter this problem.
htaccess is a file which can be placed in the folders of document root and is meant to override apache configurations for that particular folder. It is loaded by apache while serving request i.e. during runtime. htaccess being located inside the document root can be accessed by anybody editing the application and thus pose a security risk by it’s ability to override server configuration. Hence, an Apache installation installed with default virtual hosts in /etc/apache2/sites_available/ have htaccess disallowed.
But wait! I have used wamp without any such configuration. Why this mess? If you have any experience with XAMPP or WAMP, you might have noted they allow the htaccess files by default. The reason is that while these two are for development purposes only, Apache on Linux is built for production environments. Hence, it has most of the security arrangements in place by default.
So what should you do?
It is therefore recommended to add the htaccess commands inside a directive tag in the apache configurations. Edit the virtual host file under
/etc/apache2/sites-available/
and replace
Allowoverride None with Allowoverride all . Save the file and reload apache server with
sudo service apache2 reload
Now the .htacces files located in the document folder should start working.
Why not to use .htaccess? What could be problems with .htaccess?
On a production environment, if you have access to the apache configuration files, it’s always better to edit apache.conf or virtual-hosts file instead of allowing .htaccess. Why?
It decreases server load, decreases page load time resulting in better user experience. If htaccess is set to allowed and you are serving a request for /scripts/js/jslib/myjavascript.js, the server searches for a .htaccess at each folder i.e. it first searches for /.htaccess, then /scripts/.htaccess ,then /scripts/js/.htaccess ,then /scripts/js/js-lib/.htaccess . This has a direct effect on server load.
How to edit apache configuration instead of allowing .htaccess?
Case: You need to put a .htaccess file in the folder /var/www/master/ to redirect users from example.com to www.example.com. Thus, the contents of your .htaccess should be roughly the following
RewriteEngine on
# if a directory or a file exists, use it directly
RewriteCond %
RewriteCond %
# otherwise forward it to index.php
RewriteRule . index.php
Alternative: Edit the apache virtual host file corresponding to your site and add the following directive instead inside the virtual host tags
Apache Tutorial: .htaccess files
.htaccess files provide a way to make configuration changes on a per-directory basis.
- .htaccess files
- What they are/How to use them
- When (not) to use .htaccess files
- How directives are applied
- Authentication example
- Server Side Includes example
- CGI example
- Troubleshooting
.htaccess files
- core
- mod_auth
- mod_cgi
- mod_include
- mod_mime
- AccessFileName
- AllowOverride
- Options
- AddHandler
- SetHandler
- AuthType
- AuthName
- AuthUserFile
- AuthGroupFile
- Require
What they are/How to use them
.htaccess files (or «distributed configuration files») provide a way to make configuration changes on a per-directory basis. A file, containing one or more configuration directives, is placed in a particular document directory, and the directives apply to that directory, and all subdirectories thereof.
If you want to call your .htaccess file something else, you can change the name of the file using the AccessFileName directive. For example, if you would rather call the file .config then you can put the following in your server configuration file:
In general, .htaccess files use the same syntax as the main configuration files. What you can put in these files is determined by the AllowOverride directive. This directive specifies, in categories, what directives will be honored if they are found in a .htaccess file. If a directive is permitted in a .htaccess file, the documentation for that directive will contain an Override section, specifying what value must be in AllowOverride in order for that directive to be permitted.
For example, if you look at the documentation for the AddDefaultCharset directive, you will find that it is permitted in .htaccess files. (See the Context line in the directive summary.) The Override line reads FileInfo . Thus, you must have at least AllowOverride FileInfo in order for this directive to be honored in .htaccess files.
Example:
| Context: | server config, virtual host, directory, .htaccess |
| Override: | FileInfo |
If you are unsure whether a particular directive is permitted in a .htaccess file, look at the documentation for that directive, and check the Context line for «.htaccess».
When (not) to use .htaccess files
In general, you should never use .htaccess files unless you don’t have access to the main server configuration file. There is, for example, a prevailing misconception that user authentication should always be done in .htaccess files. This is simply not the case. You can put user authentication configurations in the main server configuration, and this is, in fact, the preferred way to do things.
.htaccess files should be used in a case where the content providers need to make configuration changes to the server on a per-directory basis, but do not have root access on the server system. In the event that the server administrator is not willing to make frequent configuration changes, it might be desirable to permit individual users to make these changes in .htaccess files for themselves. This is particularly true, for example, in cases where ISPs are hosting multiple user sites on a single machine, and want their users to be able to alter their configuration.
However, in general, use of .htaccess files should be avoided when possible. Any configuration that you would consider putting in a .htaccess file, can just as effectively be made in a <Directory> section in your main server configuration file.
There are two main reasons to avoid the use of .htaccess files.
The first of these is performance. When AllowOverride is set to allow the use of .htaccess files, Apache will look in every directory for .htaccess files. Thus, permitting .htaccess files causes a performance hit, whether or not you actually even use them! Also, the .htaccess file is loaded every time a document is requested.
Further note that Apache must look for .htaccess files in all higher-level directories, in order to have a full complement of directives that it must apply. (See section on how directives are applied.) Thus, if a file is requested out of a directory /www/htdocs/example , Apache must look for the following files:
/.htaccess
/www/.htaccess
/www/htdocs/.htaccess
/www/htdocs/example/.htaccess
And so, for each file access out of that directory, there are 4 additional file-system accesses, even if none of those files are present. (Note that this would only be the case if .htaccess files were enabled for / , which is not usually the case.)
The second consideration is one of security. You are permitting users to modify server configuration, which may result in changes over which you have no control. Carefully consider whether you want to give your users this privilege. Note also that giving users less privileges than they need will lead to additional technical support requests. Make sure you clearly tell your users what level of privileges you have given them. Specifying exactly what you have set AllowOverride to, and pointing them to the relevant documentation, will save yourself a lot of confusion later.
Note that it is completely equivalent to put a .htaccess file in a directory /www/htdocs/example containing a directive, and to put that same directive in a Directory section <Directory /www/htdocs/example> in your main server configuration:
.htaccess file in /www/htdocs/example :
Contents of .htaccess file in /www/htdocs/example
AddType text/example .exm
Section from your httpd.conf file
<Directory /www/htdocs/example>
AddType text/example .exm
</Directory>
However, putting this configuration in your server configuration file will result in less of a performance hit, as the configuration is loaded once when Apache starts, rather than every time a file is requested.
The use of .htaccess files can be disabled completely by setting the AllowOverride directive to none :
How directives are applied
The configuration directives found in a .htaccess file are applied to the directory in which the .htaccess file is found, and to all subdirectories thereof. However, it is important to also remember that there may have been .htaccess files in directories higher up. Directives are applied in the order that they are found. Therefore, a .htaccess file in a particular directory may override directives found in .htaccess files found higher up in the directory tree. And those, in turn, may have overridden directives found yet higher up, or in the main server configuration file itself.
In the directory /www/htdocs/example1 we have a .htaccess file containing the following:
(Note: you must have » AllowOverride Options » in effect to permit the use of the » Options » directive in .htaccess files.)
In the directory /www/htdocs/example1/example2 we have a .htaccess file containing:
Because of this second .htaccess file, in the directory /www/htdocs/example1/example2 , CGI execution is not permitted, as only Options Includes is in effect, which completely overrides any earlier setting that may have been in place.
Merging of .htaccess with the main configuration files
As discussed in the documentation on Configuration Sections, .htaccess files can override the <Directory> sections for the corresponding directory, but will be overriden by other types of configuration sections from the main configuration files. This fact can be used to enforce certain configurations, even in the presence of a liberal AllowOverride setting. For example, to prevent script execution while allowing anything else to be set in .htaccess you can use:
<Directory />
Allowoverride All
</Directory>
<Location />
Options +IncludesNoExec -ExecCGI
</Location>
Authentication example
If you jumped directly to this part of the document to find out how to do authentication, it is important to note one thing. There is a common misconception that you are required to use .htaccess files in order to implement password authentication. This is not the case. Putting authentication directives in a <Directory> section, in your main server configuration file, is the preferred way to implement this, and .htaccess files should be used only if you don’t have access to the main server configuration file. See above for a discussion of when you should and should not use .htaccess files.
Having said that, if you still think you need to use a .htaccess file, you may find that a configuration such as what follows may work for you.
You must have » AllowOverride AuthConfig » in effect for these directives to be honored.
.htaccess file contents:
AuthType Basic
AuthName «Password Required»
AuthUserFile /www/passwords/password.file
AuthGroupFile /www/passwords/group.file
Require Group admins
Note that AllowOverride AuthConfig must be in effect for these directives to have any effect.
Please see the authentication tutorial for a more complete discussion of authentication and authorization.
Server Side Includes example
Another common use of .htaccess files is to enable Server Side Includes for a particular directory. This may be done with the following configuration directives, placed in a .htaccess file in the desired directory:
Options +Includes
AddType text/html shtml
AddHandler server-parsed shtml
Note that AllowOverride Options and AllowOverride FileInfo must both be in effect for these directives to have any effect.
Please see the SSI tutorial for a more complete discussion of server-side includes.
CGI example
Finally, you may wish to use a .htaccess file to permit the execution of CGI programs in a particular directory. This may be implemented with the following configuration:
Options +ExecCGI
AddHandler cgi-script cgi pl
Alternately, if you wish to have all files in the given directory be considered to be CGI programs, this may be done with the following configuration:
Options +ExecCGI
SetHandler cgi-script
Note that AllowOverride Options and AllowOverride FileInfo must both be in effect for these directives to have any effect.
Please see the CGI tutorial for a more complete discussion of CGI programming and configuration.
Troubleshooting
When you put configuration directives in a .htaccess file, and you don’t get the desired effect, there are a number of things that may be going wrong.
Most commonly, the problem is that AllowOverride is not set such that your configuration directives are being honored. Make sure that you don’t have a AllowOverride None in effect for the file scope in question. A good test for this is to put garbage in your .htaccess file and reload. If a server error is not generated, then you almost certainly have AllowOverride None in effect.
If, on the other hand, you are getting server errors when trying to access documents, check your Apache error log. It will likely tell you that the directive used in your .htaccess file is not permitted. Alternately, it may tell you that you had a syntax error, which you will then need to fix.
Copyright 2007 The Apache Software Foundation.
Licensed under the Apache License, Version 2.0.