From c1b10e4f0c247d2053b6f1ce5ac87471b04d85a2 Mon Sep 17 00:00:00 2001 From: "lean.dev" <34773040+leandro-deveikis@users.noreply.github.com> Date: Thu, 3 Nov 2022 14:58:43 -0300 Subject: [PATCH] Docs: Adding documentation for custom branding on public dashboards (#58090) Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com> --- .../dashboards/dashboard-public/index.md | 4 ++++ .../configure-custom-branding/index.md | 24 +++++++++++++++++++ 2 files changed, 28 insertions(+) diff --git a/docs/sources/dashboards/dashboard-public/index.md b/docs/sources/dashboards/dashboard-public/index.md index 16783ae386e..9ae2b9fa22d 100644 --- a/docs/sources/dashboards/dashboard-public/index.md +++ b/docs/sources/dashboards/dashboard-public/index.md @@ -163,3 +163,7 @@ guaranteed because plugin developers can override this functionality. The follow - Datasources using Reverse Proxy functionality are not supported. We are excited to share this enhancement with you and we’d love your feedback! Please check out the [Github](https://github.com/grafana/grafana/discussions/49253) discussion and join the conversation. + +#### Custom branding + +If you are a Grafana Enterprise customer, you can use custom branding to change the appearance of a public dashboard footer. For more information, refer to [Custom branding](https://grafana.com/docs/grafana/latest/setup-grafana/configure-grafana/configure-custom-branding/). diff --git a/docs/sources/setup-grafana/configure-grafana/configure-custom-branding/index.md b/docs/sources/setup-grafana/configure-grafana/configure-custom-branding/index.md index 1aff7dc5dcf..7b4d9c39fa4 100644 --- a/docs/sources/setup-grafana/configure-grafana/configure-custom-branding/index.md +++ b/docs/sources/setup-grafana/configure-grafana/configure-custom-branding/index.md @@ -101,3 +101,27 @@ GF_WHITE_LABELING_FOOTER_LINKS_EXTRACUSTOM_URL=http://your.custom.site - 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. + +## Custom branding for Public Dashboards + +In addition to the customizations described below, you can customize the footer of your public dashboards. +To customize the footer of a public dashboard, add the following section to the `grafana.ini` file. + +```ini +[white_labeling.public_dashboards] + +# Hides the footer for the public dashboards if set to "true". If +# example: footer_hide = "true" +;footer_hide = + +# Set to text shown in the footer +;footer_text = + +# Set to complete url to override public dashboard footer logo +;footer_logo = + +# Set to link for the footer +;footer_link = +``` + +If you specify `footer_hide` to `true`, all the other values are ignored because the footer will not be shown.