Brightspot CMS User Guide

Admin

Site management

Site settings

Global site settings

The Global site has many settings that serve two purposes: configuring Brightspot and providing defaults for lower levels in the content hierarchy.

The following settings apply to most versions of Brightspot. Your version of Brightspot may have different settings.

Global settings—Main tab

Field	Description
Name	Enter the site's name. The site's name appears in several widgets throughout Brightspot. Site name in Brightspot widgets
Company Name	Enter your company's name. If you do not specify an image in the Company Logo field, Brightspot displays your company's name in the header next to the navigation menu. If both Company Name and Company Logo are blank, `Brightspot` is displayed next to the navigation menu. Company name in header
Company Logo	Enter your company's logo. Brightspot displays the logo in the header next to the navigation menu.
Background Image	Add a background image for the login page. If set to `None`, a standard Brightspot image appears. Background image
Environment	Enter the name of your Brightspot. The environment name appears in black ribbon in the header. Environment name
Default Role	Enter a default role for new users. When you create a new user, Brightspot does the following: Assigns Permissions to Roles. Selects the default role as the user's role. You can modify the permission and the default role for each user. For information about creating roles, see Creating a role; for information about creating users, see Creating a user.
Default Preview URL	Enter the default base portion of a URL used to preview content. This field is usually necessary when previewing content in a headless environment. (If you are previewing content in a traditional environment, leave this field blank.) If not specified, Brightspot uses the Default Tool URL.
Default Tool URL	Enter the URL editors use to log in to Brightspot. Brightspot also uses this URL when sending notifications that include links, such as emails or text messages. (Do not append `/cms` to this field.)
Authenticators	Select the service for authenticating editors attempting to log in to Brightspot. Default Tool Authenticator—Editors log in to Brightspot using standard username and password. Google Tool Authenticator—Editors log in to Brightspot using their Google sign-on.
Basic HTTP Authentication	Configure an HTTP authentication challenge that an editor must pass to log in to Brightspot, similar to the following: HTTP authentication challenge None—No authentication required. Basic Authentication Users—Enter pairs of usernames and passwords. Editors must provide one of the usernames and associated password to log in. Basic Authentication Excluded Path Prefixes—Paths on your site that are exempt from HTTP authentication.
Default Task Host	Enter a name or IP address of the default host running all background tasks. For some tasks you can configure different hosts. (For example, some integrations can have a separate task host.)
Theme	Select the default theme for all sites. You can override this setting at the site level. For more information about themes, see Theme management.

Global settings—Front-End tab

Field	Description
Cascading Settings Algorithm	Select the algorithm Brightspot uses to apply settings at various levels in the content hierarchy. Default Cascading Strategy—Settings flow from the global site, individual site, section parent, section, and asset. Landing Cascading Strategy—Settings flow from the site, content type, and asset. None—Settings flow from the global site, individual site, section parent, section, and asset.
Dynamic List Module Cache Seconds	Enter the number of seconds Brightspot waits before updating the assets in a dynamic list.
Logos & Icons
Logo	Upload or link to your site’s logo. The logo typically appears in the top-left corner of each published page. Site logo on published page
News Publisher Logo	Renders a site logo that complies with width and height restrictions for AMP.
Favicon	Site’s favicon appearing in browsers and some mobile apps. Use .png or .jpg files.
Favicon Ico	Site’s favicon appearing in browsers and some mobile apps. Use .ico files.
Layout
Language Menu	Configure a menu containing a list of languages and associated links. Visitors select from this menu to view the site in different languages. Language menu
Hat	Select an existing hat or create a new one. For information about creating a hat, see Creating a hat.
Navigation	Select an existing navigation or create a new one. For more information about creating a navigation, see Creating a navigation.
Footer	Select an existing footer or create a new one. For more information about creating a footer, see Creating a footer.
Above	Configure content appearing in the Above block on all pages across all sites. For more information, see Above, Aside, and Below layout blocks.
Aside	Configure content appearing in the Aside block on all pages across all sites. For more information, see Above, Aside, and Below layout blocks.
Below	Configure content appearing in the Below block on all pages across all sites. For more information, see Above, Aside, and Below layout blocks.
Search Page	Configure a page that lists results when a visitor searches for content. For information about creating a search page, see Search results.
Type Specific Overrides
Type Specific Overrides	Configure logos, icons, and layouts applicable to specific content types. Configurations in these fields override settings in the Logos & Icons and Layouts clusters.
Action Bar
Default Action Bar	Configure the site’s default action bar. Appears on all of the site’s assets unless overridden for a content type. For information about creating an action bar, see Creating an action bar.
Type Specific Overrides	Configure action bars applicable to specific content types for a site. Overrides Default Action Bar. For information about creating an action bar, see Creating an action bar.
Ads
Disable All Ad Injection	If toggled on, prevents any ad feed from injecting ads into assets.
Ad Injection Profiles	Configure feeds for injecting ads into assets. Component Based Ad Injector—Injects ads between an asset's components, such as the items in a listicle. Rich Text Ad Injector—Injects ads into body text. For more information, see Injecting ads into body text.
Disable Ads Parameter Value	Value in a query string that blocks an ad feed.
Commenting
Commenting Services	Configure a commenting services, such as Coral and Disqus, through which visitors can post comments to a site's assets.
Entitlements
Entitlement Service	Configure a service that manages entitlements to your site's assets.
Error
Error Handlers	List of HTTP error or status codes and associated pages that visitors receive. For more information, see Configuring error responses.
Form CAPTCHA
Provider	Configuration for adding a reCAPTCHA control on forms. For more information, see Configuring Google reCAPTCHA.
Localization
Locale Provider	Select the level in the content hierarchy that provides the requested language for an asset. None—Uses the locale set on the Brightspot server. Content—Uses the locale configured for an individual asset. Site—Uses the locale configured for a site. System Default—Uses the locale set on the Brightspot server. For example, a visitor wants to view a page of soccer scores at `http://example.com/soccer_es`. If Locale Provider is— None or System Default, the visitor sees the page translated into the locale configured on the Brightspot server. Content, the visitor sees the page translated into the locale configured for the asset `/soccer_es`. Site, the visitor sees the page translated into the locale configured for the site `example.com`.
Disable Front-End Localization	If toggled on, prevents front-end pages from including localization requests configured in Locale Provider.
Open Graph
Default Open Graph Image	Select the image to appear in social networks when an asset is shared.
Permalinks
Permalink Rule Overrides	Configure how Brightspot generates permalinks for a content type. For each content type, you can configure one of the following rules: Contained Versionable Permalink Rule—Brightspot generates permalinks from a combinations of an asset's version number and slug. Applies to assets of content type Versionable. Default Permalink Rule—Brightspot generates permalinks from an asset's slug. No Permalink Rule—Brightspot does not automatically generate a permalink; editors must manually create permalinks for each asset. Section Prefix Permalink Rule—Brightspot generates permalinks from a combination of the section’s slug and the asset's slug. Type Version Wildcard Permalink Rule—Brightspot generates permalinks from a combination of the item's name and a version number. Applies to assets of content type Type Version. Versionable Container Permalink Rule—Brightspot generates permalinks from a combination of the item's title and a version number. Applies to assets of content type Versionable Container. For each rule, you can specify how Brightspot resolves duplicate permalinks. Inherit—At the Global level, applies Default Permalink Rule. Disabled—Do not automatically resolve duplicate permalinks; editors must resolve them individually. Enabled—Brightspot appends a number to duplicate permalinks, incrementing the number for each new duplicate.
Podcast Feeds
Owner Name	Enter the default owner name for listing podcast episodes on iTunes.
Owner Email	Enter the default owner email for listing podcast episodes on iTunes.
Expiration Date	Enter the date after which iTunes no longer redirects traffic to your site's current URL.
Rss Validation Disabled Types	Select the content types for which Brightspot does not perform RSS validation.
Disable RSS Validation	If toggled on, Brightspot does not perform any RSS validation.
Podcast Providers
Providers	Configure podcast providers and their associated domain names.
RSS Feed
RSS Validation Disabled Types	Select content types for which RSS validation is disabled.
Disable RSS Validation	If toggled on, disables RSS validation for all content types.
RSS Settings
Disable Feed	If toggled on— Brightspot stops populating your site’s RSS feed. Removes the existing feed and its previously included assets.
Copyright	Enter the copyright notice appearing in the feed’s copyright tag, which not all RSS readers display.
Default To Atom Auto Detect	If toggled on, the feed is a discoverable Atom feed. If toggled off, the feed is a discoverable RSS feed.
Type Specific Feed Overrides	Configure feeds for specific content types. For homepages, pages, sections, and tags, you can configure the following: Types—Content types to which a configuration applies. Disable Feed—Enables or disables the feed for the selected content types in Types. Render Full Content—Delivers the entire asset—not just a summary—to the RSS feed as plain text. Enabled Feed Item Types—Content types associated with these settings, or leave blank to apply the settings to all content types The settings in this field override Disable Feed.
SEO
robots.txt	Compose lines to include in the site’s `robots.txt` file. For detailed information about what you can include in this file, see Robots.txt Specifications.
Social
Facebook Username	Enter the username associated with the author's Facebook account.
Instagram Username	Enter the username associated with the author's Instagram account.
LinkedIn Entity	Select one of the following options: None—Brightspot does not display a social link to a LinkedIn account on the front end. Company—Enter the name of the company with which the author is affiliated. Showcase—Enter the name of the showcase with which the author is affiliated. User—Enter the username associated with the author's LinkedIn account.
Pinterest Username	Enter the username associated with the author's Pinterest account.
TikTok Username	Enter the username associated with the author's TikTok account.
Tumblr Username	Enter the username associated with the author's Tumblr account.
Twitter Username	Enter the username associated with the author's Twitter account.
YouTube Entity	Select one of the following options: None—Brightspot will not display a social link to a YouTube account on the front end. Channel—Enter the name of the channel associated with the author. Custom—Enter the name of a custom channel or video.
Sponsored Content
Sponsored Content Meaning Link	Configure the default link for sponsored content. When clicking on a sponsored-content link, the visitor sees this page. You can override this link at the asset level.
Advanced
Time Zone	Select the time zone used to compute the published time as reported in some tags. For example, your Brightspot server is in New York, and you publish an asset at 9:00 AM. In addition, you set this field to Europe/London. In this case, Brightspot renders `<meta property="article:published_time" content="2021-03-29T14:00:00.000">`, indicating the asset was published at 2:00 PM.
Browser Config	Compose the `browserconfig` file delivered to clients from this site. For information about how to compose this file, see Browser configuration schema reference.
Web App Manifest	Configure the web app manifest delivered to clients from this site. For information about how to compose this file, see Web app manifests.
Custom Scripts And Styles	Compose `<link>`, `<meta>`, `<script>`, and `<style>` elements included in web pages delivered from this site—beyond what is defined in the site’s theme. You can send different sets of custom tags to specific clients by filtering on HTTP method, URL pattern, and content type.
Custom Response Headers	Configure response headers sent to clients—beyond what is configured for the site’s server. You can send different response headers to specific clients by filtering on HTTP method, URL pattern, and content type. For information about configuring response headers, see Response header.
Disable Smart Quotes	If toggled off, straight single and double quotes in the content edit form appear as curly quotes in published pages.
Strip Query String From Directory Redirects	A client’s request for a resource may trigger a redirect to a different directory. Toggle on this field if you want to strip the query string from the request before the server performs the redirect.

Global settings—CMS tab

Field	Description
After-Save Events
After Save Events Configuration	Configure actions Brightspot performs after saving an asset, such as submitting the asset to Apple News. For additional information, see Configuring after-save events in Apple News.
Analytics
Task Host	Enter the name or address of the host running the task for monitoring analytics accumulated by Brightspot.
Page Views Supplier	Select the provider of page view data. None—Page view data is collected by Brightspot Analytics, but not displayed on the Search results page. Brightspot Analytics—Source of page views is the Brightspot server. Google Analytics—Source of page views is Google Analytics.
Disable Analytics HTML Tag Writer	If toggled on, disables the JavaScript that collects page view data. Data remains uncollected until the script is re-enabled.
Broadcast
Global Only	If toggled on, editors see the broadcast message only when working in the global site.
Broadcast Message	Configure a message appearing on top of the header. Broadcast message
Broadcast Expiration	Select the date and time when broadcast message expires. If blank, broadcast message has no expiration.
Content Discovery
Disable Site Owner Search Filter	If toggled on, suppresses the miscellaneous sites filter in the search panel. Searches retrieve assets from all sites. Sites filter in search panel
Disable Site Owner Query Restriction	If toggled on, suppresses the site filter in dashboard widgets (such as Recent Activity), and the widget displays assets from all sites. Sites filter in dashboard widget
Content Templates
Global Defaults	Configure globally available templates populated with default values. For details, see Content templates.
Global Extras	Configure globally available templates populated with default values and labeled as a different content type. For details, see Content templates.
Site Specific Defaults	Configure site-specific templates populated with default values. For details, see Creating a site-level content template.
Site Specific Extras	Configure site-specific templates populated with default levels and labeled as a different content type. For details, see Creating a site-level content template.
DAM Asset Expiration Settings
(various)	Configure emails notifying subscribers of assets about to expire. For detailed information, see Configuring asset expiration emails.
DAM Document Data Extraction Settings
Extractor Services	Configure the service for extracting content from a binary file, such as text from a PDF.
Dashboard
Default Dashboard	Configure the default dashboard for all roles and users. Users, roles, and sites with a default dashboard of `None` inherit this dashboard. For detailed information, see Dashboards.
Resources	Configure a default list of resources for the Resources widget. For detailed information, see Configuring the Resources widget.
Quick Start Settings	Configure a list of content types and assets appearing in the Quick Start widget. For detailed information, see Adding, removing, or "favoriting" items in your Quick Start widget.
Bulk Upload Settings	Configure the default file type in the Upload Files widget.
Hunspell
Dictionaries	Create a list of dictionaries containing correctly spelled words. For detailed information, see Creating an auxiliary dictionary.
Locales
Custom Locales	Add language-region-script-variant locales not included in the standard IANA listing. Entries in this field appear in the Available Locales field in the Localization and Translation clusters. For a listing of all possible elements for configuring a locale, see IANA's Language Subtag Registry.
Localization
Disable Search Result Field	If toggled on, suppresses the Locales field in search results. Locales field in search results
Disable Localization Search Filter	If toggled on, suppresses the miscellaneous locales filter in the search panel. Searches retrieve assets from all locales. Locales filter in search panel
Available Locales	Locales into which assets in this site can be translated. For information about translating assets, see Sending an asset for translation.
Notifications
System Notifications	Configure notifications that Brightspot sends to a listserv email, Slack group, or SMS address. Editors subscribing to those services can listen for the notifications. For example, you can configure Brightspot to send a notification to the Slack channel `#publications` every time an editor clicks Publish. All editors subscribed to that slack channel see the notification.
Automatic User Subscriptions	Configure notifications to which users are automatically subscribed. Editors can opt out of these subscriptions. For more information, see Automatic subscriptions.
Email Settings	Configure settings for sending emails from Brightspot. Default From Email—From address appearing in emails sent from Brightspot, such as `no-reply@brightspot.com`. Mail Provider Setting Key—Identifier of an email provider configured on the Brightspot server. Additional Notification Emails—Additional email addresses to which Brightspot sends notifications; applicable only in development environments.
SMS Settings	Configure settings for sending text messages from Brightspot. Default From Phone Number—Phone number from which Brightspot sends text message notifications. Must be a number registered with an SMS service for sending text messages. If blank, Brightspot uses the value configured for Dari. Sms Provider Setting Key—Identifier of an SMS provider configured on the Brightspot server.
Preview
Closed by Default	If toggled on, the preview pane is closed by default. (For mobile devices, preview pane is always closed by default regardless of this setting.)
Preview Devices	Configure a list of devices available in the preview pane. If blank, all devices are available.
Preview Types	Previews generated by external applications, such as a GraphQL server.
Shared Preview Link Expiration	Enter the number of days after which a shared preview expires. See also Setting the preview link expiration at the global site level and Setting the preview link expiration at the individual site level.
Read Only Access
Read Only Across Sites	If toggled on, sites with access to an asset have read-only access. For example, an editor working on Site A created an asset and gave Site B access to that asset. If this field is— Toggled on, editors on Site B can view the asset, but cannot modify it. Toggled off, editors on Site B can view and modify the asset.
Disable Site Swap Prompt	If toggled off, editors are prompted to swap sites to edit an asset owned by another site. Site-swap prompt For example, an editor working on Site A created an asset. If this field is— Toggled on, editors on Site B do not receive a prompt to swap sites before editing the asset. Toggled off, editors on Site B receive a prompt to swap sites in order to edit the asset.
RTE
Default Text Overlay CSS	Compose default CSS statements for text overlaid on graphics. For example, `color: white;` sets the overlaid text in white.
Enable Collaborative Editing	If toggled on, editors can modify text simultaneously in the rich-text editor (similar to Google Docs).
Create Paragraph on Enter	If toggled on, pressing Enter in the rich-text editor adds an empty paragraph before starting the new one. Empty paragraphs
Create Comment From Highlight	If toggled on, editors can select text and click comment to create a comment from the selected text.
Security
Two-Factor Authentication Required	If toggled on, two-factor authentication is required for editors to log in to Brightspot. For additional information, see Two-factor authentication.
Site Copier
Disallow Site Copy	If toggled on, administrators cannot copy sites. For additional information, see Copying a site.
Copy Threshold	Enter the maximal number of assets Brightspot copies from the original site to the new site.
Style Groups
Curated Style Groups	Configure groups of module styles that editors can apply to multiple assets. For additional information, see Applying a module style.
Suggestions
Number of Suggestions	Enter the number of suggestions appearing in a drop-down list.
Show Suggested Owner Content Only	If toggled on, suggestions are taken from content associated with the current asset’s site.
Suggestion Provider	Configure one of the available providers that returns suggestions.
Translation
Available Locales	Select locales to which a site's content is translated.
Locale Groups	Configure groups of locales. If you translate your content to multiple locales, it may be easier to manage them as a group.
Default Service Settings	Configure the default settings for a translation service. You can override these settings for individual translation jobs. (You can also configure default service settings for individual content types.)
Type Settings	Configure the default settings for individual content types. Types—Content types to which these settings apply. Completion Action—Action Brightspot applies to a completed translation. Service Settings—Settings for the translation service applicable to the selected content types. These settings override what you configure in Default Service Settings.
UI
Common Times	Configure static times for general usage, such as setting a daily column deadline to 3:30 PM. You can have these times appear in Brightspot.
Inline Editing	This field displays the hierarchy of assets that editors can modify using the Inline Editor. All Contents—Editors can modify the asset and subsidiary assets. For example, if an article contains an author, an editor can modify both the article and the author. Only Main Content—Editors can modify the asset but not its subsidiary assets. Disabled—Inline editor is not available. Editors can override this setting at the user level; for details, see Creating a user.
Recent Revisions Banner Expiration	Enter the number of hours after which an unpublished revision no longer appears in the Recent Revisions Banner.
Disable Search Term Highlighting	If toggled on, the search term in search results is not highlighted in yellow. Search term highlighting
Enable Calendar Search Result View	If toggled on, the search panel includes a calendar view. This view is useful for viewing scheduled events associated with a search term. Calendar view in search results
Display Tabs as Tabs By Default	If toggled on, tab labels are always visible in the content edit form. Tabs in content edit form
List Gallery Default View	If toggled on, the default view for a gallery's items in the content edit form is list. If toggled off, the default view is gallery. Gallery items, list view Gallery items, grid view
Disable Shelf	If toggled on, suppresses the Shelf in the content edit form. For more information, see Working with The Shelf.
Enable Enhanced SEO UI	If toggled on, adds the following fields to the content edit form's SEO tab: Focus Keyword, Focus Keyword Density, and Disable SEO Recommendations.
Enable Sticky Search Filters	If toggled on, retains values for common search filters when searching for a different content type. For example, if you first search for articles with status `Draft`, and then search for images, the setting for status remains `Draft`.
Enable Guides	If toggled on, editors can view and edit production guides for content types and their fields. For more information, see Accessing production guides.
Enable Pre Publish Actions	If toggled on, Brightspot provides cues for updating an asset's fields (such as promo overrides) before actually publishing the asset. For more information, see Pre-publishing actions.
Enable Post Publish Actions	If toggled on, Brightspot provides suggestions for placing assets after they are published. For more information, see Post-publishing actions.
Open Post Publish Actions Automatically	If toggled on, Brightspot displays the widget for post-publish actions after the asset is first published. If toggled off, editors can still access post-publish actions by clicking more_horiz > Post Publish Actions. For more information, see Post-publishing actions.
Conversation Types	Configure a list of content types for which the conversation widget is available in the content edit page. If blank, conversation is available for all content types. For more information, see Sending and viewing messages through Conversation.
Disable Automatic Watch Publish User On Save	If toggled off, Brightspot adds the editor who publishes an asset as a watcher of that asset. For more information, see Watch.
Disable Automatic Watch Update User On Save	If toggled off, Brightspot adds the editor who updates an asset as a watcher of that asset. For more information, see Watch.
Watching Search Result Filter Enabled	If toggled on, the legacy Watching filter is available in the search panel’s results; editors can filter search results for only the assets they are watching.
Watching Search Filter Disabled	If toggled off, the Watching filter appears in the search panel’s Misc Filters widget; editors can filter search results for only the assets they are watching.
Advanced
Disabled Plugins	A list of installed plugins that are disabled.
Extra CSS	Compose additional lines of CSS code that impact the Brightspot GUI. For example, the statement `label {text-decoration: underline;}` underlines all field labels in the Brightspot GUI.
Extra Java Script	Copmpose lines of JavaScript code that run every time you load a page in Brightspot. For example, the statement `alert('Good morning!');` displays an alert message every time you load the Dashboard, content edit form, or any other page.
Disable Configurable Search Filters	If toggled off, editors can move the search panel’s common filters to a collapsible list.
Enable Trailing Slash Configuration	Select the method for appending or removing a trailing slash from a URL. 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).
Display Site in Search Result	Toggle on to add a Site column to the search panel. This column indicates to which site a found asset belongs.
Enable Cross Domain Inline Editing	Toggle on to display the Inline Editor for all elements on a page, even those belonging to a different domain. This setting is useful when you log in to Brightspot at one domain (such as `bsp.example.com`) but publish to a different domain (such as `www.example.com`).
Show Models Without Handlebars In Theme	Toggle on to hide content types in Brightspot that are not supported by the current site's theme.
Default Task Host	Default host on which various background tasks run. Brightspot assumes all background tasks are running on this host unless you specify a different one for a particular task. For some tasks you can configure different hosts. (For example, some integrations can have a separate task host.)

Previous Topic

Setting hierarchy

Next Topic

Spelling, dictionaries, locales