README

Repository: https://gitlab.sgalinski.de/typo3/sg_routes

Please report bugs here: https://gitlab.sgalinski.de/typo3/sg_routes

Note: sg_routes can be used for free or by buying a license key from our online shop. You can enter the license key in the extension manager configuration of sg_routes.

Features excluded from the free version:

Regular expression routing
.htaccess Redirect rules generation
The Redirect Log view

About

With this extension you can simply create and manage URL redirects for your page and generate redirect rules for your .htaccess file.

Important note!

sg_routes is a multi-domain extension so before you use the configuration module, make sure that all the domains in your installation have correctly configured domain records for their site-root page.

You can find more information here.

The Backend Module

After a successful Installation, you have a new module in the "WEB" section of your TYPO3 Backend.

Clicking on it loads the administration panel. Using the drop-down above you can switch between the 'Redirect Management', 'Redirect Log' and the 'Page Not Found Handling' views.

The Redirect Management view

Here, all your custom URL routes are listed. The list can be filtered by Categories and search words. You can also create, update and delete your routes and categories.

Note: To create a route/category, you need to first select a page in the page tree.

The Redirect Log view

In this view, you can find logs of when your route records were used to redirect the users of your website, and also the time it took for each redirect to execute (in seconds).

Note: Depending on how often the redirects are triggered, the log database table can get pretty large. To handle this, you will find a scheduler 'garbage collection' task registered for the tx_sgroutes_domain_model_log table. It is recommeded to set up this task after you've installed the extension and make sure that it is periodically triggered by the scheduler. If you haven't done so already, you can find more info about how to set up the cron job for the scheduler extension by following this link

Usage

Creating a redirect rule

In your backend module, click on the "Create" button. Now enter from which url(Source URL) you want to redirect to (Destination URL) and whether you want it to be a permanent (301) or a temporary redirect (302).

Example: You want to redirect temporarily from your starting page to the contact page

Source URL : /

Destination : /contact

Redirect Code: 302

Description: Here you can add a custom description for your rule, visible in the backend overview

When creating/editing a rule, you have also the option to Use regular expression. By checking this, the Source URL is evaluated as a regular expression and is matched against the request url. If a match is found and, the rule is applied with a rewrite based on the Destination URL.

Example: You want to redirect permanently from your /news/... pages to /blog/...

Source URL : ^/news/(.+?)$

Destination : /blog/$1

Redirect Code: 301

Note: The rules are evaluated in the order you see them in the BE module list. Take this into account when creating new rules, and that you can adust the order of the rules by using the , , buttons

Options for your redirect rule

After you created one or more redirect rules, you get a list overview in your backend module of all rules.

You can click on a rule to edit it or use the menu buttons:

Edit
Disable/Enable
Delete
.... Expand/Collapse the options menu
Show further information
Show history
Versioning
Create new
Move up
Move down
Copy
Cut
Paste after

Export your redirect rule(s) to your .htaccess file

It is a good practice to insert your redirect routes into your .htaccess file for better performance.

Simply click the " htaccess" button and copy & paste the textarea content into your .htaccess file.

If all works, you can now delete your routes with the " Delete all" Button.

Note: Be aware that the "htaccess" and "Delete all" actions will for the current rule filter options. So only the rules you can see in the paginated list will be taken into account.

Developer Guide

TYPO3 Bootstrap Hook

To have the best Performance, this extension hooks into the TYPO3 bootstrap mechanism as early as possible, after the domain root-page is identified.

This is done inside the ext_localconf.php with a configuration array by supplying a path to the desired hook function SGalinski\SgRoutes\Service\RoutingService->hook. By extending or replacing this function, it is possible to implement more complex redirect / rewrite rules.

You can find more information on hooks in the TYPO3 Documentation.

FAQ

Why should I put my redirect rules into the .htaccess file?

You get a slightly better performance for your website by doing this.

I get the error "Too many redirects" when trying to open my website

You are most likely stuck in a redirect loop. Backup your routes by copying up your .htaccess entries and reset all your changes. Try to determine if you have created an endless loop with your routes, for instance:

/home redirects to /contact
/contact redirects to /support
/support redirects to /home

sgalinski / sg-routes

Maintainers

Details