This module adds an interface in the CMS to allow a user to edit and manage URL Redirects in one place. The module supports multi-site instances and multi-culture sites (more details below). The latest version of this module is Version 12.0.4. The source code for this module is included in this repo if you wish to clone and modify it anyway you see fit.
Changes from 12.0.3:
- A revert of many of the changes made in 12.0.3 due to a multitude of issues found during testing of this version. 12.0.4 reverts most of the code base back to what the module was in 12.0.2.
- Bug fix to address default site not being set on save if left on value "(current site)"
- .NET 4.6.1 or greater
- Kentico Version 12.0.52 or greater
- Compatible with all development styles of Kentico (MVC, Portal Engine, ASPX, etc.)
PLEASE NOTE: Due to 12.0.4 being a major revert of 12.0.3, you must completely uninstall the module if you are running this version before installing the latest version. Not doing so may have unintended side effects.
Install the latest version of the Kentico URL Redirection nuget package
Install-Package KenticoUrlRedirection
For MVC: Install this nuget package ONLY to the CMSApp project of your MVC solution. Then, add a reference to the DLL to your MVC project. Do not install this nuget package into both the CMSApp and MVC projects.
After installation, check the event log of the site and you should see a line like this:
To update the module to a more recent version, simply update the NuGet package.
IMPORTANT - Please note that there are a few limitations with this module that require that your site be configured a certain way to work properly. Look below and take note of the required setup for your configuration.
Single Site and Single Culture
If your site is a single domain and single culture, you must specify the default visitor culture as the default culture of your site. If this is not set, the redirects will not work. To do this, follow these steps:
- Go to Applications>Configuration>Sites
- Edit the site
- Select the Culture of your site from the "Visitor Culture" drop down (in this example it is English)
- Click Save
Multiple Sites and Single Culture
If your site is a single culture but multiple domains, then the above steps for "Single Site and Single Culture" must be done on each of your Kentico sites in your CMS.
Single Site and Multiple Cultures - Domain Aliases
If your site is a single site but uses different domain aliases for each culture then you must specify which language each domain:
- Follow the steps for "Single Site and Single Culture" and set the main domain's culture to your primary culture
- Click on Domain aliases in the left hand tabs
- For each domain aliases, select the appropriate culture. In this example, de. is German and fr. is French
Multiple Sites and Multiple Cultures - Domain Aliases
If you have multiple sites and unique domain aliases for the different culture on each site, then the above for "Single Site and Multiple Cultures - Domain Aliases" must be done on each of yoru Kentico sites in your CMS.
Single Site and Multiple Cultures - Language Aliases
If you have a single site that has multiple cultures but use language aliases as opposed to unique domain aliases, then no additional setup is needed. The main site domain will be used in conjunction with the configured language aliases to determine if a redirect applies to the site/culture.
Multiple Sites and Multiple Cultures - Language Aliases
Same as "Single Site and Multiple Cultures - Language Aliases"
Multiple Cultures - Language Aliases AND Domain Aliases
This module is not supported for sites utilizing a mixture of both language URL aliases and language sub-domains.
The Kentico URL Redirection module contains one class, Redirection Table, that is not customizable. The class' fields are as follows:
| Field Name | Data Type | Form Control | Descrpiton |
|---|---|---|---|
| RedirectionTableID | Integer | N/A (Not Editable) | Unique ID of the redirection item |
| RedirectionOriginalURL | Text (2000) | Text Box | URL Alias that will be redirected. Ex: /original-url |
| RedirectionTargetURL | Text (2000) | URL Selector | Internal alias or External URL that the Original URL field will be redirected to. Ex: /target-url Ex: https://www.external-domain.com |
| RedirectionDescription | Long Text | Text Area | A field that allows a content editor to describe a redirect or enter the purpose of a redirect |
| RedirectionSiteID | Integer | Site Selector | Drop down list that allows a user to specify which site the redirect is for. Default is the current site the user is on. |
| RedirectionType | Text (3) | Drop Down List | Allows the user to specify if the redirect is a 301 or 302 redirect. |
| RedirectionCultures | Text (4000) | Multiple Choice | Allows the user to specify which cultures the redirection should be enabled for. The default selected will be the Cultures available for the current site, although all cultures currently assigned to the site will be shown. |
The module can be accessed by going to Applications>Custom>URL Redirection.
This project uses a standard MIT license which can be found here.
Contributions to this module are welcome. All the source files for this module are included and you just need to add the project to a Kentico Web Application solution and you can start editing anything you like. A ZIP export of the most recent, unsealed, version of the module is also included in the root of this repo so you can easily import the module database items into your Kentico project through the Sites application. This file is named KenticoURLRedirection_12.0.4.zip and will be needed if you want to edit anything related to the module inside the CMS.
Submit a pull request to the repo with your code changes as well as an updated ZIP file (if CMS changes were made) and we will review and provide feedback. We will also update the NuGet package to a new version once we approve your changes.
Any bugs can be listed as issues here in GitHub or can be sent to our email [email protected]. We will respond as soon as we can.