github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-23 09:19:04 -04:00
Code Issues Projects Releases Packages Wiki Activity
kibana/x-pack/plugins/banners/README.md
Pierre Gayvallet ddac0e9501
add per space configuration to custom header banner (#94449) 
* restore the banners ui settings

* fix banner init logic

* fix unit tests

* update telemetry schema

* add basic server-side plugin tests

* add FTR tests for banners plugin

* use keyword for sensitive setting

* update snapshots

* setting name consistency with configuration properties

* fix setting names in telemetry files

* open banner links in new tab

* add config.disableSpaceBanners property

* fix types

* add descriptions to banner settings

* change label and value header->top

* finishing header->top replacement

* doc nits

* add banners section to advanced options doc

* feedback on advanced options doc

* adapt deprecation to new format
2021-03-31 10:57:06 +02:00

868 B
Raw Permalink Blame History

Kibana banners plugin

Allow to add a header banner that will be displayed on every page of the Kibana application

Configuration

The plugin's configuration prefix is xpack.banners

The options are

  • placement

The placement of the banner. The allowed values are:

  • disabled - The banner will be disabled

  • top - The banner will be displayed in the header

  • textContent

The text content that will be displayed inside the banner, either plain text or markdown

  • textColor

The color of the banner's text. Must be a valid hex color

  • backgroundColor

The color for the banner's background. Must be a valid hex color

Configuration example

kibana.yml

xpack.banners:
  placement: 'top'
  textContent: 'Production environment - Proceed with **special levels** of caution'
  textColor: '#FF0000'
  backgroundColor: '#CC2211'