About Domino
Domino Data LabKnowledge BaseData Science BlogTraining

White Labeling

If you are using an on-premises deployment of Domino, you can use the white labeling feature to customize the Domino interface with your organization’s brand. White labeling is controlled by certain Central Configuration keys. See Central Configuration for definitions of these keys.

Customize the banner

Create a custom HTML banner for every page on Domino to notify users of important announcements and information.

  1. Go to Admin > Advanced > Central Config.

  2. Set com.cerebro.domino.frontend.globalBanner.content to the HTML that you want shown in the banner.

    1. Example: <div style="background-color: blue; font-size: 50px;">Global Banner</div>

  3. Set com.cerebro.domino.frontend.globalBanner.isClosable to let users close the banner.

  4. Set com.cerebro.domino.frontend.globalBanner.reappearTimeAfterCloseInSec to specify how many seconds pass before the banner reappears. If the key is not specified, the banner will stay closed.

Customize the footer

  1. Go to Admin > Advanced > Central Config.

  2. Set com.cerebro.domino.frontend.footerCustomization.customFooterHtml to the custom HTML that you want shown just above the page footer.

Customize the footer image

  1. Go to Admin > Advanced > Central Config.

  2. Set com.cerebro.domino.frontend.footerCustomization.customFooterImageUrl to a URL for the image that you want shown in the footer. The image displays on the same line as the Domino logo. If customFooterHTML is set, this displays below the custom HTML, inside the footer.

Customize the Contact Us link

  1. Go to Admin > Advanced > Central Config.

  2. Set com.cerebro.domino.frontend.footerCustomization.customContactUsHref to a URL that directs your users to a web-based form or email address (mailto:support@domain.com).

Advanced customization

The com.cerebro.domino.whitelabel.jsonConfig Central Configuration key supports additional white labeling parameters in JSON format:

appLogo

The absolute URL of the logo image, or none to display the Domino logo.

appLogoBgColor

The background color of the logo; the default is transparent.

errorPageContactEmail

The contact email to be used in error pages.

defaultProjectName

The default project name.

favicon

The absolute URL of the favicon image.

gitCredentialsDescription

A description to show in the Git credentials configuration window.

helpContentUrl

The URL of the help content.

hidePopularProjects

True to hide the list of popular projects.

hideDownloadDominoCli

True to hide the Domino client download link.

hideMarketingDisclaimer

True to hide the marketing disclaimer.

hidePublicProjects

True to hide the list of public projects.

hideSearchableProjects

True to hide the list of searchable projects.

hideSuggestedProjects

True to hide the list of suggested projects.

hideLearnMoreOnFile

True to hide learn more on file.

hideGitSshKey

True to hide the SSH key in Git configurations.

appName

The application name (such as Domino).

pageFooter

The custom HTML that you want shown just above the page footer.

showSupportButton

True to show the Support button.

supportEmail

The support email address.

Example
{
  "appName": "My Data Science Platform",
  "appLogo": "https://example.datascience.org/sku_setup/logo/for-light-backgrounds/example_logo_blue.png",
  "favicon": "https://example.datascience.org/favicon.ico",
  "errorPageContactEmail": "admin@example.datascience.org",
  "gitCredentialsDescription": "My customized Git credentials description.",
  "helpContentUrl": "https://help.example.datascience.org",
  "hidePopularProjects": false,
  "hideDownloadDominoCli": false,
  "hideMarketingDisclaimer": false,
  "hidePublicProjects": false,
  "hideSearchableProjects": false,
  "hideSuggestedProjects": false,
  "hideLearnMoreOnFile": false,
  "hideGitSshKey": false,
  "pageFooter": "<div style='width:100%; height: 50px; background-color: black; color: white;text-align: center;'>Example Page footer</div>",
  "showSupportButton": true,
  "supportEmail": "support@example.datascience.org"
}