Actions

Difference between revisions of "Enabling Search Engine Friendly (SEF) URLs on Apache"

From Joomla! Documentation

(create brief intro-section, create section off for instructions, provide link to IIS info)
(33 intermediate revisions by 9 users not shown)
Line 1: Line 1:
This article addresses SEF URLs under the popular, open-source Apache webserver.
+
{{version|1.5,2.5,3.1}}
 +
{{:Search Engine Friendly URLs}}
 +
This article addresses SEF URLs under the popular, open-source Apache webserver. SEF URL implementation is possible under Microsoft's IIS webserver as well, please see [[Enabling Search Engine Friendly (SEF) URLs on IIS]].
  
SEF URL implementation is possible under Microsoft's IIS webserver as well, please see [[IIS and Joomla]].
+
{{JVer|2.5}} Since Joomla! 1.6, basic SEF urls are enabled by default. {{JVer|1.5}} In prior versions you need to use the Global Configuration to enable them. The instructions below still apply if you want to use Apache's mod_rewrite/URL rewriting.
 +
<onlyinclude>
 +
These are step-by-step instructions. Please follow them in the order they are presented here. If a step fails, '''do not''' continue until you have solved the problem.
  
==Apache Instructions==
+
# Rename the file <code>"htaccess.txt"</code> in your Joomla!'s base folder to <code>".htaccess"</code>.
:1. Rename htaccess.txt to .htaccess.
+
# ''This step may not be necessary.'' Open <code>.htaccess</code> in a text editor. Uncomment <code>RewriteBase /</code> (remove the first character, #). If Joomla is installed in its own folder, the enter the Joomla folder name after the backslash. e.g. <code>RewriteBase /yourjoomlafolder</code>.
::* If Joomla is installed in its own folder, uncomment "RewriteBase <nowiki>/</nowiki>" and enter the Joomla folder name after the backslash. Example: <nowiki>RewriteBase /joomla</nowiki>
+
# Log on to your Back-end and open the Global Configuration.
:2. Make sure that Mod_rewrite is working. Check that the line shown below in the file "apache/conf/httpd.conf" is uncommented. If necessary, uncomment the line and re-start the Apache web server.
+
# Enable the '''Search Engine Friendly URLs''' option and ''Save''. This option converts the URLs from the native Joomla! format to the SEF format.
::<code>LoadModule rewrite_module modules/mod_rewrite.so</code>
+
#: Check if your site works correctly. Your URLs should now look like <code><nowiki>http://www.example.com/index.php/the-­news/1-­latest­-news/1­-welcome­-to­-joomla</nowiki></code>.
:3. In Global configuration, select yes to all three SEF options. The action of the three parameters is as follows:
+
#: If your site does not work correctly, please see [[Why does your site get messed up when you turn on SEF (Search Engine Friendly URLs)?]]
::* '''Search Engine Friendly URLs.''' Converts the URLs from the native Joomla! format to the SEF format.
+
# Enable the '''Use Apache mod_rewrite/URL rewriting''' option and ''Save''. This option uses the Apache ''mod_rewrite'' function to eliminate the "index.php" portion of the URL.
::* '''Use Apache mod_rewrite. ''' Uses the Apache "mod_rewrite" function to eliminate the "index.php" portion of the URL. If you don't want to use mod_rewrite, set this to "No" and don't rename the htaccess.txt. The SEF URLs feature will still work. The only difference is that you will see "index.php" in the URL, for example, <code><nowiki>http://www.yoursite.org/index.php/faq.html</nowiki></code>.  
+
#: Check if your site works correctly. Your URLs should now look like <code><nowiki>http://www.example.com/the-­news/1­-latest-­news/1-­welcome-­to­-joomla</nowiki></code>.
::* '''Add suffix to URLs.''' Adds ".html" to the end of URLs.
+
#: If this option causes errors, please see [[How to check if mod rewrite is enabled on your server]].
 +
#:: If it is not enabled and you have access to the file <code>apache/conf/httpd.conf</code>, open that file and check if the line <code>LoadModule rewrite_module modules/mod_rewrite.so</code> is uncommented. If necessary, uncomment the line and restart the Apache web server.
 +
#:: If ''mod_rewrite'' cannot be enabled, leave this option off. It does not matter if you leave the <code>.htaccess</code> file renamed.
 +
# ''If you think this necessary'', enable '''Add suffix to URLs''' and ''Save''. This option adds <code>.html</code> to the end of URLs. There are different opinions on whether this is necessary or even useful. Search engines do not seem to care if your URLs end in <code>.html</code> or not.
 +
# Open the Plugin Manager and enable the '''System - SEF plugin'''. This plugin adds SEF support to links in your Joomla articles. It operates directly on the HTML and does not require a special tag.
 +
</onlyinclude>
  
[[Category:FAQ]]
+
<noinclude>
[[Category:Administration FAQ]]
+
[[Category:Search Engine Friendly URLs]]
[[Category:Getting Started FAQ]]
+
[[Category:Tutorials]]
[[Category:Version 1.5 FAQ]]
+
</noinclude>

Revision as of 06:29, 13 August 2013


<translate> Search engine friendly (SEF), human-readable or clean URLs are URLs that make sense to both humans and search engines because they explain the path to the particular page they point to. Since version 1.5, Joomla! is capable of creating and parsing URLs in any format, including SEF URLs. This does not depend on URL rewriting executed by the web server, so it works even if Joomla! runs a server other than Apache with the mod_rewrite module. The SEF URLs follow a certain fixed pattern, but the user can define a short descriptive text (alias) for each segment of the URL.

Internally, the local part of a SEF URL (the part after the domain name) is called a route. Creating and processing SEF URLs is therefore referred to as routing, and the relevant code is called a router. </translate>

This article addresses SEF URLs under the popular, open-source Apache webserver. SEF URL implementation is possible under Microsoft's IIS webserver as well, please see Enabling Search Engine Friendly (SEF) URLs on IIS.

Joomla 2.5 Since Joomla! 1.6, basic SEF urls are enabled by default. Joomla 1.5 In prior versions you need to use the Global Configuration to enable them. The instructions below still apply if you want to use Apache's mod_rewrite/URL rewriting.

These are step-by-step instructions. Please follow them in the order they are presented here. If a step fails, do not continue until you have solved the problem.

  1. Rename the file "htaccess.txt" in your Joomla!'s base folder to ".htaccess".
  2. This step may not be necessary. Open .htaccess in a text editor. Uncomment RewriteBase / (remove the first character, #). If Joomla is installed in its own folder, the enter the Joomla folder name after the backslash. e.g. RewriteBase /yourjoomlafolder.
  3. Log on to your Back-end and open the Global Configuration.
  4. Enable the Search Engine Friendly URLs option and Save. This option converts the URLs from the native Joomla! format to the SEF format.
    Check if your site works correctly. Your URLs should now look like http://www.example.com/index.php/the-­news/1-­latest­-news/1­-welcome­-to­-joomla.
    If your site does not work correctly, please see Why does your site get messed up when you turn on SEF (Search Engine Friendly URLs)?
  5. Enable the Use Apache mod_rewrite/URL rewriting option and Save. This option uses the Apache mod_rewrite function to eliminate the "index.php" portion of the URL.
    Check if your site works correctly. Your URLs should now look like http://www.example.com/the-­news/1­-latest-­news/1-­welcome-­to­-joomla.
    If this option causes errors, please see How to check if mod rewrite is enabled on your server.
    If it is not enabled and you have access to the file apache/conf/httpd.conf, open that file and check if the line LoadModule rewrite_module modules/mod_rewrite.so is uncommented. If necessary, uncomment the line and restart the Apache web server.
    If mod_rewrite cannot be enabled, leave this option off. It does not matter if you leave the .htaccess file renamed.
  6. If you think this necessary, enable Add suffix to URLs and Save. This option adds .html to the end of URLs. There are different opinions on whether this is necessary or even useful. Search engines do not seem to care if your URLs end in .html or not.
  7. Open the Plugin Manager and enable the System - SEF plugin. This plugin adds SEF support to links in your Joomla articles. It operates directly on the HTML and does not require a special tag.