/
Configure White Labeling

Configure White Labeling

Owned by Sruti Sridhar

About the feature

White labelling of Bahmni will provide the various implementations, the ability to brand Bahmni as applicable to them. The implementors will now be able to configure the Logo and Text, specific to their implementations, on the landing page and the Bahmni login pages.

Configuring the logo and Text:


If you are using Bahmni on Docker, please see this page on how you can load your own implementation config, to make changes to Bahmni UI. Once you have done these steps, then changing logo values as mentioned below will be easy.


Quick way to configure logo

The logo that is displayed in Bahmni Landing page and Login Screen can be easily configured by adding/replacing the logo.png file in your configuration repository at openmrs/apps/home/logo.png and updating the value of logo to /bahmni_config/openmrs/apps/home/logo.png


The whiteLabel.json file is present in the path default-config/openmrs/apps/home

The config is as below:

whiteLabel.json
{
  "homePage": {
    "header_text": "<b>WELCOME TO<br/>BAHMNI EMR & HOSPITAL SERVICE",
    "logo": "/bahmni/images/bahmniLogoFull.png",
    "title_text": " ",
    "bottomBanner": "<URL of custom banner image. Like: /bahmni/images/customBottomBanner.png>"
  },
  "loginPage": {
    "logo": "/bahmni/images/bahmniLogoFull.png",
    "showHeaderText": true,
    "showTitleText": false,
    "bottomLogos": [
      "<Path to logo files. Like:",
      "/bahmni_config/openmrs/apps/home/first_logo_75px.png",
      "/bahmni_config/openmrs/apps/home/second_logo_75px.png"
    ]
  },
  "helpLink": {
    "url": "https://bahmni.atlassian.net/wiki/display/BAH/Bahmni+Home"
  }
}

Config for "homePage"

KeyPurposeMandatoryBehaviour
header_text
Header text on the landing/home PageNo

Default Text : WELCOME TO BAHMNI EMR & HOSPITAL SERVICE

If header text key is removed, Default text will show.

logoLogo on the landing /home page.No

Default: Path of bahmni logo

If logo path is wrong, it will show a broken image on the landing page.

If key is removed, then default bahmni logo will be displayed

title_textTitle text beside the logo on the landing/home page.No

Default: Blank text

If Key is removed, "title text" placeholder will be displayed

bottomBanner
Display custom banner image depends on implementationNo

Default: Nothing will display.

Config for "loginPage"

KeyDescriptionMandatoryBehaviour
showHeaderText

Header text on the login Page.

Specify the key value in the respective locale file.

No

Default : True

If the key is not present or removed from the config file, it'll show no text on the page.


showTitleText

Title text beside the logo on the login page.

Specify the key value in the respective locale file.

No

Default: False

If the key is not present or removed from the config file, it'll show no text on the page.

logo

Logo on the login page.

No

Default : Bahmni logo

If the key is not present or removed from the config file, it'll show no image on the page.

bottomLogos
Display custom logos as a banner a the very bottom of the page. Files must be available at a path on the server.
NoDefault: Nothing will be displayed

bottomBanner feature will be available from v0.90

On this page

Related content

The Bahmni documentation is licensed under Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0)