2022-05-26 10:06:25 -05:00
---
aliases:
- /docs/grafana/latest/enterprise/white-labeling/
2022-06-02 11:57:22 -05:00
- /docs/grafana/latest/setup-grafana/enable-custom-branding/
description: Change the look of Grafana to match your corporate brand.
title: Enable custom branding
2022-05-26 10:06:25 -05:00
weight: 1300
---
2020-01-24 09:33:59 -06:00
2022-06-02 11:57:22 -05:00
# Enable custom branding
2020-01-24 09:33:59 -06:00
2022-06-02 11:57:22 -05:00
Custom branding allows you to replace the Grafana brand and logo with your own corporate brand and logo.
2020-01-24 09:33:59 -06:00
2022-06-02 11:57:22 -05:00
> **Note:** Available in [Grafana Enterprise]({{< relref "../enterprise/" >}}) and [Grafana Cloud Advanced]({{< ref "/docs/grafana-cloud" >}}).
2020-01-24 09:33:59 -06:00
2022-06-02 11:57:22 -05:00
Grafana Enterprise has custom branding options in the `grafana.ini` file. As with all configuration options, you can also set them with environment variables.
2020-01-24 09:33:59 -06:00
You can change the following elements:
2020-03-10 15:54:19 -05:00
- Application title
- Login background
- Login logo
2020-01-24 09:33:59 -06:00
- Side menu top logo
2020-03-10 15:54:19 -05:00
- Footer and help menu links
2020-01-24 09:33:59 -06:00
- Fav icon (shown in browser tab)
2020-05-07 04:00:47 -05:00
- 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+)
2021-07-02 07:17:10 -05:00
- Loading logo
2020-01-24 09:33:59 -06:00
2022-06-02 11:57:22 -05:00
> You will have to host your logo and other images used by the custom branding feature separately. Make sure Grafana can access the URL where the assets are stored.
2020-03-10 15:54:19 -05:00
2022-06-02 11:57:22 -05:00
{{< figure src = "/static/img/docs/v66/whitelabeling_1.png" max-width = "800px" caption = "Custom branding example" > }}
2020-03-10 15:54:19 -05:00
2022-06-02 11:57:22 -05:00
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 ]({{< relref "configure-grafana/" >}} ).
2020-01-24 09:33:59 -06:00
```ini
# Enterprise only
[white_labeling]
2020-02-25 08:18:37 -06:00
# Set to your company name to override application title
;app_title =
2020-05-07 04:00:47 -05:00
# Set to main title on the login page (Will not appear if a login logo is set)
;login_title =
# Set to login subtitle (Will not appear if a login logo is set)
;login_subtitle =
2020-02-14 10:11:08 -06:00
# Set to complete URL to override login logo
2020-01-24 09:33:59 -06:00
;login_logo =
2020-05-07 04:00:47 -05:00
# Set to complete CSS background expression to override login background
2020-01-24 09:33:59 -06:00
# example: login_background = url(http://www.bhmpics.com/wallpapers/starfield-1920x1080.jpg)
;login_background =
2020-05-07 04:00:47 -05:00
# Set to complete CSS background expression to override login box background
;login_box_background =
2020-02-14 10:11:08 -06:00
# Set to complete URL to override menu logo
2020-01-24 09:33:59 -06:00
;menu_logo =
2020-02-14 10:11:08 -06:00
# Set to complete URL to override fav icon (icon shown in browser tab)
2020-01-24 09:33:59 -06:00
;fav_icon =
2020-02-14 10:11:08 -06:00
# Set to complete URL to override apple/ios icon
2020-01-24 09:33:59 -06:00
;apple_touch_icon =
2021-07-02 07:17:10 -05:00
# Set to complete URL to override loading logo
2021-08-04 02:36:42 -05:00
;loading_logo =
2020-03-10 15:54:19 -05:00
```
2021-08-06 08:52:36 -05:00
2021-03-29 11:29:41 -05:00
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.
2020-03-10 15:54:19 -05:00
```ini
2021-03-29 11:29:41 -05:00
footer_links = support guides extracustom
2020-03-10 15:54:19 -05:00
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
2021-03-29 11:29:41 -05:00
footer_links_extracustom_text = Custom text
footer_links_extracustom_url = http://your.custom.site
2020-01-24 09:33:59 -06:00
```
2020-02-20 09:01:58 -06:00
2020-03-10 15:54:19 -05:00
Here is the same example using environment variables instead of the custom.ini or grafana.ini file.
2020-02-20 09:01:58 -06:00
```
2021-03-29 11:29:41 -05:00
GF_WHITE_LABELING_FOOTER_LINKS=support guides extracustom
2020-03-10 15:54:19 -05:00
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
2020-05-07 04:00:47 -05:00
GF_WHITE_LABELING_FOOTER_LINKS_GUIDES_URL=http://your.guides.site
2021-03-29 11:29:41 -05:00
GF_WHITE_LABELING_FOOTER_LINKS_EXTRACUSTOM_TEXT=Custom Text
GF_WHITE_LABELING_FOOTER_LINKS_EXTRACUSTOM_URL=http://your.custom.site
2020-02-20 09:01:58 -06:00
```
2021-03-29 11:29:41 -05:00
> **Note:** The following two links are always present in the footer:
2021-08-06 08:52:36 -05:00
2021-03-29 11:29:41 -05:00
- 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.