Actions

Difference between revisions of "Preconfigured htaccess"

From Joomla! Documentation

m (Hutchy68 moved page Preconfigured .htaccess to Preconfigured htaccess: fixing page not accessible)
m (A typo error)
 
(6 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{review}}
+
An Apache webserver uses an htaccess file in the site main directory for site specific configuration. A preconfigured htaccess file (htaccess.txt) is delivered with Joomla. It contains instructions to avoid common exploits and implements SEF urls. In addition it provides some settings that needs to be checked for your environment:
 +
<ul>
 +
<li>IndexIgnore *</li>
 +
<li>Options +FollowSymLinks</li>
 +
<li>Options -Indexes</li>
 +
<li>RewriteBase /<li>
 +
</ul>
  
##
+
Activating htaccess.txt means merging an existing .htaccess file with htaccess.txt and decide on the settings mentioned above.
# @version $Id: htaccess.txt 10492 2008-07-02 06:38:28Z ircmaxell $
+
 
# @package Joomla
+
<strong>Note:</strong>
# @copyright Copyright (C) 2005 - 2008 Open Source Matters. All rights reserved.
+
 
# @license http://www.gnu.org/copyleft/gpl.html GNU/GPL
+
The active file is set in one of the httpd.conf files with:
# Joomla! is Free Software
+
<pre>AccessFileName .htaccess</pre>
##
+
It defaults to .htaccess (which makes it hidden on a Unix-like filesystems). No need to change that.
 
   
 
   
+
On the Windows platform you might change it to:
#####################################################
+
<pre>AccessFileName htaccess.ini</pre>
# READ THIS COMPLETELY IF YOU CHOOSE TO USE THIS FILE
+
so you can edit it more easily.
#
+
 
# The line just below this section: 'Options +FollowSymLinks' may cause problems
+
Don't use htaccess.txt here because when updating Joomla, it will be overwritten and changes will be lost.
# with some server configurations.  It is required for use of mod_rewrite, but may already
+
 
# be set by your server administrator in a way that dissallows changing it in
+
Content of htaccess.txt:
# your .htaccess file.  If using it causes your server to error out, comment it out (add # to
+
 
# beginning of line), reload your site in your browser and test your sef url's.  If they work,
+
<pre>
# it has been set by your server administrator and you do not need it set here.
+
##
#
+
# @package    Joomla
#####################################################
+
# @copyright  Copyright (C) 2005 - 2015 Open Source Matters. All rights reserved.
+
# @license    GNU General Public License version 2 or later; see LICENSE.txt
## Can be commented out if causes errors, see notes above.
+
##
Options +FollowSymLinks
+
 
+
##
#
+
# READ THIS COMPLETELY IF YOU CHOOSE TO USE THIS FILE!
# mod_rewrite in use
+
#
+
# The line just below this section: 'Options +FollowSymLinks' may cause problems
RewriteEngine On
+
# with some server configurations.  It is required for use of mod_rewrite, but may already
+
# be set by your server administrator in a way that disallows changing it in
########## Begin - Rewrite rules to block out some common exploits
+
# your .htaccess file.  If using it causes your server to error out, comment it out (add # to
## If you experience problems on your site block out the operations listed below
+
# beginning of line), reload your site in your browser and test your sef url's.  If they work,
## This attempts to block the most common type of exploit `attempts` to Joomla!
+
# it has been set by your server administrator and you do not need it set here.
#
+
##
# Block out any script trying to set a mosConfig value through the URL
+
 
RewriteCond %{QUERY_STRING} mosConfig_[a-zA-Z_]{1,21}(=|\%3D) [OR]
+
## No directory listings
# Block out any script trying to base64_encode crap to send via URL
+
IndexIgnore *
RewriteCond %{QUERY_STRING} base64_encode.*\(.*\) [OR]
+
 
# Block out any script that includes a <script> tag in URL
+
## Can be commented out if causes errors, see notes above.
RewriteCond %{QUERY_STRING} (\<|%3C).*script.*(\>|%3E) [NC,OR]
+
Options +FollowSymlinks
# Block out any script trying to set a PHP GLOBALS variable via URL
+
Options -Indexes
RewriteCond %{QUERY_STRING} GLOBALS(=|\[|\%[0-9A-Z]{0,2}) [OR]
+
 
# Block out any script trying to modify a _REQUEST variable via URL
+
## Mod_rewrite in use.
RewriteCond %{QUERY_STRING} _REQUEST(=|\[|\%[0-9A-Z]{0,2})
+
 
# Send all blocked request to homepage with 403 Forbidden error!
+
RewriteEngine On
RewriteRule ^(.*)$ index.php [F,L]
+
 
#
+
## Begin - Rewrite rules to block out some common exploits.
########## End - Rewrite rules to block out some common exploits
+
# If you experience problems on your site block out the operations listed below
+
# This attempts to block the most common type of exploit `attempts` to Joomla!
# Uncomment following line if your webserver's URL
+
#
# is not directly related to physical file paths.
+
# Block out any script trying to base64_encode data within the URL.
# Update Your Joomla! Directory (just / for root)
+
RewriteCond %{QUERY_STRING} base64_encode[^(]*\([^)]*\) [OR]
+
# Block out any script that includes a <script> tag in URL.
# RewriteBase /
+
RewriteCond %{QUERY_STRING} (<|%3C)([^s]*s)+cript.*(>|%3E) [NC,OR]
+
# Block out any script trying to set a PHP GLOBALS variable via URL.
+
RewriteCond %{QUERY_STRING} GLOBALS(=|\[|\%[0-9A-Z]{0,2}) [OR]
########## Begin - Joomla! core SEF Section
+
# Block out any script trying to modify a _REQUEST variable via URL.
#
+
RewriteCond %{QUERY_STRING} _REQUEST(=|\[|\%[0-9A-Z]{0,2})
RewriteCond %{REQUEST_FILENAME} !-f
+
# Return 403 Forbidden header and show the content of the root homepage
RewriteCond %{REQUEST_FILENAME} !-d
+
RewriteRule .* index.php [F]
RewriteCond %{REQUEST_URI} !^/index.php
+
#
RewriteCond %{REQUEST_URI} (/|\.php|\.html|\.htm|\.feed|\.pdf|\.raw|/[^.]*)$  [NC]
+
## End - Rewrite rules to block out some common exploits.
RewriteRule (.*) index.php
+
 
RewriteRule .* - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization},L]
+
## Begin - Custom redirects
#
+
#
########## End - Joomla! core SEF Section
+
# If you need to redirect some pages, or set a canonical non-www to
 +
# www redirect (or vice versa), place that code here. Ensure those
 +
# redirects use the correct RewriteRule syntax and the [R=301,L] flags.
 +
#
 +
## End - Custom redirects
 +
 
 +
##
 +
# Uncomment following line if your webserver's URL
 +
# is not directly related to physical file paths.
 +
# Update Your Joomla! Directory (just / for root).
 +
##
 +
 
 +
# RewriteBase /
 +
 
 +
## Begin - Joomla! core SEF Section.
 +
#
 +
RewriteRule .* - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization}]
 +
#
 +
# If the requested path and file is not /index.php and the request
 +
# has not already been internally rewritten to the index.php script
 +
RewriteCond %{REQUEST_URI} !^/index\.php
 +
# and the requested path and file doesn't directly match a physical file
 +
RewriteCond %{REQUEST_FILENAME} !-f
 +
# and the requested path and file doesn't directly match a physical folder
 +
RewriteCond %{REQUEST_FILENAME} !-d
 +
# internally rewrite the request to the index.php script
 +
RewriteRule .* index.php [L]
 +
#
 +
## End - Joomla! core SEF Section.
 +
 
 +
</pre>

Latest revision as of 11:59, 26 February 2015

An Apache webserver uses an htaccess file in the site main directory for site specific configuration. A preconfigured htaccess file (htaccess.txt) is delivered with Joomla. It contains instructions to avoid common exploits and implements SEF urls. In addition it provides some settings that needs to be checked for your environment:

  • IndexIgnore *
  • Options +FollowSymLinks
  • Options -Indexes
  • RewriteBase /

Activating htaccess.txt means merging an existing .htaccess file with htaccess.txt and decide on the settings mentioned above.

Note:

The active file is set in one of the httpd.conf files with:

AccessFileName .htaccess

It defaults to .htaccess (which makes it hidden on a Unix-like filesystems). No need to change that.

On the Windows platform you might change it to:

AccessFileName htaccess.ini

so you can edit it more easily.

Don't use htaccess.txt here because when updating Joomla, it will be overwritten and changes will be lost.

Content of htaccess.txt:

##
# @package    Joomla
# @copyright  Copyright (C) 2005 - 2015 Open Source Matters. All rights reserved.
# @license    GNU General Public License version 2 or later; see LICENSE.txt
##

##
# READ THIS COMPLETELY IF YOU CHOOSE TO USE THIS FILE!
#
# The line just below this section: 'Options +FollowSymLinks' may cause problems
# with some server configurations.  It is required for use of mod_rewrite, but may already
# be set by your server administrator in a way that disallows changing it in
# your .htaccess file.  If using it causes your server to error out, comment it out (add # to
# beginning of line), reload your site in your browser and test your sef url's.  If they work,
# it has been set by your server administrator and you do not need it set here.
##

## No directory listings
IndexIgnore *

## Can be commented out if causes errors, see notes above.
Options +FollowSymlinks
Options -Indexes

## Mod_rewrite in use.

RewriteEngine On

## Begin - Rewrite rules to block out some common exploits.
# If you experience problems on your site block out the operations listed below
# This attempts to block the most common type of exploit `attempts` to Joomla!
#
# Block out any script trying to base64_encode data within the URL.
RewriteCond %{QUERY_STRING} base64_encode[^(]*\([^)]*\) [OR]
# Block out any script that includes a <script> tag in URL.
RewriteCond %{QUERY_STRING} (<|%3C)([^s]*s)+cript.*(>|%3E) [NC,OR]
# Block out any script trying to set a PHP GLOBALS variable via URL.
RewriteCond %{QUERY_STRING} GLOBALS(=|\[|\%[0-9A-Z]{0,2}) [OR]
# Block out any script trying to modify a _REQUEST variable via URL.
RewriteCond %{QUERY_STRING} _REQUEST(=|\[|\%[0-9A-Z]{0,2})
# Return 403 Forbidden header and show the content of the root homepage
RewriteRule .* index.php [F]
#
## End - Rewrite rules to block out some common exploits.

## Begin - Custom redirects
#
# If you need to redirect some pages, or set a canonical non-www to
# www redirect (or vice versa), place that code here. Ensure those
# redirects use the correct RewriteRule syntax and the [R=301,L] flags.
#
## End - Custom redirects

##
# Uncomment following line if your webserver's URL
# is not directly related to physical file paths.
# Update Your Joomla! Directory (just / for root).
##

# RewriteBase /

## Begin - Joomla! core SEF Section.
#
RewriteRule .* - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization}]
#
# If the requested path and file is not /index.php and the request
# has not already been internally rewritten to the index.php script
RewriteCond %{REQUEST_URI} !^/index\.php
# and the requested path and file doesn't directly match a physical file
RewriteCond %{REQUEST_FILENAME} !-f
# and the requested path and file doesn't directly match a physical folder
RewriteCond %{REQUEST_FILENAME} !-d
# internally rewrite the request to the index.php script
RewriteRule .* index.php [L]
#
## End - Joomla! core SEF Section.