Add support for additional URL schemes

Purpose and Scope

This document explains how to create links to external locations (resources outside the intranet) in ThoughtFarmer and how to enable additional URL schemes when required.

ThoughtFarmer provides two methods for linking to external resources:

1. Creating a Link content type in navigation

2. Adding a link within the Rich Text Editor (RTE)

For security reasons, ThoughtFarmer restricts which URL schemes can be used by default.

Default Supported URL Schemes

By default, links can only target URLs beginning with the following schemes:

• https

• ftp

• file

• webcal

• \\

• mailto

The first part of a URL (for example, https, ftp, or mailto) is referred to as the URL scheme.

If a link uses an unsupported URL scheme, it will fail unless that scheme has been explicitly enabled by an administrator.

Example:
A link using skype: will not work unless the skype scheme has been added to the allowed configuration settings.

Add Support for Additional URL Schemes

Important:
Modifying these configuration settings requires familiarity with regular expressions. If you are unsure, submit a request to ThoughtFarmer Helpdesk for assistance.

Administrators can enable additional URL schemes through configuration settings in the Admin Panel.

Enabling Additional URL Schemes for Link Content (Navigation Links)

Allow the Scheme

1. Go to Admin Panel > Advanced > Configuration Settings.

2. Search for: page.externalLink.allowedSchemes

3. Click Edit.

4. Enter the new URL scheme (for example, skype) in the Value field.

5. Click Save.

Update Link Validation

After adding the scheme, complete one of the following options:

Option A (Recommended): Update Validation Regular Expression

1. On the Configuration Settings page, search for: link.browser.url.validation.allowable.prefixes

2. Click Edit.

3. Add the new URL scheme to the regular expression.

4. Click Save.

Option B (Not Recommended): Disable Link Validation

⚠️ This will disable validation for all links going forward.

1. Search for: link.browser.url.validation.enabled

2. Click Edit.

3. Set the value to false.

4. Click Save.

Enabling Additional URL Schemes for Rich Text Editor (RTE) Links

Allow the Scheme in HTML Scrubbing

1. Go to Admin Panel > Advanced > Configuration Settings.

2. Search for: scrubHtml.allowedSchemes

3. Click Edit.

4. Enter the new URL scheme in the Value field.

5. Click Save.

Update Link Validation

After updating the allowed schemes, complete one of the following:

Option A (Recommended): Update Validation Regular Expression

1. Search for: link.browser.url.validation.allowable.prefixes

2. Click Edit.

3. Add the URL scheme to the regular expression.

4. Click Save.

Option B (Not Recommended): Disable Link Validation

⚠️ This will disable validation for all newly created links.

1. Search for: link.browser.url.validation.enabled

2. Click Edit.

3. Set the value to false.

4. Click Save.