Документацияbreadcrumb arrow Grafanabreadcrumb arrow Документация GlaberGraphbreadcrumb arrow Настройкаbreadcrumb arrow Настройка Grafanabreadcrumb arrow Настройка пользовательского брендинга

Настройка пользовательского брендинга

Пользовательский брендинг позволяет заменить бренд и логотип Grafana Labs на ваш корпоративный бренд и логотип.

Note

Доступно в Grafana Enterprise и платных учётных записях Grafana Cloud. Бесплатные планы Grafana Cloud поддерживают только настройку заголовка входа и ссылок в подвале. Пользователям Cloud: нажмите Open a Support Ticket в Cloud Portal, чтобы создать обращение для настройки пользовательского брендинга.

Файл grafana.ini содержит пользовательский брендинг Grafana Enterprise. Как и все параметры конфигурации, вы можете использовать переменные среды для настройки пользовательского брендинга.

С помощью пользовательского брендинга вы можете изменить следующие элементы. Наведите курсор на номер, чтобы узнать больше о каждом элементе.

Grafana login page with interactive callouts highlighting customizable branding elements

  1. Login background (login_background)

    The full-page background behind the login card. Accepts any valid CSS background value, including url() for images.

  2. Login box background (login_box_background)

    The background of the login form card. Accepts any valid CSS background expression.

  3. Login logo (login_logo)

    The logo at the top of the login card. Grafana recommends SVG files, 48x48 pixels or smaller. When set, the login title and subtitle don’t appear.

  4. Login title (login_title)

    The main heading on the login page. Defaults to “Welcome to Grafana”. Doesn’t appear if a login logo is set.

  5. Login subtitle (login_subtitle)

    Secondary text below the login title. Empty by default. Doesn’t appear if a login logo is set.

  6. Footer and help menu links (footer_links)

    Links shown at the bottom of the login page. These same links also appear in the Help menu when logged in. By default: Documentation, Support, and Community.

Grafana home page with interactive callouts highlighting the fav icon, application title, and side menu logo

  1. Fav icon (fav_icon)

    The small icon in the browser tab. Defaults to the Grafana sunburst icon.

  2. Application title (app_title)

    The text appended to every page title in the browser tab. Defaults to “Grafana”. This setting controls the name in both the browser tab and the main menu header.

  3. Side menu top logo (menu_logo)

    The logo in the top-left corner of the application, also shown in the main menu header.

  4. Application title (app_title)

    The application name in the main menu header, next to the side menu logo. This setting controls the name in both the main menu header and the browser tab.

Вы также можете настроить логотип загрузки (loading_logo), который отображается во время заставки первоначальной загрузки страницы.

Вам придётся размещать свой логотип и другие изображения, используемые функцией пользовательского брендинга, отдельно. Убедитесь, что Grafana может получить доступ к URL, где хранятся эти ресурсы.

Файл конфигурации в Grafana Enterprise содержит следующие параметры. Дополнительную информацию о настройке Grafana см. в разделе Настройка Grafana.

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

# 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 =

# 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 CSS background expression to override login box background
;login_box_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 =

# Set to complete URL to override loading logo
;loading_logo =

# Set to `true` to remove the Grafana edition from appearing in the footer
;hide_edition =

Note

Для параметра login_logo Grafana рекомендует использовать SVG-файлы размером 48 на 48 пикселей или меньше. Также вам не нужно использовать функцию url() для login_logo.

Кроме того, вы можете скопировать изображения в локальный каталог изображений Grafana, /usr/share/grafana/public/img/, и установить login_logo в сохранённое изображение. Например:

ini 
login_logo = /public/img/<YOUR_LOGO.svg>

У вас есть возможность добавить пользовательские ссылки вместо ссылок в подвале по умолчанию (Documentation, Support, Community). Ниже приведён пример того, как заменить ссылки в подвале и справке по умолчанию пользовательскими ссылками.

ini 
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

Следующий пример показывает настройку пользовательского брендинга с помощью переменных среды вместо файлов custom.ini или grafana.ini.

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

Следующие две ссылки всегда присутствуют в подвале:

  • Редакция Grafana
  • Версия Grafana с номером сборки

Если вы укажете footer_links или GF_WHITE_LABELING_FOOTER_LINKS, то все остальные ссылки по умолчанию удаляются из подвала, и включается только указанное.

Пользовательский брендинг для общих дашбордов

В дополнение к настройкам, описанным ниже, вы можете настроить подвал ваших общих дашбордов. Чтобы настроить подвал общего дашборда, добавьте следующий раздел в файл grafana.ini.

ini 
[white_labeling.public_dashboards]

# Hides the footer for the shared dashboards if set to `true`.
# example: footer_hide = "true"
;footer_hide =

# Set to text shown in the footer
;footer_text =

# Set to complete url to override shared dashboard footer logo. Default is `grafana-logo` and will display the Grafana logo.
# An empty value will hide the footer logo.
;footer_logo =

# Set to link for the footer
;footer_link =

# Set to `true` to hide the Grafana logo next to the title
;header_logo_hide =

Если вы установите footer_hide в true, все остальные значения игнорируются, поскольку подвал не будет отображаться.