Customize the Domino UI

If you are using an on-premises deployment of Domino, you can use white labeling to customize the Domino interface with your organization’s brand, external resource links, banner, footer, and more. You can also remove specific UI elements to hide functionality according to your organization’s needs.

White labeling is controlled by certain Configuration keys. See Configuration records 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.

In the admin portal, go to Platform settings > Configuration records.
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>
Set com.cerebro.domino.frontend.globalBanner.isClosable to let users close the banner.
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

In the admin portal, go to Platform settings > Configuration records.
Set com.cerebro.domino.frontend.footerCustomization.customFooterHtml to the custom HTML that you want shown just above the page footer.

Customize the footer image

In the admin portal, go to Platform settings > Configuration records.
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

In the admin portal, go to Platform settings > Configuration records.
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 Configuration key supports additional white labeling parameters in JSON format:

Key Description

Key	Description
Design elements
`appLogo`	Optional: The absolute URL of the logo image, or `none` to display the Domino logo.
`appLogoBgColor`	Optional: The background color of the logo; the default is "transparent". Any CSS color value is valid.
`appURL`	Optional: The application URL; the default is "https://domino.ai/".
`appName`	The application name (such as Domino).
`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.
`hideAddProjectAction`	`True` to hide the Add Project button.
`hidePopularProjects`	`True` to hide the list of popular Projects.
`hideDownloadDominoCli`	`True` to hide the Domino client download link.
`hideLearnMoreOnFile`	`True` to hide learn more on file.
`hideMarketingDisclaimer`	`True` to hide the marketing disclaimer.
`pageFooter`	The custom HTML that you want showing just above the page footer.
`showSupportButton`	`True` to show the Support button.
Git security
`gitCredentialsDescription`	A description to show in the Git credentials configuration window.
`hideGitSshKey`	`True` to hide the SSH key in Git configurations.
Project visibility
`hidePopularProjects`	`True` to hide the list of popular projects.
`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.
`errorPageContactEmail`	The contact email to be used in error pages.
`appName`	The application name (such as Domino).
`pageFooter`	The custom HTML shown just above the page footer.
`showSupportButton`	`True` to show the Support button.
`supportEmail`	The support email address.
`supportUrl`	The support page URL.
`pdfTemplateUrl`	The PDF template URL.
`pdfAppName`	The title for the PDF template.

Design elements

appLogo

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

appLogoBgColor

Optional: The background color of the logo; the default is "transparent". Any CSS color value is valid.

appURL

Optional: The application URL; the default is "https://domino.ai/".

appName

The application name (such as Domino).

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.

hideAddProjectAction

True to hide the Add Project button.

hidePopularProjects

True to hide the list of popular Projects.

hideDownloadDominoCli

True to hide the Domino client download link.

hideLearnMoreOnFile

True to hide learn more on file.

hideMarketingDisclaimer

True to hide the marketing disclaimer.

pageFooter

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

showSupportButton

True to show the Support button.

Git security

gitCredentialsDescription

A description to show in the Git credentials configuration window.

hideGitSshKey

True to hide the SSH key in Git configurations.

Project visibility

hidePopularProjects

True to hide the list of popular projects.

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.

errorPageContactEmail

The contact email to be used in error pages.

appName

The application name (such as Domino).

pageFooter

The custom HTML shown just above the page footer.

showSupportButton

True to show the Support button.

supportEmail

The support email address.

supportUrl

The support page URL.

pdfTemplateUrl

The PDF template URL.

pdfAppName

The title for the PDF template.

Example

{
  "appLogo": "https://example.datascience.org/sku_setup/logo/for-light-backgrounds/example_logo_blue.png",
  "appLogoBgColor": "#2DEB5E",
  "appName": "My Data Science Platform",
  "appURL" : "https://examples.data.org/app/",
  "defaultProjectName": "my-datascience-project",
  "errorPageContactEmail": "admin@example.datascience.org",
  "favicon": "https://example.datascience.org/favicon.ico",
  "gitCredentialsDescription": "My customized Git credentials description.",
  "helpContentUrl": "https://help.example.datascience.org",
  "hideAddProjectAction": false,
  "hideDownloadDominoCli": false,
  "hideGitSshKey": false,
  "hideLearnMoreOnFile": false,
  "hideMarketingDisclaimer": false,
  "hidePopularProjects": false,
  "hidePublicProjects": false,
  "hideSearchableProjects": false,
  "hideSuggestedProjects": 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",
  "supportUrl": "https://example.datascience.org/support/",
  "pdfTemplateUrl": "https://example.com/?export=download_link",
  "pdfAppName": "My Data Science Platform PDF title"
}