Aliasredirect module


About

The Aliasredirect module lets you control what happens when someone visits a specific URL in the site. You can use it to automatically send users from one URL to another, for example, when a page has moved or when you want to guide users to a newer version of a page.

You can set redirects for:

  • a single page
  • a group of pages that share similar URLs
  • the entire site’s domain

This is useful when reorganizing content, cleaning up old or unused links, or creating shorter and more user-friendly URLs.

Admin pages always stay accessible, even when a redirect rule technically matches an admin URL, so admins aren’t locked out by mistake.

Avoid circular redirects, such as old.site.com → new.site.com → old.site.com, which will create a redirect loop.

This module is for Video Portal.

Configure

1. Go to your Configuration Management console, and click on the Aliasredirect module. You can also navigate directly using a link: https://{your_KMS_URL}/admin/config/tab/aliasredirect.

The 'Aliasredirect' page displays.

2. Configure the following:

enabled - Set to 'Yes' to enable the module.

Redirect rules

1. Click +Add redirect to add a new rule.

A new section opens.

2. Complete the fields:

redirectFrom - Enter the domain or path that the redirect rule will be applied to. Enter it without http:// or https://

You can also enter an asterisk (*) as the 'redirectFrom' value to match all pages on the site. Use this with the Default redirect type.

redirectTo - Enter the domain or path that the users will be redirected to. Enter it without http:// or https://.

redirectType - Select a type from the drop-down list:

  • Exact match – redirects only the specific URL you entered
  • URL path – redirects any URL containing the text you entered
  • Default – redirects the entire domain to another domain

Example

If you want every page on your site to redirect to a new domain, configure the rule using an asterisk (*):

  • redirectFrom: *
  • redirectTo: new.site.org
  • redirectType: Default

This means that any URL on your current site, such as:

  • my.site.com/media/12345
  • my.site.com/channel/abc
  • my.site.com/some/old/page

will redirect to:

new.site.org

fromTime - Enter when the redirect should start.

You can enter:

  • a Unix timestamp (for example, 1636450693)
  • a UTC datetime string (for example, 2021-11-09T01:02:03)

toTime - Enter when the redirect should end, using the same formats as above.

exclude - Enter any text that should prevent the redirect from being applied. If the URL contains this text, the redirect is skipped. To enter multiple values, separate them with commas.

ConcatenateSlug - Select 'Yes' to add the original URL’s slug to the destination URL. Select 'No' to ignore the slug.

status - Select 'Active' or 'Inactive'. Use this to disable a rule without deleting it. Default is 'Active'.

importRedirects

Use importRedirects to upload a CSV file containing redirect rules.

CSV format

  • No header line
  • Columns: redirectFrom, redirectTo, redirectType, fromTime, toTime, exclude, ConcatenateSlug

Supported values

  • redirectType: default, exact-match, url-path
  • fromTime / toTime: enter 0 if not used
  • exclude: leave empty if not used
  • ConcatenateSlug: 1 (Yes) or 0 (No)

If the field is collapsed, click Expand to open it.

Import - Click Choose file to upload the CSV.

Importing will override all existing redirect rules.

exportRedirects

Use 'exportRedirects' to download a CSV file of all current redirect rules. Click Export redirects to save the file.

3. Click Save to save your configuration settings.

Was this article helpful?
Thank you for your feedback!
User Icon

Thank you! Your comment has been submitted.

In this article
Related articles
Back to top

Never miss a thing!

Subscribe to our customer newsletter and our release notes updates, so you always get the best out of Kaltura.
Newsletter