How to white label the help links and brand name in Bold BI
White-labeling Bold BI help links and brand names allows you to customize the appearance of the application to match your organization’s branding. Changing the online help link to your white-labeled help link involves two processes.
-
Get our help site source and host it on your server after white labeling. Please refer to this article
-
Change your help site domain link on the Bold BI site. This can be done by using the configuration file.
NOTE: This feature is available in Bold BI On-Premises Deployment but not in Bold BI Managed Cloud Server.
Steps to white label the help links and brand name
-
Login with the UMS Admin user.
-
Go to Configuration editor of the UMS settings,
Example: {your_domain}/ums/administration
-
Select the
config.json
file under Search your files drop-down.Note: From version 6.19.14, use the config.json and the config.xml for versions prior to this.
-
Inside the
config.json
file, search for theWhiteLabelHelpLink
property. It contains various sub-elements that can be modified to customize the help links and branding. Save the file changes by clicking on Save button.
-
HideHelpLink
: Set this element to “true” to hide the help link. -
EnableCustomDomain
: Set this element to “true” to enable the use of a custom domain. -
BiCustomDomain
: Replace “https://yourdomain.com” with your desired custom domain. -
CustomBrandName
: Define your custom brand name.By modifying these elements within the
config.json
file, you can customize the help links and brand name that appear in the Bold BI application.
- After completing the above steps, restart the site by using this link.