Configuration

This content is also available in the readme

The URL Tracker exposes some configurations in the appsettings.json file. All configurations are optional. A complete configuration may look like this:

{
    "UrlTracker": {
        "Enable": true,
        "EnableLogging": false,
        "AppendPortNumber": false,
        "HasDomainOnChildNode": false,
        "BlockedUrlsList": [],
        "Backoffice": {
            "Notifications":{
                "Enable": true
            }
        },
        "Caching": {
            "Memory": {
                "CacheRegexRedirects": true,
                "InterceptSlidingCacheMinutes": 2880,
                "MaxCachedIntercepts": 5000,
                "EnableInterceptCaching": true
            }
        },
        "Pipeline": {
            "Enable": true,
            "EnableClientErrorTracking": true
        }
    }
}

Enable

Type	Default	Description
bool	true	Set this value to false to completely disable the URL Tracker. The URL Tracker will not intercept any requests nor track any content updates

EnableLogging

Type	Default	Description
bool	false	Set this value to true to allow the URL Tracker to write logs to the Umbraco native logger. Most logs from the URL Tracker are written at Debug or Verbose level.

AppendPortNumber

Type	Default	Description
bool	false	Set this value to true to add a port number behind the host component of a redirect url. This setting is ignored when the application is hosted on the default port 80.

HasDomainOnChildNode

Type	Default	Description
bool	false	Set this value to true if your website has domains configured on pages that are not in the root of the website.

BlockedUrlsList

Type	Default	Description
List	empty	Add values substring patterns to this list for URLs that should not appear in the NOT FOUND overview of the URL Tracker. Examples of patterns are: "/wp-admin" or "/.well-known"

Backoffice:Notifications:Enabled

Type	Default	Description
bool	true	Set this value to false to disable tracking of content changes. The URL Tracker will not automatically create redirects when content is updated

Caching:Memory:CacheRegexRedirects

Type	Default	Description
bool	true	Set this value to false to disable caching of regex redirects. By default, all regex redirects are cached in memory to improve performance.

Caching:Memory:InterceptSlidingCacheMinutes

Type	Default	Description
int?	2880	Set this value to the time in minutes that all redirects should be cached. By default, all redirects are cached for 2 days. Set to null to cache indefinitely.

Caching:Memory:MaxCachedIntercepts

Type	Default	Description
long	5000	Set this value to the amount of intercepts that should be cached by the URL Tracker. This not only includes redirects, but also 200 OK responses, 410 GONE responses and 404 NOT FOUND responses.

Caching:Memory:EnableInterceptCaching

Type	Default	Description
bool	true	Set this value to false to completely disable redirect caching.

Pipeline:Enable

Type	Default	Description
bool	true	Set this value to false to completely disable any interaction from the URL Tracker with incoming requests.

Pipeline:EnableClientErrorTracking

Type	Default	Description
bool	true	Set this value to false to disable tracking of Not Found responses.