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

[8.8] [DOCS] Adds Global Settings (#157769) (#157780)

Browse source 
# Backport

This will backport the following commits from `main` to `8.8`:
- [[DOCS] Adds Global Settings
(#157769)](https://github.com/elastic/kibana/pull/157769)

<!--- Backport version: 8.9.7 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Kaarina
Tungseth","email":"kaarina.tungseth@elastic.co"},"sourceCommit":{"committedDate":"2023-05-15T17:41:51Z","message":"[DOCS]
Adds Global Settings (#157769)\n\n## Summary\r\n\r\nAdds the 8.8 docs
for Kibana Global Settings,
including\r\nhttps://github.com/elastic/kibana/pull/151631.\r\n\r\nDocs
preview:\r\nhttps://kibana_157769.docs-preview.app.elstc.co/guide/en/kibana/master/advanced-options.html#kibana-global-settings-reference","sha":"037ff39062e81f0e3a39af8c606007247bd4794c","branchLabelMapping":{"^v8.9.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","release_note:skip","Team:SharedUX","v8.8.0","v8.9.0"],"number":157769,"url":"https://github.com/elastic/kibana/pull/157769","mergeCommit":{"message":"[DOCS]
Adds Global Settings (#157769)\n\n## Summary\r\n\r\nAdds the 8.8 docs
for Kibana Global Settings,
including\r\nhttps://github.com/elastic/kibana/pull/151631.\r\n\r\nDocs
preview:\r\nhttps://kibana_157769.docs-preview.app.elstc.co/guide/en/kibana/master/advanced-options.html#kibana-global-settings-reference","sha":"037ff39062e81f0e3a39af8c606007247bd4794c"}},"sourceBranch":"main","suggestedTargetBranches":["8.8"],"targetPullRequestStates":[{"branch":"8.8","label":"v8.8.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.9.0","labelRegex":"^v8.9.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/157769","number":157769,"mergeCommit":{"message":"[DOCS]
Adds Global Settings (#157769)\n\n## Summary\r\n\r\nAdds the 8.8 docs
for Kibana Global Settings,
including\r\nhttps://github.com/elastic/kibana/pull/151631.\r\n\r\nDocs
preview:\r\nhttps://kibana_157769.docs-preview.app.elstc.co/guide/en/kibana/master/advanced-options.html#kibana-global-settings-reference","sha":"037ff39062e81f0e3a39af8c606007247bd4794c"}}]}]
BACKPORT-->

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
This commit is contained in:
Kibana Machine 2023-05-15 14:07:14 -04:00 • committed by GitHub
parent 90b5d06459
commit c13899a542
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 51 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

61
docs/management/advanced-options.asciidoc
View file

@ -1,12 +1,13 @@
[[advanced-options]]
== Advanced Settings
*Advanced Settings* control the behavior of {kib}. For example, you can change the format used to display dates,
specify the default data view, and set the precision for displayed decimal values.
*Advanced Settings* control the behavior of {kib}. You can change the settings that apply to spaces, or to all of {kib}. For example, you can change the format used to display dates,
specify the default data view, and apply your own branding.
. Open the main menu, then click *Stack Management > Advanced Settings*.
. Scroll or search for the setting.
. Make your change, then click *Save changes*.
WARNING: Changing a setting can affect {kib} performance and cause problems
that are difficult to diagnose. Setting a property value to a blank field
reverts to the default behavior, which might not be compatible with other
configuration settings. Deleting a custom setting permanently removes it from {kib}.
[float]
=== Required permissions
@ -25,12 +26,14 @@ For more information on granting access to {kib}, refer to <<xpack-security-auth
[float]
[[kibana-settings-reference]]
=== {kib} settings reference
=== Change the space settings
WARNING: Changing a setting can affect {kib} performance and cause problems
that are difficult to diagnose. Setting a property value to a blank field
reverts to the default behavior, which might not be compatible with other
configuration settings. Deleting a custom setting permanently removes it from {kib}.
Change the settings that apply only to {kib} spaces.
. Open the main menu, then click *Stack Management > Advanced Settings*.
. Click *Space Settings*.
. Scroll or search for the setting.
. Make your change, then click *Save changes*.
[float]
[[kibana-general-settings]]
@ -554,3 +557,41 @@ only production-ready visualizations are available to users.
[[telemetry-enabled-advanced-setting]]`telemetry:enabled`::
When enabled, helps improve the Elastic Stack by providing usage statistics for
basic features.
[float]
[[kibana-global-settings-reference]]
=== Change the global settings
Change the settings that apply only to {kib} spaces.
. Open the main menu, then click *Stack Management > Advanced Settings*.
. Click *Global Settings*.
. Scroll or search for the setting.
. Make your change, then click *Save changes*.
[float]
[[kibana-custom-branding-settings]]
==== Custom branding
[horizontal]
[[custom-logo]]`xpackCustomBranding:logo`::
A custom image that appears in the header of all {kib} pages. Images must have a transparent background, and 128 x 128 pixels or smaller.
[[organization-name]]`xpackCustomBranding:customizedLogo`::
The custom text that appears in the header of all {kib} pages. Images must have a transparent background, and 200 x 84 pixels or smaller.
[[page-title]]`xpackCustomBranding:pageTitle`::
The custom text that appears on {kib} browser tabs.
[[favicon-svg]]`xpackCustomBranding:faviconSVG`::
The URL of a custom SVG image that appears on {kib} browser tabs. Images must be 16 x 16 pixels.
[[favicon-png]]`xpackCustomBranding:faviconPNG`::
The URL of a custom PNG image that appears on {kib} browser tabs.
[float]
[[kibana-usage-data-settings]]
==== Usage Data
[[provide-usage-data]]`telemetry:enabled`::
When enabled, helps manage and improve Elastic products and services by providing usage statistics.