maxmustermann/kibana
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
kibana/x-pack/plugins/banners/README.md
Pierre Gayvallet 570dcc07b5
Implement custom global header banner (#87438) 
* first draft

* update plugin list

* fix tsproject

* update bundle limits file

* remove unused start dep

* adapt imports

* POC of footer banner

* update styles, mostly

* plug banner to uiSettings

* adding some unit tests

* add tests on sort_fields

* cleanup sums in sass mixins

* some self review stuff

* update generated doc

* add tests for color field

* update chrome header test snapshots

* retrieve license info from the server

* switch from uiSettings to plugin config

* update plugin list description

* update default colors

* NIT

* add markdown support

* fix banner overlap in fullscreen mode

* change banner height to 32px

* change banner's font size to 14

* delete unused uiSettings
2021-02-11 10:12:24 +01:00

874 B
Raw 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

  • header - 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: 'header'
  textContent: 'Production environment - Proceed with **special levels** of caution'
  textColor: '#FF0000'
  backgroundColor: '#CC2211'