ARTIO JoomSEF Documentation

version 2.2.3
compatible with Joomla 1.0.x
by ARTIO s.r.o.
last updated on 24th October 2007

Table of contents

  1. Introduction
  2. Licence
  3. Installing and Configuring
    1. Installation
    2. Configuring IIS
    3. Uninstall
    4. Configuration Checklist
    5. Non-latin languages
    6. Automatic Updates
  4. Useful Usage Tips
    1. Configuration
    2. Optimization
    3. Preventing duplicates
    4. Cache
    5. Patch System
    6. JoomFish Support
    7. Component Configuration
    8. Modifying URLs
    9. Metadata organization - JoomSEF Metabot
    10. Backing up your custom URLs
  5. Supported Joomla! Components
    1. Joomla! Built-in Components
    2. 3rd Party Components
    3. List of Official Extensions Available
    4. Extension installation
    5. Extension Parameters
  6. Support and Help
  7. Donate to JoomSEF
  8. Advertisement Notice
  9. Change log
  10. Credits
  1. Introduction

    ARTIO JoomSEF is a Joomla! component that generates and allows creation of Search Engine Friendly (SEF) URLs for Apache and IIS, returns proper 404 status code for missing content, provides logging of 404 errors, and creation of special "shortcut" URLs that allow the user to redirection to the new URL.

    Starting with version 1.3.0 JoomSEF also allows control of specific meta tags, such as description or keywords for each generated URL. JoomSEF comes with SEF support for most popular Joomla! components. Some of those are delivered free as part of the JoomSEF instllation package and some are also available under commerial licence. If you are missing a support for your favourite component, ARTIO may develop it on request.

    This documents describes how to install and setup ARTIO JoomSEF Joomla! component. You can view this documentation again by selecting the "ARTIO JoomSEF Documentation" button from the ARTIO JoomSEF Control Panel.

  2. Licence

    This software is distributed under following licensing conditions. By installing and using this software, you agree to bind to the licence conditions.

  3. Installing and Configuring

    You can view installation instructions below by clicking the appropriate arrow.

    If your .htaccess file was set as writable the install may have updated it already and you shouldn't have to worry about it.

    If your site is in a subdirectory be sure to change the RewriteBase line accordingly. ex/ RewriteBase /joomla

    1. Installation

      1. Upload the zip file to Joomla! using the component installer in the usual way.
      2. For apache, set your ".htaccess" file like this:
        ##
        # @version $Id: htaccess.txt 2368 2006-02-14 17:40:02Z stingrey $
        # @package Joomla
        # @copyright Copyright (C) 2005 Open Source Matters. All rights reserved.
        # @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
        # 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
        # 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.
        #
        # Only use one of the two SEF sections that follow.  Lines that can be uncommented
        # (and thus used) have only one #.  Lines with two #'s should not be uncommented
        # In the section that you don't use, all lines should start with #
        #
        # For Standard SEF, use the standard SEF section.  You can comment out
        # all of the RewriteCond lines and reduce your server's load if you
        # don't have directories in your root named 'component' or 'content'
        #
        # If you are using a 3rd Party SEF or the Core SEF solution
        # uncomment all of the lines in the '3rd Party or Core SEF' section
        #
        #####################################################
        
        #####  SOLVING PROBLEMS WITH COMPONENT URL's that don't work #####
        # SPECIAL NOTE FOR SMF USERS WHEN SMF IS INTEGRATED AND BRIDGED
        # OR ANY SITUATION WHERE A COMPONENT's URL's AREN't WORKING
        #
        # In both the 'Standard SEF', and '3rd Party or Core SEF' sections the line:
        # RewriteCond %{REQUEST_URI} ^(/component/option,com) [NC,OR] ##optional - see notes##
        # May need to be uncommented.  If you are running your Joomla! from
        # a subdirectory the name of the subdirectory will need to be inserted into this
        # line.  For example, if your Joomla! is in a subdirectory called '/test/',
        # change this:
        # RewriteCond %{REQUEST_URI} ^(/component/option,com) [NC,OR] ##optional - see notes##
        # to this:
        # RewriteCond %{REQUEST_URI} ^(/test/component/option,com) [NC,OR] ##optional - see notes##
        #
        #####################################################
        
        
        ##  Can be commented out if causes errors, see notes above.
        Options FollowSymLinks
        
        #
        #  mod_rewrite in use
        
        RewriteEngine On
        
        
        #  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 Standard SEF Section
        ## ALL (RewriteCond) lines in this section are only required if you actually
        ## have directories named 'content' or 'component' on your server
        ## If you do not have directories with these names, comment them out.
        #
        #RewriteCond %{REQUEST_FILENAME} !-f
        #RewriteCond %{REQUEST_FILENAME} !-d
        #RewriteCond %{REQUEST_URI} ^(/component/option,com) [NC,OR] 		##optional - see notes##
        #RewriteCond %{REQUEST_URI} (/|\.htm|\.php|\.html|/[^.]*)$  [NC]
        #RewriteRule ^(content/|component/) index.php
        #
        ########## End Standard SEF Section
        
        
        ########## Begin 3rd Party or Core SEF Section
        #
        #RewriteCond %{REQUEST_URI} ^(/component/option,com) [NC,OR] 		##optional - see notes##
        RewriteCond %{REQUEST_URI} (/|\.htm|\.php|\.html|/[^.]*)$  [NC]
        RewriteCond %{REQUEST_FILENAME} !-f
        RewriteCond %{REQUEST_FILENAME} !-d
        RewriteRule (.*) index.php
        #
        ########## End 3rd Party or Core SEF Section
        
        ########## 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 set a mosConfig value through the URL
        RewriteCond %{QUERY_STRING} mosConfig_[a-zA-Z_]{1,21}(=|\%3D) [OR]
        # Block out any script trying to base64_encode crap to send via URL
        RewriteCond %{QUERY_STRING} base64_encode.*\(.*\) [OR]
        # Block out any script that includes a