Topics

Site URLs


In This Guide

Overview of URLS

A URL is an address that you type in your browser’s address bar, and every item that you publish in Brightspot has its own unique URL. The base portion of a URL typically starts with http:// or https:// followed by a domain name. The following table describes the different types of base URLs you can assign to each of your sites.

Type of base URL
Description
Site URLBase portion of a URL a visitor uses to retrieve one of your published items.
Preview URLBase portion of a URL used to preview content when using a headless environment.
Tool URLBase portion of a URL that editors use to log in to Brightspot.

For example, Sally is a voracious reader and an even more voracious writer. She was hired by Extraterrestrial Cuisine, a media giant that has three publications—Moon Munchies, Venus Victuals, and Martian Menus—and Sally is publishing content to all three. The following table shows how Extraterrestrial Cuisine has set up its domain names:

Site
Base URL
Type
Brightspothttp://editors.extraterrestrial.comTool URL
Moon Munchieshttp://www.moonmunchies.comSite URL
Venus Victualshttp://www.venusvictuals.comSite URL
Martian Menushttp://www.martianmenus.comSite URL

When Sally comes to work every morning, she logs in to Brightspot using the address http://editors.extraterrestrial.com/cms. Whenever she works on an article, she sees URLs similar to the following in her browser—regardless to which site she is publishing content.

Base URL and path

Visitors who want to read one of her articles see a URL similar to the following in their browsers.

Site URL and permalink


Configuring base urls

The following table describes when you need to configure base URLs for your sites as well as associated default values.

Type of base URL
When to set
Default if not set
Site URLAs needed; as a best practice, assign a different Site URL to each of your sites.
  • For the Global site, same domain as where you installed Brightspot.
  • For other sites, same as Global site.
Preview URLYou are using Brightspot in a headless environment. Available for the Global site only.
  • For the Global site, N/A.
  • For other sites, same as Global site.
Tool URLIf both of the following conditions are true:
  • Your Brightspot developer did not configure a tool URL as described in Tool URL.
  • Brightspot is sending notifications with links (such as text messages or emails).

Otherwise, configuring a Tool URL is optional.

Same as the site URL.
  1. Click menu > Admin > Sites & Settings.
  2. In the Sites & Settings widget, click the site for which you want to configure base URLs. The Edit Global or Edit Site widget appears.
  3. Click Main, and enter base URLs in the Default Tool URL field.

    Configuring Base URLs.png

  4. Click Save.

Adding wildcard URLs and redirects

To add redirect URLs using wildcards:

  1. Click menu > Admin > Wildcard Redirects. The Search Wildcard Redirect widget appears.
  2. Click New Wildcard Redirect on the bottom left. The New Wildcard Redirect edit content page appears.

    Wildcard Redirect Configuration.png

  3. Set the URL options using the information below:
    • Name: Name describing the purpose of the redirect.
    • Local URLs: URL for retired content
    • Destination: URL with the content to display
    • Temporary: If set, the server sends an HTTP 302 temporary redirect to the browser; otherwise, it sends a 301 permanent redirect. A temporary redirect instructs search engines to temporarily replace the older URL in their listings with the new one. However, the search engines continue to scan the site at the old URL and will deliver that page after you delete the temporary redirect.
  4. Set the Query String option if applicable. The options are: IgnoreModify, or Preserve. For Modify, there are additional options for specifying the keys to keep.
  5. To transfer any matched path segments, turn on Transfer Matched Segments. The local URLs must contain wildcards for this setting to take effect.
  6. In multi-site environments, select an Owner and Access in the Sites widget.
  7. In the editorial toolbar, save or publish the new redirect.

URLs and trailing slashes

Brightspot retrieves assets using a permalink. For example, a visitor wants to view the URL http://example.com/menus, so Brightspot retrieves the asset whose permalink is menus.

URLs with a trailing slash can be ambiguous. If a visitor wants to view http://example.com/menus/, Brightspot can do one of the following:

Remove the trailing slash, and retrieve the asset at the permalink menus.

Retain the trailing slash, and retrieve the asset at the permalink menus.

Additionally, if a visitor wants to view http://example.com/menus, Brightspot can add a trailing slash and retrieve the asset at the permalink menus.


Trailing slash behavior in URLs

The following table describes how Brightspot can modify URLs by appending or removing trailing slashes.

Original URL
Modified URL
Do Not Change—Brightspot does not modify the incoming URL.
http://example.com/menushttp://example.com/menus
http://example.com/menus/http://example.com/menus/
http://example.com/menus/breakfasthttp://example.com/menus/breakfast
http://example.com/menus/breakfast/http://example.com/menus/breakfast/
http://example.com/menus/lunchhttp://example.com/menus/lunch
http://example.com/menus/lunch/http://example.com/menus/lunch/
http://example.com/menus/dinner

http://example.com/menus/dinner

In this example, there is no asset at this URL, so Brightspot returns a not found (error 404).

http://example.com/menus/dinner/

http://example.com/menus/dinner/

In this example, there is no asset at this URL, so Brightspot returns a not found (error 404).

Remove—Brightspot removes a trailing slash unless an asset exists at the modified URL.
http://example.com/menushttp://example.com/menus
http://example.com/menus/http://example.com/menus
http://example.com/menus/breakfasthttp://example.com/menus/breakfast
http://example.com/menus/breakfast/http://example.com/menus/breakfast
http://example.com/menus/lunchhttp://example.com/menus/lunch
http://example.com/menus/lunch/http://example.com/menus/lunch/
http://example.com/menus/dinner

http://example.com/menus/dinner

In this example, there is no asset at this URL, so Brightspot returns a not found (error 404).

http://example.com/menus/dinner/

http://example.com/menus/dinner/

In this example, there is no asset at this URL, so Brightspot returns a not found (error 404).

Normalize—Brightspot changes the incoming URL to an existing one.
http://example.com/menushttp://example.com/menus/
http://example.com/menus/http://example.com/menus/
http://example.com/menus/breakfasthttp://example.com/menus/breakfast
http://example.com/menus/breakfast/http://example.com/menus/breakfast/
http://example.com/menus/lunchhttp://example.com/menus/lunch
http://example.com/menus/lunch/http://example.com/menus/lunch
http://example.com/menus/dinner

http://example.com/menus/dinner

In this example, there is no asset at this URL, so Brightspot returns a not found (error 404).

http://example.com/menus/dinner/

http://example.com/menus/dinner/

In this example, there is no asset at this URL, so Brightspot returns a not found (error 404).


Content URL types

URLs identify the location of resources on a website by specifying both the domain name and the specific path to an asset. You set the domain at the site level when you create the site. At the site level, you can also specify both
vanity URLs and wildcard URLs. At the asset level, you can manage the path.

Asset-level URL management

You set the path part of the URL in the URLs widget, which appears in the content edit pages of an asset. You can set the following types of URLs in the URLs widget.

Type of URLDescription
PermalinkPermanent link that never expires. Another asset on your site cannot have the same permalink. Do not change permalinks after the initial publishing of content. If you want to change a URL, add an alias to the asset, or add a redirect to the new asset that is replacing the old asset.
AliasAlternative link to the asset. You can delete the alias from an asset and use it on another asset.
Redirect (Permanent)

URL from which browsers are permanently redirected. Browsers redirect to the asset with the permalink. For example, if the permalink is /ice-cream-toppings, and you had a link to a previous article /toppings, then you would set /toppings as the redirect URL. Browsers would then redirect from /toppings to /ice-cream-toppings.

A permanent redirect causes the server to send an HTTP status code 301 to the browser. It also instructs search engines to replace the older permalink in their listings with the new permalink.

Redirect (Temporary)A temporary redirect is similar to a permanent redirect, but a temporary redirect causes the server to send an HTTP status code 307 to the browser. It also instructs search engines to temporarily replace the older URL in their listings with the new permalink. However, the search engines continue to scan the site at the old permalink and will deliver that page after you delete the temporary redirect.

Permalinks for assets

When you create an asset, you must assign it a permalink to make the asset accessible on a website. A permalink must be unique on the site where the item resides. A permalink should not be changed or deleted, even if the link is erroneously named or if the item becomes obsolete. In such cases, you can apply an alias or redirect URL to handle the issue.

As a best practice, your organization should define a permalink scheme to better manage the ever-increasing volume of content on your websites. The scheme should define the structure of the path in a way that is meaningful to your organization. For example, you could use paths based on headlines for article types, such as /deadly-gamma-ray-burst-headed-for-tinas-pizzeria. To provide more information about resources on your website, you could use additional URL segments.

Redirect URLs for assets

Redirects protect against web links that reference obsoleted (moved, deleted, or consolidated) content on your site. Redirect URLs map source links to target links, where source links are URLs to obsoleted assets, and target links are URLs to new, replacement assets. Redirects can be either permanent (301 redirects) or temporary (307 redirects).

You can add redirect URLs at the asset level; in the content edit page of a target asset, map source permalinks for one or more obsolete assets to the target permalink.

Administrators are also able to redirect URLs at the site level using either vanity URLs or wildcard URLs.

A prerequisite for setting a redirect URL is that the URL itself no longer exist on the obsolete asset. This is accomplished in one of the following ways:

  • Deleting the obsolete asset.
  • Deleting the asset’s permalink.

Content URL behavior

Brightspot automatically generates URL permalinks for assets you create. Below is an explainer about how this behavior works.

By default, assets created in Brightspot get an auto-created permalink URL based on these rules:

  • For assets that have a URL Slug field (like Article or Listicle, for example), this will be read first in order to create the URL.
  • For assets without a URL Slug field (like Page or Tag), the URL will be automatically generated from the asset’s primary field (like Display Name).

Sections affect URLs a little differently.

  • If no section is added to an asset, the end of the URL is /asset-title.
  • If you assign a section to an asset, the URL is /section-name/asset-title.
  • You can create a section hierarchy, in which one section is the parent of another. The below example illustrates how this affects URLs.
    • Create section 1.
      • URL: /section-1
    • Create section 2, and assign section 1 as its parent.
      • URL: /section-1/section-2
  • Create section 3, and assign section 2 as its parent.
    • URL: /section-1/section-2/section-3

If you add the section at any point in the asset’s workflow before publishing, it will change the auto-generated URL; however, once you publish the asset, this will not happen, and it will retain the URL path that was already generated for it.


Redirecting an asset request to a target permalink

You can add redirect URLs in the content edit page of the target asset, that is, the asset that you want to use in place of an obsolete asset. For example, if Article A is obsolete and you want links to Article A to be redirected to Article B, then you set the redirect in the content edit page for Article B.

To add redirect URLs to a target permalink:

  1. Obtain the URL of the obsolete asset.
  2. In the URLs widget, click add_circle_outline.
  3. From the drop-down list, select Redirect (Permanent) or Redirect (Temporary).
  4. In a multi-site environment, from the drop-down list, select the site to which you want the redirect URL to apply. Selecting Global applies the redirect URL to all of your sites.
  5. In the text box, type the redirect URL in the field. The redirect URL specifies one of the following:
    • The permalink of an asset you deleted.
    • A permalink you deleted from an asset.

    URLs start with a slash (/) and have no ending slash.
    For example, if an obsoleted article had a permalink of /toppings, you would specify /toppings as the redirect URL. As shown in the following screen shot, the /toppings link would be redirected to the asset with the permalink of /ice-cream-toppings.

    Redirect example.png

  6. Repeat steps 2–5 to set additional redirects to this asset.
  7. In the Editorial toolbar, save or publish the asset.

If you get a message about fixing field errors, you probably specified a permalink that has not been removed from the obsolete asset.


URLs in a multi-site environment

In a multi-site environment, the URLs widget includes a list option to select a site. Brightspot publishes the asset to the site set in this option using the URL you provide.

URLs in Multi Site

As shown in the following example, you can publish an asset to multiple sites with the URLs widget. If you set Global, Brightspot publishes to all sites.

Publishes to Stargazers site only
Publishes to Stargazers site only
Publishes to Stargazers and Asteroid Hunters sites
Publishes to Stargazers and Asteroid Hunters sites
Publishes to all sites
Publishes to all sites

When publishing to multiple sites, you can use the same permalink across multiple sites because each site has a different domain name.

In the left example, a single permalink is set, /extraterrestrials, for both Asteroid Hunters and Stargazers.

The resulting fully qualified URLs are unique because of the sites’ different domain names.

SiteFully qualified URL
Asteroid Huntershttp://www.aseroidhunters.com/extraterrestrials
Stargazershttp://www.stargazers.com/extraterrestrials

Fully qualified URLs with the same permalinks.

Alternatively, you can set site-specific permalinks on an asset. In the following example, there are different permalinks for the Asteroid Hunters site and the Stargazers site.

Asteroid Hunters & Stargazers Multi site

SiteFully qualified URL
Asteroid Huntershttp://www.aseroidhunters.com/extraterrestrials
Stargazershttp://www.stargazers.com/outer-space-creatures

Fully qualified URLs with different permalinks.

Note
An asset that can be published to multiple sites is not automatically accessible in Brightspot to editors working in those sites. For example, in the URLs widget, an asset can have a URL for the Stargazers site, but in the Sites widget, the Stargazers site can be denied access to the asset.


Configuring trailing slash behavior

To configure trailing slash behavior:

  1. Click menu > Admin > Sites & Settings.
  2. In the Sites widget, select Global. The Edit Global widget appears.
  3. Under CMS, expand Advanced.
  4. From the Trailing Slash Configuration list, select one of the following.
    • Do Not Change—Incoming URLs not changed.
    • Remove—Removes trailing slashes from incoming URLs unless an asset already exists at the modified URL.
    • Normalize—Changes the incoming URL to an existing one (if possible).
  5. Click Save.

Auto-generating a permalink

  1. Search for and open the item on the content edit page.
  2. In the URLs widget, set Generate Permalink. (If you do not see the Generate Permalink checkbox, you need to manually create a permalink).
    Generate Permalink
  3. Review the permalink automatically generated from the headline field. You can change the permalink by changing the text in the slug field (if available).
  4. Complete your site’s workflow and publish the item.

Adding custom URLs to content

To add custom URLs to content:

  1. Search for and open the item on the content edit page.
  2. In the URLs widget, click add_circle_outline.
  3. Type the URL in the field. URLs start with a slash (/) and have no ending slash, such as /ice-cream-toppings. To set a wildcard URL, see Wildcard URLs and wildcard URL redirects. For details about redirect URLs, see Redirect URLs for assets.

    Set the remaining fields for a single-site or a multiple-site environment.

  4. For a single-site environment, select the type of URL.

    For a multi-site environment:

    1. From the left list, select the site to which the URL applies. Selecting Global applies the URL to all your sites.
    2. From the right list, select the type of URL.
  5. Repeat steps 2–4 to add additional URLs.
  6. Complete your site’s workflow and publish the item.

Deleting a URL

To delete a URL:

  1. Search for and open the item on the content edit page.
  2. In the URLs widget, click  corresponding to the URL that you want to delete.
  3. Complete your site’s workflow and publish the item.

Adding redirect vanity URLs

To add redirect vanity URLs:

  1. Click menuAdmin > Vanity URL Redirects. The Search Vanity URL Redirect widget appears.

    New Vanity URL Redirect

  2. Click New Vanity URL Redirect on the bottom left. The New Vanity URL Redirect edit content page appears.
  3. Set the URL options using the information in the table below.
    FieldDescription
    NameName describing the purpose of the redirect
    Local UrlsVanity URL
    DestinationURL with the content to display
    Temporary

    If set, the server sends an HTTP 302 temporary redirect to the browser; otherwise, it sends a 301 permanent redirect.

    A temporary redirect instructs search engines to temporarily replace the older URL in their listings with the new one. However, the search engines continue to scan the site at the old URL and will deliver that page after you delete the temporary redirect.

  4. Set the Query String option if applicable. The options are: Ignore, Modify, or Preserve. For Modify, there are additional options for specifying the keys to keep.
  5. In multi-site environments, select an Owner and Access in the Sites widget.
  6. In the Editorial toolbar, save or publish the new redirect.

Adding a redirect URL

To add a redirect URL:

  1. Obtain the URL of the obsolete asset.
  2. In the URLs widget, click add_circle_outline.
  3. From the drop-down list, select Redirect (Permanent) or Redirect (Temporary).
  4. In a multi-site environment, from the drop-down list, select the site to which you want the redirect URL to apply. Selecting Global applies the redirect URL to all of your sites.
  5. In the text box, type the redirect URL in the field. The redirect URL specifies one of the following:
    1. The permalink of an asset you deleted.
    2. A permalink you deleted from an asset.
  6. Repeat steps 2–5 to set additional redirects to this asset.
  7. In the Editorial toolbar, save or publish the asset.
Note
URLs start with a slash (/) and have no ending slash.


For example, if an obsoleted article had a permalink of /toppings, you would specify /toppings as the redirect URL. As shown in the following screen shot, the /toppings link would be redirected to the asset with the permalink of /ice-cream-toppings.

If you get a message about fixing field errors, you probably specified a permalink that has not been removed from the obsolete asset.