This is the official documentation for Route 66 Joomla extension.

Introduction

Route 66 is an advanced SEO extension for Joomla that helps you optimize your website for search engines using modern tools and automation. This documentation outlines all features and how to use them.

Key features include:

  • AI Tools
  • SEO Crawler
  • Content SEO Analysis (by Yoast)
  • Content Readability Analysis (by Yoast)
  • Metadata Management
  • Custom URLs
  • Performance Optimizations
  • Robots.txt editing

Looking for Route 66 v1.x series documentation? It can be found at https://www.firecoders.com/documentation/route-66-v1 

Compatibility

Route 66 is compatible with Joomla 5.3 and later. Compatibility with future versions of Joomla! is added through extension updates.

Requirements

Your server needs to meet the Joomla! system requirements, including PHP version 8.2 or higher and MySQL 5.6 or higher. There are no additional server requirements for Route 66.

Installation

To install Route 66:

  1. Download the Route 66 package from our website.
  2. Log in to your Joomla administrator panel.
  3. Navigate to Extensions > Manage > Install.
  4. Upload the Route 66 package and click Upload & Install.

For more details, refer to the official Joomla documentation.

Updating

There are two ways to update this extension:

  • One-Click Update:
    1. Navigate to System > Update Sites.
    2. Find the Route 66 update site and enter your account Download Key, which you can get here.
    3. Go to System > Update > Extensions and click Check For Updates.
    4. Select Route 66 from the list and click Update.
  • Manual Update:
    1. Download the latest version of Route 66 from our website.
    2. Navigate to Extensions > Manage > Install.
    3. Upload the new package; it will automatically overwrite the old version.

    Note: Always back up your site before performing manual updates. An active subscription is required to download Route 66 PRO.

Upgrading from Route 66 v1.x

If you are upgrading to Route 66 v2 from an existing v1.x installation, the extension will automatically detect the upgrade during installation. Upon successful installation, you’ll see a message with a link to complete the upgrade process.

Note: This step is optional and non-critical.

The upgrade process simply imports your existing SEO/Readability Scores and any saved Open Graph metadata into the new version. If you missed the link in the installation message, you can manually run the upgrade at any time by visiting the following URL in your Joomla admin panel:

/administrator/index.php?option=com_route66&view=upgrade

Options

After installing Route 66, it's recommended to configure the component options according to your needs. The default settings should be fine for the majority of sites.

To access the Route 66 options, navigate to Components > Route 66 > Options. The configuration options are divided into several tabs:

URLs

The URLs tab allows you to enable or disable custom URLs for specific Joomla components. Each supported extension has a field for providing a URL pattern. Defining a URL pattern in Route 66 is straightforward. Please refer to URLs section below to learn more.

AI Tools

The AI Tools tab allows to configure your preferred AI service or disable AI Tools. Here are the available options:

Social

The Social tab provides settings for connecting your site's social accounts:

  • Facebook Page: Provide the full URL to your website’s Facebook Page (e.g. https://www.facebook.com/YourPage). This helps Facebook display proper publisher information when your content is shared.
  •  Facebook App ID: Optional. Used for tracking and analytics with Facebook tools like Insights. You only need this if you manage a Facebook app.
  • X/Twitter Account: Enter your official X (formerly Twitter) handle (e.g. @YourUsername). This helps attribute your content when it’s shared on X.
  • Open Graph Image: This image will be used as the Open Graph image for all pages that do not have a specific OG image set. It appears when your content is shared on social media platforms like Facebook, X (Twitter), or LinkedIn. For best results, use an image with a minimum resolution of 1200×630 pixels in JPG or PNG format.

Refer to the Metadata section for more details. 

Performance

The Performance tab controls features which improve the site performance:

  • Defer offscreen images (Lazy loading): Enable or disable images lazy loading.  Lazy loading is the strategy of loading resources as they are needed, rather than in advance. This approach frees up resources during the initial page load and avoids loading assets that are never used.
  • Restriction mode: Set restrictions for images lazy loading. Choose between "None" (Lazy loading will be applied to all images in the page), "Inclusive" (Lazy loading will be applied only to images with the specified class name) and "Exclusive" (Lazy loading will be applied to all images in the page except those with the specified class name). 
  • Defer offscreen iframes (Lazy loading): Enable or disable iframes lazy loading.  Lazy loading is the strategy of loading resources as they are needed, rather than in advance. This approach frees up resources during the initial page load and avoids loading assets that are never used. 
  • Restriction mode: Set restrictions for iframes lazy loading. Choose between "None" (Lazy loading will be applied to all iframes in the page), "Inclusive" (Lazy loading will be applied only to iframes with the specified class name) and "Exclusive" (Lazy loading will be applied to all iframes in the page except those with the specified class name). 
  • Replace iframes with facades: When enabled replaces iframes with light, static versions (facades) to avoid third-party assets loading until the facade is clicked by user. This works only for YouTube and Vimeo embeds at the moment. 
  • Restriction mode: Set restrictions for iframe facades. Choose between "None" (Facades will be generated for all iframes in the page), "Inclusive" (Facades will be generated only for iframes with the specified class name) and "Exclusive" (Facades will be generated for all iframes in the page except those with the specified class name). 
  • Inline & Minify CSS: When enabled, all local CSS files will be combined, minified, and inlined into the HTML output. This may improve page load performance but can cause layout issues in rare cases. Use with caution and test thoroughly. 

Sitemaps

The Sitemaps tab has a single option for sitemaps URLs limit:

  • Number of URLs per sitemap: Define the maximum number of URLs for a sitemap. We recommend leaving this to 500.

Refer to the Sitemaps section to learn how you can create a sitemap for your site.

Advanced

The Advanced tab helps manage several options:

  • Site URL: The URL used by the crawler to access your site. This is set automatically during installation. You should only change it if your site’s domain changes or if your front-end and back-end use different domains.
  • Crawler Concurrency: Number of pages to crawl in parallel. Higher values speed up crawling but may increase server load and affect response time measurements. Lower values provide more accurate performance data.
  • Canonical URLs: Automatically adds a canonical tag to your pages to help search engines understand the main version of each URL. This improves SEO and helps avoid duplicate content issues.
  • Exclude Components from Canonical URLs:  Select any extensions you want to exclude from automatic canonical URL generation. This is useful when an extension already adds its own canonical tag or when automatic detection may not work correctly.
  • Custom Meta Tags: Paste any additional tags you want to include in the of every page. This is useful for things like site verification (e.g. Google Search Console, Bing Webmaster Tools, Pinterest), or other third-party services. You can add multiple meta tags by placing each tag on a new line. Make sure to include the full and valid tag(s). Example: .
  • Enable Versions: Enable or disable version history for Route 66. This is used to keep editing history for AI Tools and robots.txt.
  • Maximum Versions: The number of versions to store for AI Tools and robots.txt editing.

Permissions

The Permissions tab allows you to manage access control for different user groups. Joomla's Access Control List (ACL) system is used here. Actions include:

  • Configure ACL & Options: Control access to permissions and options.
  • Configure Options: Control access to options.
  • Access Administration Interface: Restrict access to the admin interface.

Crawl your site

After installing and configuring Route 66, the next step is to crawl your site to collect SEO-related data.

To start a crawl:

  1. Go to Components > Route 66 > Pages
  2. Click the “Crawl” button.

Important: Crawling may take some time depending on your site’s size and your server’s performance. Do not close or navigate away from the page while crawling is in progress.

If the crawl is interrupted (for example, if you leave the page), Route 66 will detect the unfinished task. When you return to Components > Route 66 > Pages, you’ll see a message indicating that a crawl task is still running.

If the crawler shows no activity for more than 5 minutes, the task is considered incomplete. You’ll be given the option to:

  1. Resume the crawl
  2. Discard the unfinished task and start fresh

Crawl Report

Each crawled page has a report tab where you can find crawled data info and crawl related issues.

Crawling via Command Line (PRO Version Only)

The PRO version of Route 66 supports command-line crawling using Joomla’s CLI system. This is ideal for large sites or users who want to minimize web server load.

To run a crawl from the command line:

  1. Connect to your web server via SSH.
  2. Change directory to your Joomla CLI folder:
    cd /YOUR/SITE/PATH/cli
  3. Verify the CLI commands are available:
    php joomla.php list
    You should see the list of Joomla CLI commands, including route66:crawl.
  4. Run the crawler:
    php joomla.php route66:crawl

Understanding Slow Page Alerts (False Positives)

Route 66 flags pages as slow if their response time exceeds 1 second. However, during a crawl, Route 66 uses multiple simultaneous connections to process pages in parallel. This can temporarily increase server load, especially on shared hosting, and result in false positives.

If your pages appear slow in the crawler but load quickly in your browser, try lowering the Crawler Concurrency setting in Route 66 configuration.

Automatic Page Discovery (PRO Version Only)

With Route 66 PRO, new pages are automatically discovered and added to the crawl list as your site receives traffic. This is especially useful for frequently updated sites — you no longer need to initiate a full crawl every time new content is published.

Refreshing Page Data Automatically

Route 66 uses Joomla’s Scheduled Tasks API to refresh crawled page data.

To set this up:

  1. Navigate to System > Scheduled Tasks
  2. Click New
  3. Choose the task type: Route 66: Refresh Pages Data
  4. Set a title and choose a suitable frequency: 
    • Every 15 or 30 minutes for frequently updated sites
    • Once per day (or less) for low-activity sites
  5. Save the task

This ensures your SEO data stays up to date without requiring manual crawling.

Configuring Cloudflare to Whitelist the Crawler IP

If your site is behind Cloudflare and you have enabled a JavaScript (JS) Challenge for incoming requests, the SEO Crawler may be blocked or delayed when trying to scan your site. To ensure smooth crawling, you can configure Cloudflare to bypass this challenge for the crawler’s IP address.

This is done by creating an IP-based exception in Cloudflare’s Security Rules.

Steps to Configure an IP-Based Exception for the SEO Crawler

  1. Log in to your Cloudflare Dashboard.
  2. Select the domain you want to configure.
  3. Navigate to Security → Security Rules.
  4. Click Create a Custom Rule.
  5. In the When incoming requests match… section, set the condition:
    • Field: IP Source Address
    • Operator: equals
    • Value: Your server’s origin IP address (the IP where the SEO Crawler runs).
  6. Under Then… set the Action to Skip (JS Challenge).
  7. Save and deploy the rule.

Important Notes

  • Your origin IP is provided by your hosting provider. In most cases, if you have a dedicated server or VPS, the IP remains static.
  • If your hosting provider changes your origin IP, the crawler will no longer be able to bypass the challenge until the new IP is updated in Cloudflare’s DNS and Security Rules.
  • Only add trusted IP addresses to this exception to prevent abuse.

Pages Management

Perform SEO tasks on a page-by-page basis via Components > Route 66 > Pages. This offers a unified editing experience and is ideal for large-scale SEO reviews.

Pages List

The Pages List displays all the crawled pages:

  • Title: Page title with a link to the page.
  • Issues: Labels of detected issues.
  • SEO: The SEO rating of the content of this page. This is powered by Yoast. Note that this is computed when editing the page through Route 66 or when the resource is edited on the third-party extension. 
  • Readability: The readability rating of the content of this page. This is powered by Yoast. Note that this is computed when editing the page through Route 66 or when the resource is edited on the third-party extension. 
  • Status: HTTP response status of the crawled page.
  • Size: Size of the crawled page in kilobytes.
  • Time: The time it took to crawl that page in milliseconds.
  • ID: Unique page ID.

Actions Menu

  • Crawl: This will delete all previously crawled data and re-crawl your site from scratch. User-provided metadata and content analysis scores will not be affected.
  • Purge: This will permanently delete all crawled data. User-provided metadata and content analysis scores will not be affected.
  • Full Reset: This will permanently delete all crawled data, user-provided metadata, and content analysis scores. This action cannot be undone.

Editing Pages

There is no actual edit of a crawled page - The edit view is used to perform one of the following tasks in an already crawled page:

  • Refresh Page Data: Crawl the page again and update its data.
  • Run SEO analysis: Provide a focus keyphrase and see the SEO analysis of the contents of the page.
  • Run Readability analysis: View the readability analysis of the contents of the page.
  • Update Search Metadata: Update page metadata like title and meta description.
  • Update Social Metadata: Set page metadata for sharing with social networks.

AI Tools Management

Route 66 provides a comprehensive AI Tools management system for administrators. Access it via Components > Route 66 > AI Tools. The system allows you to edit, filter, and reorder AI tools.

AI Tools List

The AI tools list displays all available AI tools with details:

  • Status: Enabled or Disabled.
  • Title: The title of the tool with short description below.
  • Type: The type of the tool. "Core" is used for built in tools while "Custom" is used for user defined AI tools.
  • ID: Unique tool ID.

Filtering Options

Use the Filter Options to manage AI tools efficiently:

  • Status: Filter by Enabled or Disabled.

Actions Menu

The Actions Menu allows bulk management of the AI Tools:

  • Enable: Publish selected tools.
  • Disable: Disable selected tools.
  • Delete: Permanently delete tools. Note that core AI Tools cannot be deleted.

Adding/Editing AI Tools

Route 66 allows you to edit core AI Tools or create new AI Tools!

In order to create or edit an AI tool, the following fields must be filled:

  • Title. This is the display title of the tool. This is used in the AI Tools modal.
  • Description. This is a short description of the tool. This is used in the AI Tools modal.
  • Enabled. Choose to enable or disable the tool.
  • Prompt.  This is the main prompt template sent to the AI model. You can include dynamic placeholders such as {title}, {keyphrase}, {text}, and {language}. These will be automatically replaced with actual values when the prompt is executed. 
  • Instructions (System Prompt).  This is the system message sent to the AI model to define its role and behavior. Use it to set the assistant’s tone, expertise, and goals (e.g. “You are an SEO expert. Write concise, high-impact titles.”). 
  • Temperature. Controls the creativity of the AI’s responses. Lower values (e.g. 0.2) make output more focused and predictable, while higher values (e.g. 0.8) make it more diverse and creative. Recommended range: 0.5 to 0.7. 
  • Target Property.  Specifies which part of the resource this tool is designed to populate, such as the SEO title, meta description, or Open Graph content. Used internally to determine where the AI output should be applied. 

Sitemaps Management

Create or manage sitemaps via Components > Route 66 > Sitemaps. The system allows you to edit, filter, and reorder XML sitemaps.

Sitemaps List

The Sitemaps List displays all created sitemaps:

  • Title: Sitemap title with a link to the sitemap.
  • Status: Published or Unpublished.
  • ID: Unique sitemap ID.

Actions Menu

The Actions Menu allows bulk management of the XML Sitemaps:

  • Enable: Publish selected sitemaps.
  • Disable: Disable selected sitemaps.
  • Delete: Permanently delete sitemaps.

Adding/Editing Sitemaps

To create a sitemap:

  1. Click New in the Sitemaps view.
  2. Provide a Title.
  3. Set sitemap sources.
  4. Set the Status (Published, Unpublished).
  5. Set the Sitemap Type (Standard, News).
  6. Choose whether to Include Images.
  7. Choose whether to Include Videos.
  8. Save the sitemap.

Edit robots.txt

Edit robots.txt via Components > Route 66 > Edit robots.txt. The system allows you to edit the site's robots.txt directly from the administration area. 

AI Services

AI Tools are using popular AI services behind the scenes. Note that those services are paid services so additional costs may occur. To set up AI services:.

Choosing an AI Service

Available services:

  • OpenAI: Leading AI research and deployment company known for developing advanced language models like ChatGPT.
  • Anthropic: Focuses on building reliable and steerable AI systems, with its flagship assistant Claude emphasizing safety and alignment.

Configuring OpenAI

Select OpenAI in the component options as the AI tools service.

  1. Choose an OpenAI Model. At the moment we support GPT-4o, GPT-4.1 mini and GPT-3.5 Turbo. We recommend selecting GPT-4.1 mini for optimal balance of performance and cost. Different models have different capabilities and cost. Learn more at https://platform.openai.com/docs/models 
  2. Get an API Key. Visit https://platform.openai.com/api-keys  to get your API key.

Configuring Anthropic

Select Anthropic in the component options as the AI tools service.

  1. Choose the Anthropic Model you wish to use. We recommend selecting Claude 3.5 Sonnet for optimal balance of performance and cost. Different models have different capabilities and cost. Learn more at https://docs.anthropic.com/en/docs/about-claude/models/overview
  2. Get an API Key. Visit https://console.anthropic.com/settings/keys to get your API key.

Metadata

Search Metadata

Search metadata helps define how your pages appear in search engine results. With Route 66, you can easily customize the most important metadata elements for SEO visibility:

  1. Title. The clickable headline shown in search results. It should be clear, relevant, and within the recommended character length
  2. Description. A short summary that appears below the title in search results. Use it to encourage clicks by describing the page content clearly.
  3. Robots. Controls how search engines index and follow the page (e.g., index, noindex, follow, nofollow)
  4. Canonical. Defines the preferred version of a URL to avoid duplicate content issues

These fields are available in the Route 66 interface when editing individual pages, giving you full control over how your content is represented in search engines.

Social Metadata

Social metadata controls how your pages appear when shared on social platforms like Facebook, LinkedIn, and X (formerly Twitter). Route 66 lets you customize key Open Graph and Twitter Card tags to ensure your content looks polished and engaging across networks:

Open Graph (used by Facebook, LinkedIn, and others):

  1. Open Graph Title.The title shown when your page is shared.
  2. Open Graph Description. A brief summary that appears below the title.
  3. Open Graph Image. The preview image displayed in the post.
  4. Open Graph type. The content type (e.g. article, website), helping platforms interpret your content correctly.

X/Twitter Metadata (Twitter Cards):

  • X/Twitter Title. The headline used when your page is shared on X.
  • X/Twitter Description. A short description that appears beneath the title.
  • X/Twitter Image. The image shown in the Twitter card preview.

By customizing these fields, you can control how your content looks when shared — improving click-through rates and reinforcing your brand presence on social media.

Setting Metadata

Route 66 lets you manage search engine and social media metadata in two easy ways:

  1. Via Crawled Pages
    Go to Components > Route 66 > Pages to view all crawled pages. Click on a page to open its details. Use the “Search” and “Social” tabs to update metadata. Don’t forget to save your changes.
  2. Via Extension Edit Forms
    Where supported, Route 66 adds extra tabs to existing edit forms (or inside a toolbar dropdown). These tabs let you set metadata for specific resources directly within the extension.

SEO Analysis & Readability

Route 66 includes SEO and readability analysis powered by Yoast, giving you insights and suggestions to improve your content. You can access this in two ways:

  1. Via Crawled Pages
    Go to Components > Route 66 > Pages and click on a page. Use the “SEO” and “Readability” tabs to view suggestions. To enable analysis, make sure to set a focus keyphrase under the SEO tab. Save the page to store the results and use them later for filtering or reporting.
  2. Via Extension Edit Forms
    Where supported, Route 66 shows additional tabs in the edit form (or in a toolbar dropdown) that let you enter a focus keyphrase and instantly see SEO and readability scores.

URLs

Route 66 allows you to define URL patterns and automatically generate SEO-friendly URLs for your site. This is especially useful for websites with a large amount of content, where creating individual menu items for each page is not practical.

Instead of manually creating menu links, you can configure a URL pattern and let Route 66 handle the URL generation dynamically.

For smaller websites, we recommend continuing to use Joomla menu items and skipping this feature.

Note: Existing Joomla menu items always take priority over Route 66 URL patterns. For example, if you have a menu item pointing to an article, any matching Route 66 pattern will be ignored for that article.

Enabling Custom URLs

Navigate to Components > Route 66 > Options > URLs and set a URL pattern for each supported extension.

URL Patterns

URL patterns in Route 66 can include both static text and dynamic variables—called tokens. Tokens are enclosed in curly braces, like {articleAlias} or {categoryAlias}. Each supported third-party extension provides its own set of tokens.

Some of these tokens are designated as identifier tokens, which are required to ensure that each URL is unique. A valid URL pattern must include at least one identifier token—such as {articleAlias} or {articleId}.

When creating a URL pattern in Route 66, the available tokens for the selected extension will appear below the input field. Identifier tokens are shown in bold to emphasize their importance.

Examples of valid URL patterns:

  • blog/{articleYear}/{articleMonth}/{articleAlias}
  • {categoryAlias}/{articleAlias}
  • {articleAlias}
  • page-{articleId}

Module Assignments

Your module assignments will continue to function as before, even if Route 66 changes your URLs.

For example, suppose you have a menu link to a category named "Cars" and have assigned modules to display on that page, accessible via the URL /cars. Route 66 might generate article URLs that do not include the /cars part, depending on your URL pattern. However, the modules assigned to the "Cars" category page will still display on the article pages within that category. This behavior aligns with Joomla!'s default functionality.

Route 66 automatically detects and assigns the correct modules, so you do not need to make any changes to your site's structure.

Supported Extensions

Below is a list of supported extensions along with their available tokens. Identifier tokens are marked in bold. Remember, you must include at least one identifier token in your URL pattern.

Type Tokens Available in
Joomla! Article {articleId}, {articleAlias}, {articleYear}, {articleMonth}, {articleDay}, {articleDate}, {articleAuthor}, {categoryAlias}, {categoryPath} Free & PRO
Joomla! Article Category {categoryId}, {categoryAlias}, {categoryPath} Free & PRO
Joomla! Tag {tagId}, {tagAlias} Free & PRO
JoomCCK Record {recordId}, {recordAlias}, {sectionAlias}, {categoryAlias} PRO only
Virtuemart Product {productId}, {productAlias}, {productSku}, {productYear}, {productMonth}, {productDay}, {productDate}, {productAuthor}, {categoryAlias}, {categoryPath} PRO only
Virtuemart Category {categoryId}, {categoryAlias}, {categoryPath} PRO only
HikaShop Product {productId}, {productAlias}, {productSku}, {productYear}, {productMonth}, {productDay}, {productDate}, {categoryAlias}, {manufacturerAlias}, {categoryPath} PRO only
HikaShop Category {categoryId}, {categoryAlias}, {categoryPath} PRO only
eShop Product {productId}, {productAlias}, {productSku}, {productYear}, {productMonth}, {productDay}, {productDate}, {categoryAlias} PRO only
Firecoders
Are you using our extensions? Please post a review at the Joomla extensions directory!
Post a review