Actions

Difference between revisions of "Preconfigured htaccess"

From Joomla! Documentation

(Change from needs review to stub. This article needs some explanatory text)
m (A typo error)
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{stub}}
+
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.
 +
 
 +
<strong>Note:</strong>
 +
 
 +
The active file is set in one of the httpd.conf files with:
 +
<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>
 +
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:
 +
 
 
<pre>
 
<pre>
 
##
 
##
# @version $Id: htaccess.txt 10492 2008-07-02 06:38:28Z ircmaxell $
+
# @package   Joomla
# @package Joomla
+
# @copyright Copyright (C) 2005 - 2015 Open Source Matters. All rights reserved.
# @copyright Copyright (C) 2005 - 2008 Open Source Matters. All rights reserved.
+
# @license   GNU General Public License version 2 or later; see LICENSE.txt
# @license http://www.gnu.org/copyleft/gpl.html GNU/GPL
+
##
# Joomla! is Free Software
+
 
##
+
##
+
# READ THIS COMPLETELY IF YOU CHOOSE TO USE THIS FILE!
+
#
#####################################################
+
# The line just below this section: 'Options +FollowSymLinks' may cause problems
# READ THIS COMPLETELY IF YOU CHOOSE TO USE THIS FILE
+
# 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
# The line just below this section: 'Options +FollowSymLinks' may cause problems
+
# your .htaccess file.  If using it causes your server to error out, comment it out (add # to
# with some server configurations.  It is required for use of mod_rewrite, but may already
+
# beginning of line), reload your site in your browser and test your sef url's.  If they work,
# be set by your server administrator in a way that dissallows changing it in
+
# it has been set by your server administrator and you do not need it set here.
# 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.
## Can be commented out if causes errors, see notes above.
+
Options +FollowSymlinks
Options +FollowSymLinks
+
Options -Indexes
+
 
#
+
## Mod_rewrite in use.
# mod_rewrite in use
+
 
+
RewriteEngine On
RewriteEngine On
+
 
+
## Begin - Rewrite rules to block out some common exploits.
########## Begin - Rewrite rules to block out some common exploits
+
# If you experience problems on your site block out the operations listed below
## 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!
## 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.
# Block out any script trying to set a mosConfig value through the URL
+
RewriteCond %{QUERY_STRING} base64_encode[^(]*\([^)]*\) [OR]
RewriteCond %{QUERY_STRING} mosConfig_[a-zA-Z_]{1,21}(=|\%3D) [OR]
+
# Block out any script that includes a <script> tag in URL.
# Block out any script trying to base64_encode crap to send via URL
+
RewriteCond %{QUERY_STRING} (<|%3C)([^s]*s)+cript.*(>|%3E) [NC,OR]
RewriteCond %{QUERY_STRING} base64_encode.*\(.*\) [OR]
+
# Block out any script trying to set a PHP GLOBALS variable via URL.
# Block out any script that includes a <script> tag in URL
+
RewriteCond %{QUERY_STRING} GLOBALS(=|\[|\%[0-9A-Z]{0,2}) [OR]
RewriteCond %{QUERY_STRING} (\<|%3C).*script.*(\>|%3E) [NC,OR]
+
# Block out any script trying to modify a _REQUEST variable via URL.
# Block out any script trying to set a PHP GLOBALS variable via URL
+
RewriteCond %{QUERY_STRING} _REQUEST(=|\[|\%[0-9A-Z]{0,2})
RewriteCond %{QUERY_STRING} GLOBALS(=|\[|\%[0-9A-Z]{0,2}) [OR]
+
# Return 403 Forbidden header and show the content of the root homepage
# Block out any script trying to modify a _REQUEST variable via URL
+
RewriteRule .* index.php [F]
RewriteCond %{QUERY_STRING} _REQUEST(=|\[|\%[0-9A-Z]{0,2})
+
#
# Send all blocked request to homepage with 403 Forbidden error!
+
## End - Rewrite rules to block out some common exploits.
RewriteRule ^(.*)$ index.php [F,L]
+
 
#
+
## Begin - Custom redirects
########## End - Rewrite rules to block out some common exploits
+
#
+
# If you need to redirect some pages, or set a canonical non-www to
# Uncomment following line if your webserver's URL
+
# www redirect (or vice versa), place that code here. Ensure those
# is not directly related to physical file paths.
+
# redirects use the correct RewriteRule syntax and the [R=301,L] flags.
# Update Your Joomla! Directory (just / for root)
+
#
+
## End - Custom redirects
# RewriteBase /
+
 
+
##
+
# Uncomment following line if your webserver's URL
########## Begin - Joomla! core SEF Section
+
# is not directly related to physical file paths.
#
+
# Update Your Joomla! Directory (just / for root).
RewriteCond %{REQUEST_FILENAME} !-f
+
##
RewriteCond %{REQUEST_FILENAME} !-d
+
 
RewriteCond %{REQUEST_URI} !^/index.php
+
# RewriteBase /
RewriteCond %{REQUEST_URI} (/|\.php|\.html|\.htm|\.feed|\.pdf|\.raw|/[^.]*)$  [NC]
+
 
RewriteRule (.*) index.php
+
## Begin - Joomla! core SEF Section.
RewriteRule .* - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization},L]
+
#
#
+
RewriteRule .* - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization}]
########## End - Joomla! core SEF Section
+
#
 +
# 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>
 
</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.