kibana/docs/settings/banners-settings.asciidoc
Pierre Gayvallet a4b185b86d
add per space configuration to custom header banner (#94449) (#95897)
* 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
# Conflicts:
#	src/plugins/kibana_usage_collection/server/collectors/management/schema.ts
#	src/plugins/kibana_usage_collection/server/collectors/management/types.ts
#	src/plugins/telemetry/schema/oss_plugins.json

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-03-31 10:36:57 -04:00

39 lines
989 B
Plaintext

[role="xpack"]
[[banners-settings-kb]]
=== Banner settings in {kib}
++++
<titleabbrev>Banners settings</titleabbrev>
++++
Banners are disabled by default. You need to manually configure them in order to use the feature.
You can configure the `xpack.banners` settings in your `kibana.yml` file.
[NOTE]
====
Banners are a https://www.elastic.co/subscriptions[subscription feature].
====
[[general-banners-settings-kb]]
==== General banner settings
[cols="2*<"]
|===
| `xpack.banners.placement`
| Set to `top` to display a banner above the Elastic header. Defaults to `disabled`.
| `xpack.banners.textContent`
| The text to display inside the banner, either plain text or Markdown.
| `xpack.banners.textColor`
| The color for the banner text. Defaults to `#8A6A0A`.
| `xpack.banners.backgroundColor`
| The color of the banner background. Defaults to `#FFF9E8`.
| `xpack.banners.disableSpaceBanners`
| If true, per-space banner overrides will be disabled. Defaults to `false`.
|===