White labeling

White labeling allows you to replace the Grafana brand and logo with your own corporate brand and logo.

Only available in Grafana Enterprise v6.6+.

Grafana Enterprise has white labeling options in the grafana.ini file. As with all configuration options, you can also set them with environment variables.

You can change the following elements:

  • Application title
  • Login background
  • Login logo
  • Side menu top logo
  • Footer and help menu links
  • Fav icon (shown in browser tab)
  • Login title (will not appear if a login logo is set, Grafana v7.0+)
  • Login subtitle (will not appear if a login logo is set, Grafana v7.0+)
  • Login box background (Grafana v7.0+)
  • Loading logo

You will have to host your logo and other images used by the white labeling feature separately. Make sure Grafana can access the URL where the assets are stored.

White labeling example White labeling example White labeling - 图2

The configuration file in Grafana Enterprise contains the following options. Each option is defined in the file. For more information about configuring Grafana, refer to Configuration.

  1. # Enterprise only
  2. [white_labeling]
  3. # Set to your company name to override application title
  4. ;app_title =
  6. # Set to main title on the login page (Will not appear if a login logo is set)
  7. ;login_title =
  9. # Set to login subtitle (Will not appear if a login logo is set)
  10. ;login_subtitle =
  12. # Set to complete URL to override login logo
  13. ;login_logo =
  15. # Set to complete CSS background expression to override login background
  16. # example: login_background = url(http://www.bhmpics.com/wallpapers/starfield-1920x1080.jpg)
  17. ;login_background =
  19. # Set to complete CSS background expression to override login box background
  20. ;login_box_background =
  22. # Set to complete URL to override menu logo
  23. ;menu_logo =
  25. # Set to complete URL to override fav icon (icon shown in browser tab)
  26. ;fav_icon =
  28. # Set to complete URL to override apple/ios icon
  29. ;apple_touch_icon =
  31. # Set to complete URL to override loading logo
  32. ;loading_logo =

You can replace the default footer links (Documentation, Support, Community) and even add your own custom links. An example follows for replacing the default footer and help links with new custom links.

  1. footer_links = support guides extracustom
  2. footer_links_support_text = Support
  3. footer_links_support_url = http://your.support.site
  4. footer_links_guides_text = Guides
  5. footer_links_guides_url = http://your.guides.site
  6. footer_links_extracustom_text = Custom text
  7. footer_links_extracustom_url = http://your.custom.site

Here is the same example using environment variables instead of the custom.ini or grafana.ini file.

  1. GF_WHITE_LABELING_FOOTER_LINKS=support guides extracustom
  2. GF_WHITE_LABELING_FOOTER_LINKS_SUPPORT_TEXT=Support
  3. GF_WHITE_LABELING_FOOTER_LINKS_SUPPORT_URL=http://your.support.site
  4. GF_WHITE_LABELING_FOOTER_LINKS_GUIDES_TEXT=Guides
  5. GF_WHITE_LABELING_FOOTER_LINKS_GUIDES_URL=http://your.guides.site
  6. GF_WHITE_LABELING_FOOTER_LINKS_EXTRACUSTOM_TEXT=Custom Text
  7. GF_WHITE_LABELING_FOOTER_LINKS_EXTRACUSTOM_URL=http://your.custom.site

Note: The following two links are always present in the footer:

  • Grafana edition
  • Grafana version with build number

If you specify footer_links or GF_WHITE_LABELING_FOOTER_LINKS, then all other default links are removed from the footer and only what is specified is included.