github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-23 17:28:26 -04:00
Code Issues Projects Releases Packages Wiki Activity

Add an example of uiSettings override (#135385)

Browse source 
Co-authored-by: Matthias Wilhelm <matthias.wilhelm@elastic.co>
Co-authored-by: Luke Elmers <luke.elmers@elastic.co>
This commit is contained in:
Mat Schaffer 2022-06-30 12:08:55 +09:00 • committed by GitHub
parent aa30b1283c
commit 8e392a6eed
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

10
docs/developer/architecture/core/uisettings-service.asciidoc
View file

@ -26,6 +26,16 @@ Configuration through the Advanced Settings UI is restricted to users authorised
=== Configuration with UI settings overrides
experimental[] When a setting is configured as an override in kibana.yml, it will override any other value stored in the config saved object. If an override is misconfigured, it will fail config validation and prevent Kibana from starting up. The override applies to Kibana as a whole for all spaces and users and the option will be disabled in the Advanced Settings page. We refer to these as "global" overrides.
Use the top-level `uiSettings` key for this, for example:
[source,yaml]
----
# Display times in UTC
uiSettings:
overrides:
"dateFormat:tz": "UTC"
----
[[client-side-usage]]
=== Client side usage
On the client, the `uiSettings` service is exposed directly from `core` and the {kib-repo}blob/{branch}/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.md[client] provides plugins access to the `config` entries stored in {es}.