Redirect Module Installation Guide

CSV or Content

When configuring the Redirect module, there is the choice of using:

• a CSV file of redirects (from URLs, and target URLs), that is uploaded through Terminalfour
• individual Content Items added for each redirect that is required

The benefit of the CSV file is that it is much quicker and easier to create the initial batch of redirects. But, the target URLs (the URLs to which you are redirecting) are all hard-coded. This means that if the URL for the target page changes, it needs to be manually updated in the CSV file. The benefit of the individual Content Items for each redirect is that the target page is selected using a Section Link element, and the link is therefore created, managed and updated by Terminalfour if the URL changes.

This installation guide covers both methods, but mentions the steps/assets/fields that are only required for specific methods. Select which method you would like to use before installating and configuring the module.

Server Requirements

The Redirect Module requires PHP 5.3+ to be installed on the webserver that will host the site, and on the staging server (if this is a separate server). Also, the following extensions should be enabled:

• mbstring.so

You will also need to configure your webserver for a 404 page if it hasn't already been done.

Create the 404 Page

To use the Redirect Module, your 404 page needs to be a page that is generated by Terminalfour CMS. The easiest way to do this is to create a normal page on your site, which publishes to /404 and configure Apache / IIS to use this page as the 404 page.

Create the Section

If it doesn't already exist, create a Section to manage your 404 page.

You may show/hide Sections from navigation as desired, but it would normally be hidden from navigation.

Add Content

Add content to your 404 page, explaining that the user has entered a URL that doesn't exist. Consider adding links to commonly requested pages, a search box, etc.

Publish and Test

Publish your channel and go to /404 and check that your page has published and looks correct.

Configure IIS / Apache

Ensure that Apache / IIS on your web server is configured for your 404 page to be the URL that you've created. For example:

ErrorDocument 404 /404/

If Terminalfour hosts your servers for you, contact your support team and they will configure Apache / IIS for you!

If you have a staging site, it is useful to do the same configuration on the staging server too.

To check that this is working correctly, navigate to a URL on your website that doesn't exist, and ensure that your 404 page is displayed.

Required Assets

You must enable the following in your installation. Further details on each asset are provided if required.

File Extensions

This file extension must be allowed on the Channel with which you’re using the Redirect Module.

Media Types

PHP Media Type must be created if it does not already exist and must be set to always publish on the Channel with which you’re the Redirect Module.

Media Files

The required files can be downloaded from the Terminalfour Community Site which requires authentication through the product.

Lists

Navigation Objects 

Content Types

Section

Page Layout

No specific Page Layout is required. It will be necessary to edit the header of the Page Layout used for the 404 Page, adding the Related Content Navigation Object for Redirect Module PHP Code.

Create Required Assets

File Extensions: PHP

If you haven't already, set up PHP as a file extension and enable the extension on your Channel.

Remember to enable the Channel to Publish this file extension and rebuild the cache.

Media Layouts

Path Content Layout

Go to Assets > Content Types and search for the Media System Content Type. If it does not already exist, add a Content Layout named "path/*". In the Content Layout code input field add the following:

<t4 type="content" name="Media" output="file" />

Media Type

When the Content Layout has been created, go to System Administration > System Settings > Media Library and, in the Media Types tab, add the following Media Type:

PHP File

If it does not already exist, create a PHP Media Type and associate the "path/*" Content Layout with it:

Media Files

Main PHP File

In the downloaded zip, in the media-library directory, you will find a file named Smart_404_as_Content_Layout.php. This should be uploaded into your Terminalfour Media Library, selecting the Media Type as PHP File.

Lists

If it does not already exist, create a List with one List item named "Yes".

List Name: Yes

List Items

Content Types

The following Content Types should be created. Associated Content Layouts are also listed.

Redirect Module

Create a "Redirect Module" Content Type using the following General options (anything not mentioned may be left at default):

Name: Redirect Module

Description: Content to handle the Redirect Module Smart 404 PHP Code

text/php-head Content Layout

text/html (Main Channel Layout) Content Layout

This is the default layout that is used by the channel - most often this is text/html but that may vary based on your Channel settings.

text/csv-ptof Content Layout

This layout is only required if you are managing your redirects in a CSV File. If you are adding individual redirects using the Redirect Content Type, this layout can be ignored.

Redirect Content Type

If you are managing your redirects by adding individual Content Items for each redirect (as opposed to uploading a CSV file), then create a Content Type for the Redirects.

Name: Redirect

Description: Create a redirect from a URL to another Section/Content Item on the site.

Content Layout

This layout is used by the PHP Redirects: get CSV Lines Navigation Object, to create a CSV file of the redirects.

Navigation Objects

get php Head

A Related Content Navigation Object is used to get the PHP Code and place in the header of the Page Layout

Go to the Page Layout used for your 404 Page and add the Navigation Object in the header before anything else in your Page Layout.

PHP Redirects: create CSV File

Only required if you are managing your redirects by adding individual Content Items for each redirect.

If you are managing your redirects by adding individual Content Items for each redirect (as opposed to uploading a CSV file), then create a Generate File Navigation Object that is used to create the CSV file.

Update the Navigation Object ID in the Redirect Module Content Type's text/html layout.

PHP Redirects: get CSV Lines

Only required if you are managing your redirects by adding individual Content Items for each redirect.

If you are managing your redirects by adding individual Content Items for each redirect (as opposed to uploading a CSV file), then create a Publish to one File Navigation Object that is used to create a CSV file from Redirects content for the CSV Redirect PHP code.

Update the Navigation Object ID in the Redirect Module Content Type's text/csv-ptof layout.

Create the CSV File of Redirects

Only required if you are managing your redirects by uploading a CSV file of redirects.If you are using a CSV file for the redirects, create a CSV File. This is structured as two columns, one for the From URL and one for the To URL. This may look similar to:

/business/,/school-of-business/
/about/,/about-us/
/2020/,/news/news-archive/2020/

Wildcard Characters

It is possible to use a wildcard character in the From URL, To URL, or Both URLs (although specifying it in the To URL without specifying in the From URL will be nonsensical).

The following scenarios illustrate the functionality of wildcards within the redirects (where * is used as the wildcard):

Create Content

Enable the Content Type

Enable the Redirect Module Content Type on your 404 Section:

Create Content Item

Add content to the 404 Section as follows:

If you are creating redirects using the Redirect Content Type, create a test redirect in the 404 Section:

Publish and Test

Publish your channel and navigate to a page that doesn't exist on your site - ensure that you can see your 404 page.

If using the CSV file to configure redirects, navigate to one of the From URLs specified in your CSV file, and ensure that you are redirected to the appropriate To URL. Or, if using the Redirect Content Type, navigate to /testingredirect and ensure that you are redirected to the Section that was selected as the target Section.