grafana/docs/sources/enterprise/white-labeling.md
Agnès Toulet 1dd404a1fb
Core: Make application title customizable for WL (#22401)
* Core: Add custom app title

* Docs: Update White Labeling title customization

* Core: set back export for Branding types
2020-02-25 15:18:37 +01:00

2.0 KiB

+++ title = "White-labeling" description = "White-labeling" keywords = ["grafana", "white-labeling", "enterprise"] aliases = ["/docs/grafana/latest/enterprise/white-labeling/"] type = "docs" [menu.docs] name = "White-labeling" parent = "enterprise" weight = 5 +++

White labeling

Only available in Grafana Enterprise v6.6+.

{{< docs-imagebox img="/img/docs/v66/whitelabeling_1.png" max-width="800px" caption="White labeling example" >}}

Grafana Enterprise has white labeling options in the grafana.ini file (can also be set via ENV variables).

You can change the following elements:

  • Application Title
  • Login Background
  • Login Logo
  • Side menu top logo
  • Footer & Help menu links
  • Fav icon (shown in browser tab)

You will have to host your logo and other images used by the white labeling feature separately.

# Enterprise only
[white_labeling]
# Set to your company name to override application title
;app_title =

# Set to complete URL to override login logo
;login_logo =

# Set to complete css background expression to override login background
# example: login_background = url(http://www.bhmpics.com/wallpapers/starfield-1920x1080.jpg)
;login_background =

# Set to complete URL to override menu logo
;menu_logo =

# Set to complete URL to override fav icon (icon shown in browser tab)
;fav_icon =

# Set to complete URL to override apple/ios icon
;apple_touch_icon =

# Below is an example for how to replace the default footer & help links with 2 custom links
;footer_links = support guides
;footer_links_support_text = Support
;footer_links_support_url = http://your.support.site
;footer_links_guides_text = Guides
;footer_links_guides_url = http://your.guides.site

ENV Variables:

- GF_WHITE_LABELING_FOOTER_LINKS=support guides
- GF_WHITE_LABELING_FOOTER_LINKS_SUPPORT_TEXT=Support
- GF_WHITE_LABELING_FOOTER_LINKS_SUPPORT_URL=http://your.support.site
- GF_WHITE_LABELING_FOOTER_LINKS_GUIDES_TEXT=Guides
- GF_WHITE_LABELING_FOOTER_LINKS_GUIDES_URL=http://your.guides.site