From d7f72f278589a9ab64e103120bb971993a17a711 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89amon=20Ryan?= Date: Mon, 29 Mar 2021 09:29:41 -0700 Subject: [PATCH] Docs: Clarified Enterprise white-labeling footer text (#32269) * Clarified white-labeling footer text * Update docs/sources/enterprise/white-labeling.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/enterprise/white-labeling.md Co-authored-by: Ursula Kallio <73951760+osg-grafana@users.noreply.github.com> * Update docs/sources/enterprise/white-labeling.md Co-authored-by: Ursula Kallio <73951760+osg-grafana@users.noreply.github.com> * Updated wording * Updated capitalisation * Update docs/sources/enterprise/white-labeling.md Co-authored-by: Ursula Kallio <73951760+osg-grafana@users.noreply.github.com> Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> Co-authored-by: Ursula Kallio <73951760+osg-grafana@users.noreply.github.com> --- docs/sources/enterprise/white-labeling.md | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/docs/sources/enterprise/white-labeling.md b/docs/sources/enterprise/white-labeling.md index 61bd60481d1..05e1589e3f5 100644 --- a/docs/sources/enterprise/white-labeling.md +++ b/docs/sources/enterprise/white-labeling.md @@ -63,23 +63,33 @@ The configuration file in Grafana Enterprise contains the following options. Eac # Set to complete URL to override apple/ios icon ;apple_touch_icon = ``` - -Below is an example for how to replace the default footer and help links with two custom links. +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. ```ini -footer_links = support guides +footer_links = support guides extracustom 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 +footer_links_extracustom_text = Custom text +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. ``` -GF_WHITE_LABELING_FOOTER_LINKS=support guides +GF_WHITE_LABELING_FOOTER_LINKS=support guides extracustom 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 +GF_WHITE_LABELING_FOOTER_LINKS_EXTRACUSTOM_TEXT=Custom Text +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.