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

[DOCS] Reformats settings tables (#64844) (#65094)

Browse source 
* Formats settings into tables

* Formatting

* Formatting
# Conflicts:
#	docs/settings/general-infra-logs-ui-settings.asciidoc
#	docs/settings/telemetry-settings.asciidoc
#	docs/setup/settings.asciidoc
This commit is contained in:
Kaarina Tungseth 2020-05-04 10:48:29 -05:00 • committed by GitHub
parent 7006ee6bb0
commit 4cdd065a16
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
13 changed files with 901 additions and 540 deletions
Download patch file Download diff file Expand all files Collapse all files

39
docs/settings/alert-action-settings.asciidoc
View file

@ -5,7 +5,7 @@
<titleabbrev>Alerting and action settings</titleabbrev>
++++
Alerts and actions are enabled by default in {kib}, but require you configure the following in order to use them:
Alerts and actions are enabled by default in {kib}, but require you configure the following in order to use them:
. <<using-kibana-with-security,Set up {kib} to work with {stack} {security-features}>>.
. <<configuring-tls-kib-es,Set up TLS encryption between {kib} and {es}>>.
@ -18,27 +18,36 @@ You can configure the following settings in the `kibana.yml` file.
[[general-alert-action-settings]]
==== General settings
`xpack.encryptedSavedObjects.encryptionKey`::
[cols="2*<"]
|===
A string of 32 or more characters used to encrypt sensitive properties on alerts and actions before they're stored in {es}. Third party credentials &mdash; such as the username and password used to connect to an SMTP service &mdash; are an example of encrypted properties.
+
If not set, {kib} will generate a random key on startup, but all alert and action functions will be blocked. Generated keys are not allowed for alerts and actions because when a new key is generated on restart, existing encrypted data becomes inaccessible. For the same reason, alerts and actions in high-availability deployments of {kib} will behave unexpectedly if the key isn't the same on all instances of {kib}.
+
Although the key can be specified in clear text in `kibana.yml`, it's recommended to store this key securely in the <<secure-settings,{kib} Keystore>>.
| `xpack.encryptedSavedObjects.encryptionKey`
| A string of 32 or more characters used to encrypt sensitive properties on alerts and actions before they're stored in {es}. Third party credentials &mdash; such as the username and password used to connect to an SMTP service &mdash; are an example of encrypted properties. +
+
If not set, {kib} will generate a random key on startup, but all alert and action functions will be blocked. Generated keys are not allowed for alerts and actions because when a new key is generated on restart, existing encrypted data becomes inaccessible. For the same reason, alerts and actions in high-availability deployments of {kib} will behave unexpectedly if the key isn't the same on all instances of {kib}. +
+
Although the key can be specified in clear text in `kibana.yml`, it's recommended to store this key securely in the <<secure-settings,{kib} Keystore>>.
|===
[float]
[[action-settings]]
==== Action settings
`xpack.actions.whitelistedHosts`::
A list of hostnames that {kib} is allowed to connect to when built-in actions are triggered. It defaults to `[*]`, allowing any host, but keep in mind the potential for SSRF attacks when hosts are not explicitly whitelisted. An empty list `[]` can be used to block built-in actions from making any external connections.
+
Note that hosts associated with built-in actions, such as Slack and PagerDuty, are not automatically whitelisted. If you are not using the default `[*]` setting, you must ensure that the corresponding endpoints are whitelisted as well.
[cols="2*<"]
|===
`xpack.actions.enabledActionTypes`::
A list of action types that are enabled. It defaults to `[*]`, enabling all types. The names for built-in {kib} action types are prefixed with a `.` and include: `.server-log`, `.slack`, `.email`, `.index`, `.pagerduty`, and `.webhook`. An empty list `[]` will disable all action types.
+
Disabled action types will not appear as an option when creating new connectors, but existing connectors and actions of that type will remain in {kib} and will not function.
| `xpack.actions.whitelistedHosts`
| A list of hostnames that {kib} is allowed to connect to when built-in actions are triggered. It defaults to `[*]`, allowing any host, but keep in mind the potential for SSRF attacks when hosts are not explicitly whitelisted. An empty list `[]` can be used to block built-in actions from making any external connections. +
+
Note that hosts associated with built-in actions, such as Slack and PagerDuty, are not automatically whitelisted. If you are not using the default `[*]` setting, you must ensure that the corresponding endpoints are whitelisted as well.
| `xpack.actions.enabledActionTypes`
| A list of action types that are enabled. It defaults to `[*]`, enabling all types. The names for built-in {kib} action types are prefixed with a `.` and include: `.server-log`, `.slack`, `.email`, `.index`, `.pagerduty`, and `.webhook`. An empty list `[]` will disable all action types. +
+
Disabled action types will not appear as an option when creating new connectors, but existing connectors and actions of that type will remain in {kib} and will not function.
|===
[float]
[[alert-settings]]

39
docs/settings/apm-settings.asciidoc
View file

@ -43,27 +43,42 @@ If you'd like to change any of the default values,
copy and paste the relevant settings into your `kibana.yml` configuration file.
Changing these settings may disable features of the APM App.
xpack.apm.enabled:: Set to `false` to disable the APM app. Defaults to `true`.
[cols="2*<"]
|===
| `xpack.apm.enabled`
| Set to `false` to disable the APM app. Defaults to `true`.
xpack.apm.ui.enabled:: Set to `false` to hide the APM app from the menu. Defaults to `true`.
| `xpack.apm.ui.enabled`
| Set to `false` to hide the APM app from the menu. Defaults to `true`.
xpack.apm.ui.transactionGroupBucketSize:: Number of top transaction groups displayed in the APM app. Defaults to `100`.
| `xpack.apm.ui.transactionGroupBucketSize`
| Number of top transaction groups displayed in the APM app. Defaults to `100`.
xpack.apm.ui.maxTraceItems:: Maximum number of child items displayed when viewing trace details. Defaults to `1000`.
| `xpack.apm.ui.maxTraceItems`
| Maximum number of child items displayed when viewing trace details. Defaults to `1000`.
apm_oss.indexPattern:: The index pattern used for integrations with Machine Learning and Query Bar.
It must match all apm indices. Defaults to `apm-*`.
| `apm_oss.indexPattern`
| The index pattern used for integrations with Machine Learning and Query Bar.
It must match all apm indices. Defaults to `apm-*`.
apm_oss.errorIndices:: Matcher for all {apm-server-ref}/error-indices.html[error indices]. Defaults to `apm-*`.
| `apm_oss.errorIndices`
| Matcher for all {apm-server-ref}/error-indices.html[error indices]. Defaults to `apm-*`.
apm_oss.onboardingIndices:: Matcher for all onboarding indices. Defaults to `apm-*`.
| `apm_oss.onboardingIndices`
| Matcher for all onboarding indices. Defaults to `apm-*`.
apm_oss.spanIndices:: Matcher for all {apm-server-ref}/span-indices.html[span indices]. Defaults to `apm-*`.
| `apm_oss.spanIndices`
| Matcher for all {apm-server-ref}/span-indices.html[span indices]. Defaults to `apm-*`.
apm_oss.transactionIndices:: Matcher for all {apm-server-ref}/transaction-indices.html[transaction indices]. Defaults to `apm-*`.
| `apm_oss.transactionIndices`
| Matcher for all {apm-server-ref}/transaction-indices.html[transaction indices]. Defaults to `apm-*`.
apm_oss.metricsIndices:: Matcher for all {apm-server-ref}/metricset-indices.html[metrics indices]. Defaults to `apm-*`.
| `apm_oss.metricsIndices`
| Matcher for all {apm-server-ref}/metricset-indices.html[metrics indices]. Defaults to `apm-*`.
apm_oss.sourcemapIndices:: Matcher for all {apm-server-ref}/sourcemap-indices.html[source map indices]. Defaults to `apm-*`.
| `apm_oss.sourcemapIndices`
| Matcher for all {apm-server-ref}/sourcemap-indices.html[source map indices]. Defaults to `apm-*`.
|===
// end::general-apm-settings[]

16
docs/settings/dev-settings.asciidoc
View file

@ -12,12 +12,20 @@ They are enabled by default.
[[grok-settings]]
==== Grok Debugger settings
`xpack.grokdebugger.enabled`::
Set to `true` (default) to enable the <<xpack-grokdebugger,Grok Debugger>>.
[cols="2*<"]
|===
| `xpack.grokdebugger.enabled`
| Set to `true` to enable the <<xpack-grokdebugger,Grok Debugger>>. Defaults to `true`.
|===
[float]
[[profiler-settings]]
==== {searchprofiler} Settings
`xpack.searchprofiler.enabled`::
Set to `true` (default) to enable the <<xpack-profiler,{searchprofiler}>>.
[cols="2*<"]
|===
| `xpack.searchprofiler.enabled`
| Set to `true` to enable the <<xpack-profiler,{searchprofiler}>>. Defaults to `true`.
|===

31
docs/settings/general-infra-logs-ui-settings.asciidoc
View file

@ -1,17 +1,30 @@
`xpack.infra.enabled`:: Set to `false` to disable the Logs and Metrics app plugin {kib}. Defaults to `true`.
[cols="2*<"]
|===
| `xpack.infra.enabled`
| Set to `false` to disable the Logs and Metrics app plugin {kib}. Defaults to `true`.
`xpack.infra.sources.default.logAlias`:: Index pattern for matching indices that contain log data. Defaults to `filebeat-*,kibana_sample_data_logs*`.
| `xpack.infra.sources.default.logAlias`
| Index pattern for matching indices that contain log data. Defaults to `filebeat-*,kibana_sample_data_logs*`. To match multiple wildcard patterns, use a comma to separate the names, with no space after the comma. For example, `logstash-app1-*,default-logs-*`.
`xpack.infra.sources.default.metricAlias`:: Index pattern for matching indices that contain Metricbeat data. Defaults to `metricbeat-*`.
| `xpack.infra.sources.default.metricAlias`
| Index pattern for matching indices that contain Metricbeat data. Defaults to `metricbeat-*`. To match multiple wildcard patterns, use a comma to separate the names, with no space after the comma. For example, `logstash-app1-*,default-logs-*`.
`xpack.infra.sources.default.fields.timestamp`:: Timestamp used to sort log entries. Defaults to `@timestamp`.
| `xpack.infra.sources.default.fields.timestamp`
| Timestamp used to sort log entries. Defaults to `@timestamp`.
`xpack.infra.sources.default.fields.message`:: Fields used to display messages in the Logs app. Defaults to `['message', '@message']`.
| `xpack.infra.sources.default.fields.message`
| Fields used to display messages in the Logs app. Defaults to `['message', '@message']`.
`xpack.infra.sources.default.fields.tiebreaker`:: Field used to break ties between two entries with the same timestamp. Defaults to `_doc`.
| `xpack.infra.sources.default.fields.tiebreaker`
| Field used to break ties between two entries with the same timestamp. Defaults to `_doc`.
`xpack.infra.sources.default.fields.host`:: Field used to identify hosts. Defaults to `host.name`.
| `xpack.infra.sources.default.fields.host`
| Field used to identify hosts. Defaults to `host.name`.
`xpack.infra.sources.default.fields.container`:: Field used to identify Docker containers. Defaults to `container.id`.
| `xpack.infra.sources.default.fields.container`
| Field used to identify Docker containers. Defaults to `container.id`.
`xpack.infra.sources.default.fields.pod`:: Field used to identify Kubernetes pods. Defaults to `kubernetes.pod.uid`.
| `xpack.infra.sources.default.fields.pod`
| Field used to identify Kubernetes pods. Defaults to `kubernetes.pod.uid`.
|===

9
docs/settings/graph-settings.asciidoc
View file

@ -10,5 +10,10 @@ You do not need to configure any settings to use the {graph-features}.
[float]
[[general-graph-settings]]
==== General graph settings
`xpack.graph.enabled`::
Set to `false` to disable the {graph-features}.
[cols="2*<"]
|===
| `xpack.graph.enabled`
| Set to `false` to disable the {graph-features}.
|===

11
docs/settings/i18n-settings.asciidoc
View file

@ -9,10 +9,7 @@ You do not need to configure any settings to run Kibana in English.
==== General i18n Settings
`i18n.locale`::
Kibana currently supports the following locales:
+
- English - `en` (default)
- Chinese - `zh-CN`
- Japanese - `ja-JP`
{kib} supports the following locales:
* English - `en` (default)
* Chinese - `zh-CN`
* Japanese - `ja-JP`

27
docs/settings/ml-settings.asciidoc
View file

@ -11,12 +11,25 @@ enabled by default.
[[general-ml-settings-kb]]
==== General {ml} settings
`xpack.ml.enabled`::
Set to `true` (default) to enable {kib} {ml-features}. +
+
If set to `false` in `kibana.yml`, the {ml} icon is hidden in this {kib}
instance. If `xpack.ml.enabled` is set to `true` in `elasticsearch.yml`, however,
you can still use the {ml} APIs. To disable {ml} entirely, see the
{ref}/ml-settings.html[{es} {ml} settings].
[cols="2*<"]
|===
| `xpack.ml.enabled`
| Set to `true` (default) to enable {kib} {ml-features}. +
+
If set to `false` in `kibana.yml`, the {ml} icon is hidden in this {kib}
instance. If `xpack.ml.enabled` is set to `true` in `elasticsearch.yml`, however,
you can still use the {ml} APIs. To disable {ml} entirely, see the
{ref}/ml-settings.html[{es} {ml} settings].
|===
[[data-visualizer-settings]]
==== {data-viz} settings
[cols="2*<"]
|===
| `xpack.ml.file_data_visualizer.max_file_size`
| Sets the file size limit when importing data in the {data-viz}. The default
value is `100MB`. The highest supported value for this setting is `1GB`.
|===

157
docs/settings/monitoring-settings.asciidoc
View file

@ -29,45 +29,49 @@ For more information, see
[[monitoring-general-settings]]
==== General monitoring settings
`monitoring.enabled`::
Set to `true` (default) to enable the {monitor-features} in {kib}. Unlike the
`monitoring.ui.enabled` setting, when this setting is `false`, the
monitoring back-end does not run and {kib} stats are not sent to the monitoring
cluster.
[cols="2*<"]
|===
| `monitoring.enabled`
| Set to `true` (default) to enable the {monitor-features} in {kib}. Unlike the
`monitoring.ui.enabled` setting, when this setting is `false`, the
monitoring back-end does not run and {kib} stats are not sent to the monitoring
cluster.
`monitoring.ui.elasticsearch.hosts`::
Specifies the location of the {es} cluster where your monitoring data is stored.
By default, this is the same as `elasticsearch.hosts`. This setting enables
you to use a single {kib} instance to search and visualize data in your
production cluster as well as monitor data sent to a dedicated monitoring
cluster.
| `monitoring.ui.elasticsearch.hosts`
| Specifies the location of the {es} cluster where your monitoring data is stored.
By default, this is the same as `elasticsearch.hosts`. This setting enables
you to use a single {kib} instance to search and visualize data in your
production cluster as well as monitor data sent to a dedicated monitoring
cluster.
`monitoring.ui.elasticsearch.username`::
Specifies the username used by {kib} monitoring to establish a persistent connection
in {kib} to the {es} monitoring cluster and to verify licensing status on the {es}
monitoring cluster.
| `monitoring.ui.elasticsearch.username`
| Specifies the username used by {kib} monitoring to establish a persistent connection
in {kib} to the {es} monitoring cluster and to verify licensing status on the {es}
monitoring cluster. +
+
Every other request performed by the Stack Monitoring UI to the monitoring {es}
cluster uses the authenticated user's credentials, which must be the same on
both the {es} monitoring cluster and the {es} production cluster. +
+
If not set, {kib} uses the value of the `elasticsearch.username` setting.
Every other request performed by the Stack Monitoring UI to the monitoring {es}
cluster uses the authenticated user's credentials, which must be the same on
both the {es} monitoring cluster and the {es} production cluster.
| `monitoring.ui.elasticsearch.password`
| Specifies the password used by {kib} monitoring to establish a persistent connection
in {kib} to the {es} monitoring cluster and to verify licensing status on the {es}
monitoring cluster. +
+
Every other request performed by the Stack Monitoring UI to the monitoring {es}
cluster uses the authenticated user's credentials, which must be the same on
both the {es} monitoring cluster and the {es} production cluster. +
+
If not set, {kib} uses the value of the `elasticsearch.password` setting.
If not set, {kib} uses the value of the `elasticsearch.username` setting.
| `monitoring.ui.elasticsearch.pingTimeout`
| Specifies the time in milliseconds to wait for {es} to respond to internal
health checks. By default, it matches the `elasticsearch.pingTimeout` setting,
which has a default value of `30000`.
`monitoring.ui.elasticsearch.password`::
Specifies the password used by {kib} monitoring to establish a persistent connection
in {kib} to the {es} monitoring cluster and to verify licensing status on the {es}
monitoring cluster.
Every other request performed by the Stack Monitoring UI to the monitoring {es}
cluster uses the authenticated user's credentials, which must be the same on
both the {es} monitoring cluster and the {es} production cluster.
If not set, {kib} uses the value of the `elasticsearch.password` setting.
`monitoring.ui.elasticsearch.pingTimeout`::
Specifies the time in milliseconds to wait for {es} to respond to internal
health checks. By default, it matches the `elasticsearch.pingTimeout` setting,
which has a default value of `30000`.
|===
[float]
[[monitoring-collection-settings]]
@ -75,15 +79,18 @@ which has a default value of `30000`.
These settings control how data is collected from {kib}.
`monitoring.kibana.collection.enabled`::
Set to `true` (default) to enable data collection from the {kib} NodeJS server
for {kib} Dashboards to be featured in the Monitoring.
[cols="2*<"]
|===
| `monitoring.kibana.collection.enabled`
| Set to `true` (default) to enable data collection from the {kib} NodeJS server
for {kib} Dashboards to be featured in the Monitoring.
`monitoring.kibana.collection.interval`::
Specifies the number of milliseconds to wait in between data sampling on the
{kib} NodeJS server for the metrics that are displayed in the {kib} dashboards.
Defaults to `10000` (10 seconds).
| `monitoring.kibana.collection.interval`
| Specifies the number of milliseconds to wait in between data sampling on the
{kib} NodeJS server for the metrics that are displayed in the {kib} dashboards.
Defaults to `10000` (10 seconds).
|===
[float]
[[monitoring-ui-settings]]
@ -94,27 +101,31 @@ However, the defaults work best in most circumstances. For more information
about configuring {kib}, see
{kibana-ref}/settings.html[Setting Kibana Server Properties].
`monitoring.ui.elasticsearch.logFetchCount`::
Specifies the number of log entries to display in the Monitoring UI. Defaults to
`10`. The maximum value is `50`.
[cols="2*<"]
|===
| `monitoring.ui.elasticsearch.logFetchCount`
| Specifies the number of log entries to display in the Monitoring UI. Defaults to
`10`. The maximum value is `50`.
`monitoring.ui.max_bucket_size`::
Specifies the number of term buckets to return out of the overall terms list when
performing terms aggregations to retrieve index and node metrics. For more
information about the `size` parameter, see
{ref}/search-aggregations-bucket-terms-aggregation.html#search-aggregations-bucket-terms-aggregation-size[Terms Aggregation].
Defaults to `10000`.
| `monitoring.ui.max_bucket_size`
| Specifies the number of term buckets to return out of the overall terms list when
performing terms aggregations to retrieve index and node metrics. For more
information about the `size` parameter, see
{ref}/search-aggregations-bucket-terms-aggregation.html#search-aggregations-bucket-terms-aggregation-size[Terms Aggregation].
Defaults to `10000`.
`monitoring.ui.min_interval_seconds`::
Specifies the minimum number of seconds that a time bucket in a chart can
represent. Defaults to 10. If you modify the
`monitoring.ui.collection.interval` in `elasticsearch.yml`, use the same
value in this setting.
| `monitoring.ui.min_interval_seconds`
| Specifies the minimum number of seconds that a time bucket in a chart can
represent. Defaults to 10. If you modify the
`monitoring.ui.collection.interval` in `elasticsearch.yml`, use the same
value in this setting.
`monitoring.ui.enabled`::
Set to `false` to hide the Monitoring UI in {kib}. The monitoring back-end
continues to run as an agent for sending {kib} stats to the monitoring
cluster. Defaults to `true`.
| `monitoring.ui.enabled`
| Set to `false` to hide the Monitoring UI in {kib}. The monitoring back-end
continues to run as an agent for sending {kib} stats to the monitoring
cluster. Defaults to `true`.
|===
[float]
[[monitoring-ui-cgroup-settings]]
@ -125,18 +136,20 @@ better decisions about your container performance, rather than guessing based on
the overall machine performance. If you are not running your applications in a
container, then Cgroup statistics are not useful.
`monitoring.ui.container.elasticsearch.enabled`::
[cols="2*<"]
|===
| `monitoring.ui.container.elasticsearch.enabled`
| For {es} clusters that are running in containers, this setting changes the
*Node Listing* to display the CPU utilization based on the reported Cgroup
statistics. It also adds the calculated Cgroup CPU utilization to the
*Node Overview* page instead of the overall operating system's CPU
utilization. Defaults to `false`.
For {es} clusters that are running in containers, this setting changes the
*Node Listing* to display the CPU utilization based on the reported Cgroup
statistics. It also adds the calculated Cgroup CPU utilization to the
*Node Overview* page instead of the overall operating system's CPU
utilization. Defaults to `false`.
| `monitoring.ui.container.logstash.enabled`
| For {ls} nodes that are running in containers, this setting
changes the {ls} *Node Listing* to display the CPU utilization
based on the reported Cgroup statistics. It also adds the
calculated Cgroup CPU utilization to the {ls} node detail
pages instead of the overall operating system’s CPU utilization. Defaults to `false`.
`monitoring.ui.container.logstash.enabled`::
For {ls} nodes that are running in containers, this setting
changes the {ls} *Node Listing* to display the CPU utilization
based on the reported Cgroup statistics. It also adds the
calculated Cgroup CPU utilization to the {ls} node detail
pages instead of the overall operating system’s CPU utilization. Defaults to `false`.
|===

223
docs/settings/reporting-settings.asciidoc
View file

@ -14,45 +14,54 @@ You can configure `xpack.reporting` settings in your `kibana.yml` to:
[float]
[[general-reporting-settings]]
==== General reporting settings
[[xpack-enable-reporting]]`xpack.reporting.enabled`::
Set to `false` to disable the {report-features}.
`xpack.reporting.encryptionKey`::
Set to any text string. By default, Kibana will generate a random key when it
starts, which will cause pending reports to fail after restart. Configure this
setting to preserve the same key across multiple restarts and multiple instances of Kibana.
[cols="2*<"]
|===
| [[xpack-enable-reporting]]`xpack.reporting.enabled`
| Set to `false` to disable the {report-features}.
| `xpack.reporting.encryptionKey`
| Set to any text string. By default, {kib} will generate a random key when it
starts, which will cause pending reports to fail after restart. Configure this
setting to preserve the same key across multiple restarts and multiple instances of {kib}.
|===
[float]
[[reporting-kibana-server-settings]]
==== Kibana server settings
==== {kib} server settings
Reporting opens the {kib} web interface in a server process to generate
screenshots of {kib} visualizations. In most cases, the default settings
will work and you don't need to configure Reporting to communicate with {kib}.
Reporting opens the {kib} web interface in a server process to generate
screenshots of {kib} visualizations. In most cases, the default settings
will work and you don't need to configure Reporting to communicate with {kib}.
However, if your client connections must go through a reverse-proxy
to access {kib}, Reporting configuration must have the proxy port, protocol,
to access {kib}, Reporting configuration must have the proxy port, protocol,
and hostname set in the `xpack.reporting.kibanaServer.*` settings.
[NOTE]
[NOTE]
====
If a reverse-proxy carries encrypted traffic from end-user
clients back to a {kib} server, the proxy port, protocol, and hostname
in Reporting settings must be valid for the encryption that the Reporting
browser will receive. Encrypted communications will fail if there are
If a reverse-proxy carries encrypted traffic from end-user
clients back to a {kib} server, the proxy port, protocol, and hostname
in Reporting settings must be valid for the encryption that the Reporting
browser will receive. Encrypted communications will fail if there are
mismatches in the host information between the request and the certificate on the server.
Configuring the `xpack.reporting.kibanaServer` settings to point to a
proxy host requires that the Kibana server has network access to the proxy.
proxy host requires that the {kib} server has network access to the proxy.
====
`xpack.reporting.kibanaServer.port`::
The port for accessing Kibana, if different from the `server.port` value.
[cols="2*<"]
|===
| `xpack.reporting.kibanaServer.port`
| The port for accessing {kib}, if different from the `server.port` value.
`xpack.reporting.kibanaServer.protocol`::
The protocol for accessing Kibana, typically `http` or `https`.
| `xpack.reporting.kibanaServer.protocol`
| The protocol for accessing {kib}, typically `http` or `https`.
`xpack.reporting.kibanaServer.hostname`::
The hostname for accessing {kib}, if different from the `server.host` value.
| `xpack.reporting.kibanaServer.hostname`
| The hostname for accessing {kib}, if different from the `server.host` value.
|===
[NOTE]
============
@ -68,55 +77,67 @@ because, in the Reporting browser, it becomes an automatic redirect to `"0.0.0.0
==== Background job settings
Reporting generates reports in the background and jobs are coordinated using documents
in Elasticsearch. Depending on how often you generate reports and the overall number of
in {es}. Depending on how often you generate reports and the overall number of
reports, you might need to change the following settings.
`xpack.reporting.queue.indexInterval`::
How often the index that stores reporting jobs rolls over to a new index.
Valid values are `year`, `month`, `week`, `day`, and `hour`. Defaults to `week`.
[cols="2*<"]
|===
| `xpack.reporting.queue.indexInterval`
| How often the index that stores reporting jobs rolls over to a new index.
Valid values are `year`, `month`, `week`, `day`, and `hour`. Defaults to `week`.
`xpack.reporting.queue.pollEnabled`::
Set to `true` (default) to enable the Kibana instance to to poll the index for
pending jobs and claim them for execution. Setting this to `false` allows the
Kibana instance to only add new jobs to the reporting queue, list jobs, and
provide the downloads to completed report through the UI.
| `xpack.reporting.queue.pollEnabled`
| Set to `true` (default) to enable the {kib} instance to to poll the index for
pending jobs and claim them for execution. Setting this to `false` allows the
{kib} instance to only add new jobs to the reporting queue, list jobs, and
provide the downloads to completed report through the UI.
|===
[NOTE]
============
Running multiple instances of Kibana in a cluster for load balancing of
Running multiple instances of {kib} in a cluster for load balancing of
reporting requires identical values for `xpack.reporting.encryptionKey` and, if
security is enabled, `xpack.security.encryptionKey`.
============
`xpack.reporting.queue.pollInterval`::
Specifies the number of milliseconds that the reporting poller waits between polling the
index for any pending Reporting jobs. Defaults to `3000` (3 seconds).
[cols="2*<"]
|===
| `xpack.reporting.queue.pollInterval`
| Specifies the number of milliseconds that the reporting poller waits between polling the
index for any pending Reporting jobs. Defaults to `3000` (3 seconds).
[[xpack-reporting-q-timeout]]`xpack.reporting.queue.timeout`::
How long each worker has to produce a report. If your machine is slow or under
heavy load, you might need to increase this timeout. Specified in milliseconds.
If a Reporting job execution time goes over this time limit, the job will be
marked as a failure and there will not be a download available.
Defaults to `120000` (two minutes).
| [[xpack-reporting-q-timeout]] `xpack.reporting.queue.timeout`
| How long each worker has to produce a report. If your machine is slow or under
heavy load, you might need to increase this timeout. Specified in milliseconds.
If a Reporting job execution time goes over this time limit, the job will be
marked as a failure and there will not be a download available.
Defaults to `120000` (two minutes).
|===
[float]
[[reporting-capture-settings]]
==== Capture settings
Reporting works by capturing screenshots from Kibana. The following settings
Reporting works by capturing screenshots from {kib}. The following settings
control the capturing process.
`xpack.reporting.capture.timeouts.openUrl`::
How long to allow the Reporting browser to wait for the initial data of the
Kibana page to load. Defaults to `30000` (30 seconds).
[cols="2*<"]
|===
| `xpack.reporting.capture.timeouts.openUrl`
| How long to allow the Reporting browser to wait for the initial data of the
{kib} page to load. Defaults to `30000` (30 seconds).
`xpack.reporting.capture.timeouts.waitForElements`::
How long to allow the Reporting browser to wait for the visualization panels to
load on the Kibana page. Defaults to `30000` (30 seconds).
| `xpack.reporting.capture.timeouts.waitForElements`
| How long to allow the Reporting browser to wait for the visualization panels to
load on the {kib} page. Defaults to `30000` (30 seconds).
`xpack.reporting.capture.timeouts.renderComplete`::
How long to allow the Reporting brwoser to wait for each visualization to
signal that it is done renderings. Defaults to `30000` (30 seconds).
| `xpack.reporting.capture.timeouts.renderComplete`
| How long to allow the Reporting browser to wait for each visualization to
signal that it is done renderings. Defaults to `30000` (30 seconds).
|===
[NOTE]
============
@ -126,20 +147,24 @@ capturing the page with a screenshot. As a result, a download will be
available, but there will likely be errors in the visualizations in the report.
============
`xpack.reporting.capture.maxAttempts`::
If capturing a report fails for any reason, Kibana will re-attempt othe reporting
job, as many times as this setting. Defaults to `3`.
[cols="2*<"]
|===
| `xpack.reporting.capture.maxAttempts`
| If capturing a report fails for any reason, {kib} will re-attempt other reporting
job, as many times as this setting. Defaults to `3`.
`xpack.reporting.capture.loadDelay`::
When visualizations are not evented, this is the amount of time before
taking a screenshot. All visualizations that ship with Kibana are evented, so this
setting should not have much effect. If you are seeing empty images instead of
visualizations, try increasing this value.
Defaults to `3000` (3 seconds).
| `xpack.reporting.capture.loadDelay`
| When visualizations are not evented, this is the amount of time before
taking a screenshot. All visualizations that ship with {kib} are evented, so this
setting should not have much effect. If you are seeing empty images instead of
visualizations, try increasing this value.
Defaults to `3000` (3 seconds).
[[xpack-reporting-browser]]`xpack.reporting.capture.browser.type`::
Specifies the browser to use to capture screenshots. This setting exists for
backward compatibility. The only valid option is `chromium`.
| [[xpack-reporting-browser]] `xpack.reporting.capture.browser.type`
| Specifies the browser to use to capture screenshots. This setting exists for
backward compatibility. The only valid option is `chromium`.
|===
[float]
[[reporting-chromium-settings]]
@ -147,47 +172,59 @@ backward compatibility. The only valid option is `chromium`.
When `xpack.reporting.capture.browser.type` is set to `chromium` (default) you can also specify the following settings.
`xpack.reporting.capture.browser.chromium.disableSandbox`::
Elastic recommends that you research the feasibility of enabling unprivileged user namespaces.
See Chromium Sandbox for additional information. Defaults to false for all operating systems except Debian,
Red Hat Linux, and CentOS which use true
[cols="2*<"]
|===
| `xpack.reporting.capture.browser.chromium.disableSandbox`
| It is recommended that you research the feasibility of enabling unprivileged user namespaces.
See Chromium Sandbox for additional information. Defaults to false for all operating systems except Debian,
Red Hat Linux, and CentOS which use true.
`xpack.reporting.capture.browser.chromium.proxy.enabled`::
Enables the proxy for Chromium to use. When set to `true`, you must also specify the
`xpack.reporting.capture.browser.chromium.proxy.server` setting.
Defaults to `false`
| `xpack.reporting.capture.browser.chromium.proxy.enabled`
| Enables the proxy for Chromium to use. When set to `true`, you must also specify the
`xpack.reporting.capture.browser.chromium.proxy.server` setting.
Defaults to `false`.
`xpack.reporting.capture.browser.chromium.proxy.server`::
The uri for the proxy server. Providing the username and password for the proxy server via the uri is not supported.
| `xpack.reporting.capture.browser.chromium.proxy.server`
| The uri for the proxy server. Providing the username and password for the proxy server via the uri is not supported.
`xpack.reporting.capture.browser.chromium.proxy.bypass`::
An array of hosts that should not go through the proxy server and should use a direct connection instead.
Examples of valid entries are "elastic.co", "*.elastic.co", ".elastic.co", ".elastic.co:5601"
| `xpack.reporting.capture.browser.chromium.proxy.bypass`
| An array of hosts that should not go through the proxy server and should use a direct connection instead.
Examples of valid entries are "elastic.co", "*.elastic.co", ".elastic.co", ".elastic.co:5601".
|===
[float]
[[reporting-csv-settings]]
==== CSV settings
[[xpack-reporting-csv]]`xpack.reporting.csv.maxSizeBytes`::
The maximum size of a CSV file before being truncated. This setting exists to prevent
large exports from causing performance and storage issues.
Defaults to `10485760` (10mB)
[cols="2*<"]
|===
| [[xpack-reporting-csv]] `xpack.reporting.csv.maxSizeBytes`
| The maximum size of a CSV file before being truncated. This setting exists to prevent
large exports from causing performance and storage issues.
Defaults to `10485760` (10mB).
|===
[float]
[[reporting-advanced-settings]]
==== Advanced settings
`xpack.reporting.index`::
Reporting uses a weekly index in Elasticsearch to store the reporting job and
the report content. The index is automatically created if it does not already
exist. Configure this to a unique value, beginning with `.reporting-`, for every
Kibana instance that has a unique `kibana.index` setting. Defaults to `.reporting`
[cols="2*<"]
|===
| `xpack.reporting.index`
| Reporting uses a weekly index in {es} to store the reporting job and
the report content. The index is automatically created if it does not already
exist. Configure this to a unique value, beginning with `.reporting-`, for every
{kib} instance that has a unique `kibana.index` setting. Defaults to `.reporting`.
`xpack.reporting.roles.allow`::
Specifies the roles in addition to superusers that can use reporting.
Defaults to `[ "reporting_user" ]`
+
--
NOTE: Each user has access to only their own reports.
| `xpack.reporting.roles.allow`
| Specifies the roles in addition to superusers that can use reporting.
Defaults to `[ "reporting_user" ]`. +
--
|===
[NOTE]
============
Each user has access to only their own reports.
============

108
docs/settings/security-settings.asciidoc
View file

@ -12,55 +12,83 @@ You do not need to configure any additional settings to use the
[[general-security-settings]]
==== General security settings
`xpack.security.enabled`::
By default, {kib} automatically detects whether to enable the
{security-features} based on the license and whether {es} {security-features}
are enabled.
+
Do not set this to `false`; it disables the login form, user and role management
screens, and authorization using <<kibana-privileges>>. To disable
{security-features} entirely, see
{ref}/security-settings.html[{es} security settings].
[cols="2*<"]
|===
| `xpack.security.enabled`
| By default, {kib} automatically detects whether to enable the
{security-features} based on the license and whether {es} {security-features}
are enabled. +
+
Do not set this to `false`; it disables the login form, user and role management
screens, and authorization using <<kibana-privileges>>. To disable
{security-features} entirely, see
{ref}/security-settings.html[{es} security settings].
`xpack.security.audit.enabled`::
Set to `true` to enable audit logging for security events. By default, it is set
to `false`. For more details see <<xpack-security-audit-logging>>.
| `xpack.security.audit.enabled`
| Set to `true` to enable audit logging for security events. By default, it is set
to `false`. For more details see <<xpack-security-audit-logging>>.
|===
[float]
[[security-ui-settings]]
==== User interface security settings
You can configure the following settings in the `kibana.yml` file:
You can configure the following settings in the `kibana.yml` file.
`xpack.security.cookieName`::
Sets the name of the cookie used for the session. The default value is `"sid"`.
[cols="2*<"]
|===
| `xpack.security.cookieName`
| Sets the name of the cookie used for the session. The default value is `"sid"`.
`xpack.security.encryptionKey`::
An arbitrary string of 32 characters or more that is used to encrypt credentials
in a cookie. It is crucial that this key is not exposed to users of {kib}. By
default, a value is automatically generated in memory. If you use that default
behavior, all sessions are invalidated when {kib} restarts.
In addition, high-availability deployments of {kib} will behave unexpectedly
if this setting isn't the same for all instances of {kib}.
| `xpack.security.encryptionKey`
| An arbitrary string of 32 characters or more that is used to encrypt credentials
in a cookie. It is crucial that this key is not exposed to users of {kib}. By
default, a value is automatically generated in memory. If you use that default
behavior, all sessions are invalidated when {kib} restarts.
In addition, high-availability deployments of {kib} will behave unexpectedly
if this setting isn't the same for all instances of {kib}.
`xpack.security.secureCookies`::
Sets the `secure` flag of the session cookie. The default value is `false`. It
is automatically set to `true` if `server.ssl.enabled` is set to `true`. Set
this to `true` if SSL is configured outside of {kib} (for example, you are
routing requests through a load balancer or proxy).
| `xpack.security.secureCookies`
| Sets the `secure` flag of the session cookie. The default value is `false`. It
is automatically set to `true` if `server.ssl.enabled` is set to `true`. Set
this to `true` if SSL is configured outside of {kib} (for example, you are
routing requests through a load balancer or proxy).
`xpack.security.session.idleTimeout`::
Sets the session duration. The format is a string of `<count>[ms|s|m|h|d|w|M|Y]`
(e.g. '70ms', '5s', '3d', '1Y'). By default, sessions stay active until the
browser is closed. When this is set to an explicit idle timeout, closing the
browser still requires the user to log back in to {kib}.
| `xpack.security.session.idleTimeout`
| Sets the session duration. By default, sessions stay active until the
browser is closed. When this is set to an explicit idle timeout, closing the
browser still requires the user to log back in to {kib}.
`xpack.security.session.lifespan`::
Sets the maximum duration, also known as "absolute timeout". The format is a
string of `<count>[ms|s|m|h|d|w|M|Y]` (e.g. '70ms', '5s', '3d', '1Y'). By default,
a session can be renewed indefinitely. When this value is set, a session will end
once its lifespan is exceeded, even if the user is not idle. NOTE: if `idleTimeout`
is not set, this setting will still cause sessions to expire.
|===
`xpack.security.loginAssistanceMessage`::
Adds a message to the login screen. Useful for displaying information about maintenance windows, links to corporate sign up pages etc.
[TIP]
============
The format is a string of `<count>[ms|s|m|h|d|w|M|Y]`
(e.g. '70ms', '5s', '3d', '1Y').
============
[cols="2*<"]
|===
| `xpack.security.session.lifespan`
| Sets the maximum duration, also known as "absolute timeout". By default,
a session can be renewed indefinitely. When this value is set, a session will end
once its lifespan is exceeded, even if the user is not idle. NOTE: if `idleTimeout`
is not set, this setting will still cause sessions to expire.
|===
[TIP]
============
The format is a
string of `<count>[ms|s|m|h|d|w|M|Y]` (e.g. '70ms', '5s', '3d', '1Y').
============
[cols="2*<"]
|===
| `xpack.security.loginAssistanceMessage`
| Adds a message to the login screen. Useful for displaying information about maintenance windows, links to corporate sign up pages etc.
|===

20
docs/settings/spaces-settings.asciidoc
View file

@ -5,18 +5,22 @@
<titleabbrev>Spaces settings</titleabbrev>
++++
By default, Spaces is enabled in Kibana, and you can secure Spaces using
By default, Spaces is enabled in Kibana, and you can secure Spaces using
roles when Security is enabled.
[float]
[[spaces-settings]]
==== Spaces settings
`xpack.spaces.enabled`::
Set to `true` (default) to enable Spaces in {kib}.
[cols="2*<"]
|===
| `xpack.spaces.enabled`
| Set to `true` (default) to enable Spaces in {kib}.
`xpack.spaces.maxSpaces`::
The maximum amount of Spaces that can be used with this instance of Kibana. Some operations
in Kibana return all spaces using a single `_search` from Elasticsearch, so this must be
set lower than the `index.max_result_window` in Elasticsearch.
Defaults to `1000`.
| `xpack.spaces.maxSpaces`
| The maximum amount of Spaces that can be used with this instance of {kib}. Some operations
in {kib} return all spaces using a single `_search` from {es}, so this must be
set lower than the `index.max_result_window` in {es}.
Defaults to `1000`.
|===

46
docs/settings/telemetry-settings.asciidoc Normal file
View file

@ -0,0 +1,46 @@
[[telemetry-settings-kbn]]
=== Telemetry settings in Kibana
++++
<titleabbrev>Telemetry settings</titleabbrev>
++++
By default, Usage Collection (also known as Telemetry) is enabled. This
helps us learn about the {kib} features that our users are most interested in, so we
can focus our efforts on making them even better.
You can control whether this data is sent from the {kib} servers, or if it should be sent
from the user's browser, in case a firewall is blocking the connections from the server. Additionally, you can decide to completely disable this feature either in the config file or in {kib} via *Management > Kibana > Advanced Settings > Usage Data*.
See our https://www.elastic.co/legal/privacy-statement[Privacy Statement] to learn more.
[float]
[[telemetry-general-settings]]
==== General telemetry settings
[cols="2*<"]
|===
| `telemetry.enabled`
| Set to `true` to send cluster statistics to Elastic. Reporting your
cluster statistics helps us improve your user experience. Your data is never
shared with anyone. Set to `false` to disable statistics reporting from any
browser connected to the {kib} instance. Defaults to `true`.
| `telemetry.sendUsageFrom`
| Set to `'server'` to report the cluster statistics from the {kib} server.
If the server fails to connect to our endpoint at https://telemetry.elastic.co/, it assumes
it is behind a firewall and falls back to `'browser'` to send it from users' browsers
when they are navigating through {kib}. Defaults to 'browser'.
| `telemetry.optIn`
| Set to `true` to automatically opt into reporting cluster statistics. You can also opt out through
*Advanced Settings* in {kib}. Defaults to `true`.
| `telemetry.allowChangingOptInStatus`
| Set to `true` to allow overwriting the `telemetry.optIn` setting via the {kib} UI. Defaults to `true`. +
|===
[NOTE]
============
When `false`, `telemetry.optIn` must be `true`. To disable telemetry and not allow users to change that parameter, use `telemetry.enabled`.
============

715
docs/setup/settings.asciidoc
View file

@ -11,449 +11,622 @@ The default host and port settings configure {kib} to run on `localhost:5601`. T
variety of other options. Finally, environment variables can be injected into
configuration using `${MY_ENV_VAR}` syntax.
.Kibana configuration settings
[cols="2*<"]
|===
`console.enabled:`:: *Default: true* Set to false to disable Console. Toggling
this will cause the server to regenerate assets on the next startup, which may
cause a delay before pages start being served.
| `console.enabled:`
| Toggling this causes the server to regenerate assets on the next startup,
which may cause a delay before pages start being served.
Set to `false` to disable Console. *Default: `true`*
`cpu.cgroup.path.override:`:: Override for cgroup cpu path when mounted in a
manner that is inconsistent with `/proc/self/cgroup`
| `cpu.cgroup.path.override:`
| Override for cgroup cpu path when mounted in a
manner that is inconsistent with `/proc/self/cgroup`.
`cpuacct.cgroup.path.override:`:: Override for cgroup cpuacct path when mounted
in a manner that is inconsistent with `/proc/self/cgroup`
| `cpuacct.cgroup.path.override:`
| Override for cgroup cpuacct path when mounted
in a manner that is inconsistent with `/proc/self/cgroup`.
`csp.rules:`:: A template
https://w3c.github.io/webappsec-csp/[content-security-policy] that disables
certain unnecessary and potentially insecure capabilities in the browser. We
strongly recommend that you keep the default CSP rules that ship with {kib}.
| `csp.rules:`
| A https://w3c.github.io/webappsec-csp/[content-security-policy] template
that disables certain unnecessary and potentially insecure capabilities in
the browser. It is strongly recommended that you keep the default CSP rules
that ship with {kib}.
`csp.strict:`:: *Default: `false`* Blocks access to {kib} to any browser that
does not enforce even rudimentary CSP rules. In practice, this will disable
| `csp.strict:`
| Blocks {kib} access to any browser that
does not enforce even rudimentary CSP rules. In practice, this disables
support for older, less safe browsers like Internet Explorer.
See <<csp-strict-mode, Content Security Policy>> for more information.
For more information, refer to <<csp-strict-mode, Content Security Policy>>.
*Default: `true`*
`csp.warnLegacyBrowsers:`:: *Default: `true`* Shows a warning message after
loading {kib} to any browser that does not enforce even rudimentary CSP rules,
though {kib} is still accessible. This configuration is effectively ignored
when `csp.strict` is enabled.
| `csp.warnLegacyBrowsers:`
| Shows a warning message after loading {kib} to any browser that does not
enforce even rudimentary CSP rules, though {kib} is still accessible. This
configuration is effectively ignored when `csp.strict` is enabled.
*Default: `true`*
`elasticsearch.customHeaders:`:: *Default: `{}`* Header names and values to send
to Elasticsearch. Any custom headers cannot be overwritten by client-side
headers, regardless of the `elasticsearch.requestHeadersWhitelist` configuration.
| `elasticsearch.customHeaders:`
| Header names and values to send to {es}. Any custom headers cannot be
overwritten by client-side headers, regardless of the
`elasticsearch.requestHeadersWhitelist` configuration. *Default: `{}`*
`elasticsearch.hosts:`:: *Default: `[ "http://localhost:9200" ]`* The URLs of the {es} instances to use for all your queries. All nodes
listed here must be on the same cluster.
| `elasticsearch.hosts:`
| The URLs of the {es} instances to use for all your queries. All nodes
listed here must be on the same cluster. *Default: `[ "http://localhost:9200" ]`*
+
To enable SSL/TLS for outbound connections to {es}, use the `https` protocol in this setting.
To enable SSL/TLS for outbound connections to {es}, use the `https` protocol
in this setting.
`elasticsearch.logQueries:`:: *Default: `false`* Logs queries sent to
Elasticsearch. Requires `logging.verbose` set to `true`. This is useful for
seeing the query DSL generated by applications that currently do not have an
inspector, for example Timelion and Monitoring.
| `elasticsearch.logQueries:`
| Log queries sent to {es}. Requires `logging.verbose` set to `true`.
This is useful for seeing the query DSL generated by applications that
currently do not have an inspector, for example Timelion and Monitoring.
*Default: `false`*
`elasticsearch.pingTimeout:`::
*Default: the value of the `elasticsearch.requestTimeout` setting* Time in
milliseconds to wait for {es} to respond to pings.
| `elasticsearch.pingTimeout:`
| Time in milliseconds to wait for {es} to respond to pings.
*Default: the value of the `elasticsearch.requestTimeout` setting*
`elasticsearch.preserveHost:`:: *Default: true* When this setting’s value is
true, {kib} uses the hostname specified in the `server.host` setting. When the
value of this setting is `false`, {kib} uses the hostname of the host that
connects to this {kib} instance.
| `elasticsearch.preserveHost:`
| When the value is `true`, {kib} uses the hostname specified in the
`server.host` setting. When the value is `false`, {kib} uses
the hostname of the host that connects to this {kib} instance. *Default: `true`*
`elasticsearch.requestHeadersWhitelist:`:: *Default: `[ 'authorization' ]`* List
of {kib} client-side headers to send to {es}. To send *no* client-side
headers, set this value to [] (an empty list).
Removing the `authorization` header from being whitelisted means that you cannot
use <<basic-authentication, basic authentication>> in {kib}.
| `elasticsearch.requestHeadersWhitelist:`
| List of {kib} client-side headers to send to {es}. To send *no* client-side
headers, set this value to [] (an empty list). Removing the `authorization`
header from being whitelisted means that you cannot use
<<basic-authentication, basic authentication>> in {kib}.
*Default: `[ 'authorization' ]`*
`elasticsearch.requestTimeout:`:: *Default: 30000* Time in milliseconds to wait
for responses from the back end or {es}. This value must be a positive
integer.
| `elasticsearch.requestTimeout:`
| Time in milliseconds to wait for responses from the back end or {es}.
This value must be a positive integer. *Default: `30000`*
`elasticsearch.shardTimeout:`:: *Default: 30000* Time in milliseconds for
{es} to wait for responses from shards. Set to 0 to disable.
| `elasticsearch.shardTimeout:`
| Time in milliseconds for {es} to wait for responses from shards.
Set to 0 to disable. *Default: `30000`*
`elasticsearch.sniffInterval:`:: *Default: false* Time in milliseconds between
requests to check {es} for an updated list of nodes.
| `elasticsearch.sniffInterval:`
| Time in milliseconds between requests to check {es} for an updated list of
nodes. *Default: `false`*
`elasticsearch.sniffOnConnectionFault:`:: *Default: false* Update the list of
{es} nodes immediately following a connection fault.
| `elasticsearch.sniffOnStart:`
| Attempt to find other {es} nodes on startup. *Default: `false`*
`elasticsearch.sniffOnStart:`:: *Default: false* Attempt to find other
{es} nodes on startup.
| `elasticsearch.sniffOnConnectionFault:`
| Update the list of {es} nodes immediately following a connection fault.
*Default: `false`*
`elasticsearch.ssl.alwaysPresentCertificate:`:: *Default: false* Controls {kib}'s behavior in regard to presenting a client certificate when
requested by {es}. This setting applies to all outbound SSL/TLS connections to {es}, including requests that are proxied for end users.
| `elasticsearch.ssl.alwaysPresentCertificate:`
| Controls {kib} behavior in regard to presenting a client certificate when
requested by {es}. This setting applies to all outbound SSL/TLS connections
to {es}, including requests that are proxied for end users. *Default: `false`*
|===
[WARNING]
============
When {es} uses certificates to authenticate end users with a PKI realm
and `elasticsearch.ssl.alwaysPresentCertificate` is `true`,
proxied requests may be executed as the identity that is tied to the {kib}
server.
============
[cols="2*<"]
|===
| `elasticsearch.ssl.certificate:` and `elasticsearch.ssl.key:`
| Paths to a PEM-encoded X.509 client certificate and its corresponding
private key. These are used by {kib} to authenticate itself when making
outbound SSL/TLS connections to {es}. For this setting to take effect, the
`xpack.security.http.ssl.client_authentication` setting in {es} must be also
be set to `"required"` or `"optional"` to request a client certificate from
{kib}.
|===
[NOTE]
============
These settings cannot be used in conjunction with `elasticsearch.ssl.keystore.path`.
============
[cols="2*<"]
|===
| `elasticsearch.ssl.certificateAuthorities:`
| Paths to one or more PEM-encoded X.509 certificate authority (CA)
certificates, which make up a trusted certificate chain for {es}. This chain is
used by {kib} to establish trust when making outbound SSL/TLS connections to
{es}.
+
WARNING: If {es} uses certificates to authenticate end users with a PKI realm and `elasticsearch.ssl.alwaysPresentCertificate` is `true`,
proxied requests may be executed as the identity that is tied to the {kib} server.
In addition to this setting, trusted certificates may be specified via
`elasticsearch.ssl.keystore.path` and/or `elasticsearch.ssl.truststore.path`.
`elasticsearch.ssl.certificate:` and `elasticsearch.ssl.key:`:: Paths to a PEM-encoded X.509 client certificate and its corresponding
private key. These are used by {kib} to authenticate itself when making outbound SSL/TLS connections to {es}. For this setting to take
effect, the `xpack.security.http.ssl.client_authentication` setting in {es} must be also be set to `"required"` or `"optional"` to request a
client certificate from {kib}.
+
NOTE: These settings cannot be used in conjunction with `elasticsearch.ssl.keystore.path`.
| `elasticsearch.ssl.keyPassphrase:`
| The password that decrypts the private key that is specified
via `elasticsearch.ssl.key`. This value is optional, as the key may not be
encrypted.
`elasticsearch.ssl.certificateAuthorities:`:: Paths to one or more PEM-encoded X.509 certificate authority (CA) certificates which make up a
trusted certificate chain for {es}. This chain is used by {kib} to establish trust when making outbound SSL/TLS connections to {es}.
| `elasticsearch.ssl.keystore.path:`
| Path to a PKCS#12 keystore that contains an X.509 client certificate and it's
corresponding private key. These are used by {kib} to authenticate itself when
making outbound SSL/TLS connections to {es}. For this setting, you must also set
the `xpack.security.http.ssl.client_authentication` setting in {es} to
`"required"` or `"optional"` to request a client certificate from {kib}.
+
In addition to this setting, trusted certificates may be specified via `elasticsearch.ssl.keystore.path` and/or
If the keystore contains any additional certificates, they are used as a
trusted certificate chain for {es}. This chain is used by {kib} to establish
trust when making outbound SSL/TLS connections to {es}. In addition to this
setting, trusted certificates may be specified via
`elasticsearch.ssl.certificateAuthorities` and/or
`elasticsearch.ssl.truststore.path`.
`elasticsearch.ssl.keyPassphrase:`:: The password that will be used to decrypt the private key that is specified via
`elasticsearch.ssl.key`. This value is optional, as the key may not be encrypted.
|===
`elasticsearch.ssl.keystore.path:`:: Path to a PKCS#12 keystore that contains an X.509 client certificate and its corresponding private key.
These are used by {kib} to authenticate itself when making outbound SSL/TLS connections to {es}. For this setting to take effect, the
`xpack.security.http.ssl.client_authentication` setting in {es} must also be set to `"required"` or `"optional"` to request a client
certificate from {kib}.
+
--
If the keystore contains any additional certificates, those will be used as a trusted certificate chain for {es}. This chain is used by
{kib} to establish trust when making outbound SSL/TLS connections to {es}. In addition to this setting, trusted certificates may be
specified via `elasticsearch.ssl.certificateAuthorities` and/or `elasticsearch.ssl.truststore.path`.
[NOTE]
============
This setting cannot be used in conjunction with
`elasticsearch.ssl.certificate` or `elasticsearch.ssl.key`.
============
NOTE: This setting cannot be used in conjunction with `elasticsearch.ssl.certificate` or `elasticsearch.ssl.key`.
--
[cols="2*<"]
|===
`elasticsearch.ssl.keystore.password:`:: The password that will be used to decrypt the keystore that is specified via
`elasticsearch.ssl.keystore.path`. If the keystore has no password, leave this unset. If the keystore has an empty password, set this to
| `elasticsearch.ssl.keystore.password:`
| The password that decrypts the keystore specified via
`elasticsearch.ssl.keystore.path`. If the keystore has no password, leave this
as blank. If the keystore has an empty password, set this to
`""`.
`elasticsearch.ssl.truststore.path:`:: Path to a PKCS#12 trust store that contains one or more X.509 certificate authority (CA) certificates
which make up a trusted certificate chain for {es}. This chain is used by {kib} to establish trust when making outbound SSL/TLS connections
to {es}.
| `elasticsearch.ssl.truststore.path:`::
| Path to a PKCS#12 trust store that contains one or more X.509 certificate
authority (CA) certificates, which make up a trusted certificate chain for
{es}. This chain is used by {kib} to establish trust when making outbound
SSL/TLS connections to {es}.
+
In addition to this setting, trusted certificates may be specified via `elasticsearch.ssl.certificateAuthorities` and/or
In addition to this setting, trusted certificates may be specified via
`elasticsearch.ssl.certificateAuthorities` and/or
`elasticsearch.ssl.keystore.path`.
`elasticsearch.ssl.truststore.password:`:: The password that will be used to decrypt the trust store specified via
`elasticsearch.ssl.truststore.path`. If the trust store has no password, leave this unset. If the trust store has an empty password, set
this to `""`.
|`elasticsearch.ssl.truststore.password:`
| The password that decrypts the trust store specified via
`elasticsearch.ssl.truststore.path`. If the trust store has no password,
leave this as blank. If the trust store has an empty password, set this to `""`.
`elasticsearch.ssl.verificationMode:`:: *Default: `"full"`* Controls the verification of the server certificate that {kib} receives when
making an outbound SSL/TLS connection to {es}. Valid values are `"full"`, `"certificate"`, and `"none"`. Using `"full"` will perform
hostname verification, using `"certificate"` will skip hostname verification, and using `"none"` will skip verification entirely.
| `elasticsearch.ssl.verificationMode:`
| Controls the verification of the server certificate that {kib} receives when
making an outbound SSL/TLS connection to {es}. Valid values are `"full"`,
`"certificate"`, and `"none"`. Using `"full"` performs hostname verification,
using `"certificate"` skips hostname verification, and using `"none"` skips
verification entirely. *Default: `"full"`*
`elasticsearch.startupTimeout:`:: *Default: 5000* Time in milliseconds to wait
for {es} at {kib} startup before retrying.
| `elasticsearch.startupTimeout:`
| Time in milliseconds to wait for {es} at {kib} startup before retrying.
*Default: `5000`*
`elasticsearch.username:` and `elasticsearch.password:`:: When {es}
is protected with basic authentication, these settings provide the username and
password that the {kib} server uses to perform maintenance on the {kib} index
at startup. Your {kib} users still need to authenticate with {es},
which is proxied through the {kib} server.
| `elasticsearch.username:` and `elasticsearch.password:`
| If your {es} is protected with basic authentication, these settings provide
the username and password that the {kib} server uses to perform maintenance
on the {kib} index at startup. {kib} users still need to authenticate with
{es}, which is proxied through the {kib} server.
`interpreter.enableInVisualize`:: *Default: true* Enables use of interpreter in
Visualize.
| `interpreter.enableInVisualize`
| Enables use of interpreter in Visualize. *Default: `true`*
`kibana.defaultAppId:`:: *Default: "home"* The default application to load.
| `kibana.defaultAppId:`
| The default application to load. *Default: `"home"`*
`kibana.index:`:: *Default: ".kibana"* {kib} uses an index in {es} to
store saved searches, visualizations, and dashboards. {kib} creates a new index
if the index doesn’t already exist. If you configure a custom index, the name must
be lowercase, and conform to {es} {ref}/indices-create-index.html[index name limitations].
+
When running multiple tenants of {kib} by changing the `kibana.index` in your `kibana.yml`,
you cannot use the `kibana_user` or `kibana_dashboard_only_user` roles
to grant access to {kib}.
You must create custom roles that authorize the user for that specific tenant.
Although multi-tenant installations are supported, the recommended approach
to securing access to {kib} segments is to grant users access to specific spaces.
| `kibana.index:`
| {kib} uses an index in {es} to store saved searches, visualizations, and
dashboards. {kib} creates a new index if the index doesn’t already exist.
If you configure a custom index, the name must be lowercase, and conform to the
{es} {ref}/indices-create-index.html[index name limitations].
*Default: `".kibana"`*
`kibana.autocompleteTimeout:`:: *Default: "1000"* Time in milliseconds to wait
for autocomplete suggestions from {es}. This value must be a whole number
greater than zero.
| `kibana.autocompleteTimeout:`
| Time in milliseconds to wait for autocomplete suggestions from {es}.
This value must be a whole number greater than zero. *Default: `"1000"`*
`kibana.autocompleteTerminateAfter:`:: *Default: "100000"* Maximum number of
documents loaded by each shard to generate autocomplete suggestions. This value
must be a whole number greater than zero.
| `kibana.autocompleteTerminateAfter:`
| Maximum number of documents loaded by each shard to generate autocomplete
suggestions. This value must be a whole number greater than zero.
*Default: `"100000"`*
`logging.dest:`:: *Default: `stdout`* Enables you specify a file where {kib}
stores log output.
| `logging.dest:`
| Enables you to specify a file where {kib} stores log output.
*Default: `stdout`*
`logging.json:`:: *Default: false* Logs output as JSON. When set to `true`, the
logs will be formatted as JSON strings that include timestamp, log level, context, message
text and any other metadata that may be associated with the log message itself.
If `logging.dest.stdout` is set and there is no interactive terminal ("TTY"), this setting
will default to `true`.
| `logging.json:`
| Logs output as JSON. When set to `true`, the logs are formatted as JSON
strings that include timestamp, log level, context, message text, and any other
metadata that may be associated with the log message.
When `logging.dest.stdout` is set, and there is no interactive terminal ("TTY"),
this setting defaults to `true`. *Default: `false`*
`logging.quiet:`:: *Default: false* Set the value of this setting to `true` to
suppress all logging output other than error messages.
| `logging.quiet:`
| Set the value of this setting to `true` to suppress all logging output other
than error messages. *Default: `false`*
`logging.rotate:`:: [experimental] Specifies the options for the logging rotate feature.
| `logging.rotate:`
| experimental[] Specifies the options for the logging rotate feature.
When not defined, all the sub options defaults would be applied.
The following example shows a valid logging rotate configuration:
+
|===
[source,text]
--
logging.rotate:
enabled: true
everyBytes: 10485760
keepFiles: 10
logging.rotate:
enabled: true
everyBytes: 10485760
keepFiles: 10
--
`logging.rotate.enabled:`:: [experimental] *Default: false* Set the value of this setting to `true` to
[cols="2*<"]
|===
| `logging.rotate.enabled:`
| experimental[] Set the value of this setting to `true` to
enable log rotation. If you do not have a `logging.dest` set that is different from `stdout`
that feature would not take any effect.
that feature would not take any effect. *Default: `false`*
`logging.rotate.everyBytes:`:: [experimental] *Default: 10485760* The maximum size of a log file (that is `not an exact` limit). After the
| `logging.rotate.everyBytes:`
| experimental[] The maximum size of a log file (that is `not an exact` limit). After the
limit is reached, a new log file is generated. The default size limit is 10485760 (10 MB) and
this option should be in the range of 1048576 (1 MB) to 1073741824 (1 GB).
this option should be in the range of 1048576 (1 MB) to 1073741824 (1 GB). *Default: `10485760`*
`logging.rotate.keepFiles:`:: [experimental] *Default: 7* The number of most recent rotated log files to keep
| `logging.rotate.keepFiles:`
| experimental[] The number of most recent rotated log files to keep
on disk. Older files are deleted during log rotation. The default value is 7. The `logging.rotate.keepFiles`
option has to be in the range of 2 to 1024 files.
option has to be in the range of 2 to 1024 files. *Default: `7`*
`logging.rotate.pollingInterval:`:: [experimental] *Default: 10000* The number of milliseconds for the polling strategy in case
the `logging.rotate.usePolling` is enabled. That option has to be in the range of 5000 to 3600000 milliseconds.
| `logging.rotate.pollingInterval:`
| experimental[] The number of milliseconds for the polling strategy in case
the `logging.rotate.usePolling` is enabled. `logging.rotate.usePolling` must be in the 5000 to 3600000 millisecond range. *Default: `10000`*
`logging.rotate.usePolling:`:: [experimental] *Default: false* By default we try to understand the best way to monitoring
| `logging.rotate.usePolling:`
| experimental[] By default we try to understand the best way to monitoring
the log file and warning about it. Please be aware there are some systems where watch api is not accurate. In those cases, in order to get the feature working,
the `polling` method could be used enabling that option.
the `polling` method could be used enabling that option. *Default: `false`*
`logging.silent:`:: *Default: false* Set the value of this setting to `true` to
suppress all logging output.
| `logging.silent:`
| Set the value of this setting to `true` to
suppress all logging output. *Default: `false`*
`logging.timezone`:: *Default: UTC* Set to the canonical timezone id
(for example, `America/Los_Angeles`) to log events using that timezone. A list of timezones can
be referenced at https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.
| `logging.timezone`
| Set to the canonical timezone ID
(for example, `America/Los_Angeles`) to log events using that timezone. For a
list of timezones, refer to https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. *Default: `UTC`*
[[logging-verbose]]`logging.verbose:`:: *Default: false* Set the value of this
setting to `true` to log all events, including system usage information and all
requests. Supported on {ece}.
| [[logging-verbose]] `logging.verbose:`
| Set to `true` to log all events, including system usage information and all
requests. Supported on {ece}. *Default: `false`*
`map.includeElasticMapsService:`:: *Default: true*
To disable connections to Elastic Maps Service, set to `false`.
When `includeElasticMapsService` is turned off, only the vector layers configured by `map.regionmap`,
and the tile layer configured by `map.tilemap.url`, are available in the <<maps,Maps application>>.
| `map.includeElasticMapsService:`
| Set to `false` to disable connections to Elastic Maps Service.
When `includeElasticMapsService` is turned off, only the vector layers configured by `map.regionmap`
and the tile layer configured by `map.tilemap.url` are available in <<maps, Maps>>. *Default: `true`*
`map.proxyElasticMapsServiceInMaps:`:: *Default: false*
Set to true to proxy all <<maps,Maps application>> Elastic Maps Service requests through the {kib} server.
| `map.proxyElasticMapsServiceInMaps:`
| Set to `true` to proxy all <<maps, Maps application>> Elastic Maps Service
requests through the {kib} server. *Default: `false`*
[[regionmap-settings]] `map.regionmap:`:: Specifies additional vector layers for
| [[regionmap-settings]] `map.regionmap:`
| Specifies additional vector layers for
use in <<maps, Maps>> visualizations. Supported on {ece}. Each layer
object points to an external vector file that contains a geojson
FeatureCollection. The file must use the
https://en.wikipedia.org/wiki/World_Geodetic_System[WGS84 coordinate reference system (ESPG:4326)]
and only include polygons. If the file is hosted on a separate domain from
Kibana, the server needs to be CORS-enabled so Kibana can download the file.
[[region-map-configuration-example]]
{kib}, the server needs to be CORS-enabled so {kib} can download the file.
The following example shows a valid region map configuration.
+
|===
[source,text]
--
map
includeElasticMapsService: false
regionmap:
layers:
- name: "Departments of France"
url: "http://my.cors.enabled.server.org/france_departements.geojson"
attribution: "INRAP"
fields:
- name: "department"
description: "Full department name"
- name: "INSEE"
description: "INSEE numeric identifier"
map.regionmap:
includeElasticMapsService: false
layers:
- name: "Departments of France"
url: "http://my.cors.enabled.server.org/france_departements.geojson"
attribution: "INRAP"
fields:
- name: "department"
description: "Full department name"
- name: "INSEE"
description: "INSEE numeric identifier"
--
[[regionmap-ES-map]]`map.includeElasticMapsService:`:: Specifies
the option to include layers from the Elastic Maps Service in the vector
layer option list. Supported on {ece}. When off, only the configured layers are included.
The default is `true`. This option also specifies if the tile-service from the Elastic Maps Service is available.
[cols="2*<"]
|===
[[regionmap-attribution]]`map.regionmap.layers[].attribution:`:: Optional.
References the originating source of the geojson file. Supported on {ece}.
| [[regionmap-ES-map]] `map.includeElasticMapsService:`
| Turns on or off whether layers from the Elastic Maps Service should be included in the vector
layer option list. Supported on {ece}. By turning this off,
only the layers that are configured here will be included. The default is `true`.
This also affects whether tile-service from the Elastic Maps Service will be available.
[[regionmap-fields]]`map.regionmap.layers[].fields[]:`:: Mandatory. Each layer
| [[regionmap-attribution]] `map.regionmap.layers[].attribution:`
| Optional. References the originating source of the geojson file.
Supported on {ece}.
| [[regionmap-fields]] `map.regionmap.layers[].fields[]:`
| Mandatory. Each layer
can contain multiple fields to indicate what properties from the geojson
features you wish to expose. This <<region-map-configuration-example,region map example>> shows how to define multiple
properties. Supported on {ece}.
features you wish to expose. Supported on {ece}. The following shows how to define multiple
properties:
[[regionmap-field-description]]`map.regionmap.layers[].fields[].description:`::
Mandatory. The human readable text that is shown under the Options tab when
|===
[source,text]
--
map.regionmap:
includeElasticMapsService: false
layers:
- name: "Departments of France"
url: "http://my.cors.enabled.server.org/france_departements.geojson"
attribution: "INRAP"
fields:
- name: "department"
description: "Full department name"
- name: "INSEE"
description: "INSEE numeric identifier"
--
[cols="2*<"]
|===
| [[regionmap-field-description]] `map.regionmap.layers[].fields[].description:`
| Mandatory. The human readable text that is shown under the Options tab when
building the Region Map visualization. Supported on {ece}.
[[regionmap-field-name]]`map.regionmap.layers[].fields[].name:`:: Mandatory.
| [[regionmap-field-name]] `map.regionmap.layers[].fields[].name:`
| Mandatory.
This value is used to do an inner-join between the document stored in
{es} and the geojson file. For example, if the field in the geojson is
called `Location` and has city names, there must be a field in {es}
that holds the same values that {kib} can then use to lookup for the geoshape
data. Supported on {ece}.
[[regionmap-name]]`map.regionmap.layers[].name:`:: Mandatory. A description of
| [[regionmap-name]] `map.regionmap.layers[].name:`
| Mandatory. A description of
the map being provided. Supported on {ece}.
[[regionmap-url]]`map.regionmap.layers[].url:`:: Mandatory. The location of the
| [[regionmap-url]] `map.regionmap.layers[].url:`
| Mandatory. The location of the
geojson file as provided by a webserver. Supported on {ece}.
[[tilemap-settings]] `map.tilemap.options.attribution:`::
| [[tilemap-settings]] `map.tilemap.options.attribution:`
| The map attribution string. Supported on {ece}.
*Default: `"© [Elastic Maps Service](https://www.elastic.co/elastic-maps-service)"`*
The map attribution string. Supported on {ece}.
[[tilemap-max-zoom]]`map.tilemap.options.maxZoom:`:: *Default: 10* The maximum
zoom level. Supported on {ece}.
| [[tilemap-max-zoom]] `map.tilemap.options.maxZoom:`
| The maximum zoom level. Supported on {ece}. *Default: `10`*
[[tilemap-min-zoom]]`map.tilemap.options.minZoom:`:: *Default: 1* The minimum
zoom level. Supported on {ece}.
| [[tilemap-min-zoom]] `map.tilemap.options.minZoom:`
| The minimum zoom level. Supported on {ece}. *Default: `1`*
[[tilemap-subdomains]]`map.tilemap.options.subdomains:`:: An array of subdomains
used by the tile service. Specify the position of the subdomain the URL with the
token `{s}`. Supported on {ece}.
| [[tilemap-subdomains]] `map.tilemap.options.subdomains:`
| An array of subdomains
used by the tile service. Specify the position of the subdomain the URL with
the token `{s}`. Supported on {ece}.
[[tilemap-url]]`map.tilemap.url:`:: The URL to the tileservice that {kib} uses
| [[tilemap-url]] `map.tilemap.url:`
| The URL to the tileservice that {kib} uses
to display map tiles in tilemap visualizations. Supported on {ece}. By default,
{kib} reads this url from an external metadata service, but users can still
{kib} reads this URL from an external metadata service, but users can
override this parameter to use their own Tile Map Service. For example:
`"https://tiles.elastic.co/v2/default/{z}/{x}/{y}.png?elastic_tile_service_tos=agree&my_app_name=kibana"`
`ops.interval:`:: *Default: 5000* Set the interval in milliseconds to sample
system and process performance metrics. The minimum value is 100.
`newsfeed.enabled:` :: *Default: `true`* Controls whether to enable the newsfeed
| `newsfeed.enabled:`
| Controls whether to enable the newsfeed
system for the {kib} UI notification center. Set to `false` to disable the
newsfeed system.
newsfeed system. *Default: `true`*
`path.data:`:: *Default: `data`* The path where {kib} stores persistent data
not saved in {es}.
| `path.data:`
| The path where {kib} stores persistent data
not saved in {es}. *Default: `data`*
`pid.file:`:: Specifies the path where {kib} creates the process ID file.
| `pid.file:`
| Specifies the path where {kib} creates the process ID file.
`server.basePath:`:: Enables you to specify a path to mount {kib} at if you are
| `ops.interval:`
| Set the interval in milliseconds to sample
system and process performance metrics. The minimum value is 100. *Default: `5000`*
| `server.basePath:`
| Enables you to specify a path to mount {kib} at if you are
running behind a proxy. Use the `server.rewriteBasePath` setting to tell {kib}
if it should remove the basePath from requests it receives, and to prevent a
deprecation warning at startup. This setting cannot end in a slash (`/`).
[[server-compression]]`server.compression.enabled:`:: *Default: `true`* Set to `false` to disable HTTP compression for all responses.
| [[server-compression]] `server.compression.enabled:`
| Set to `false` to disable HTTP compression for all responses. *Default: `true`*
`server.compression.referrerWhitelist:`:: *Default: none* Specifies an array of trusted hostnames, such as the {kib} host, or a reverse
proxy sitting in front of it. This determines whether HTTP compression may be used for responses, based on the request's `Referer` header.
This setting may not be used when `server.compression.enabled` is set to `false`.
| `server.compression.referrerWhitelist:`
| Specifies an array of trusted hostnames, such as the {kib} host, or a reverse
proxy sitting in front of it. This determines whether HTTP compression may be used for responses, based on the request `Referer` header.
This setting may not be used when `server.compression.enabled` is set to `false`. *Default: `none`*
`server.customResponseHeaders:`:: *Default: `{}`* Header names and values to
send on all responses to the client from the {kib} server.
| `server.customResponseHeaders:`
| Header names and values to
send on all responses to the client from the {kib} server. *Default: `{}`*
`server.host:`:: *Default: "localhost"* This setting specifies the host of the
back end server. To allow remote users to connect, set the value to the IP address or DNS name of the {kib} server.
| `server.host:`
| This setting specifies the host of the
back end server. To allow remote users to connect, set the value to the IP address or DNS name of the {kib} server. *Default: `"localhost"`*
`server.keepaliveTimeout:`:: *Default: "120000"* The number of milliseconds to wait for additional data before restarting
the `server.socketTimeout` counter.
| `server.keepaliveTimeout:`
| The number of milliseconds to wait for additional data before restarting
the `server.socketTimeout` counter. *Default: `"120000"`*
`server.maxPayloadBytes:`:: *Default: 1048576* The maximum payload size in bytes
for incoming server requests.
| `server.maxPayloadBytes:`
| The maximum payload size in bytes
for incoming server requests. *Default: `1048576`*
`server.name:`:: *Default: "your-hostname"* A human-readable display name that
identifies this {kib} instance.
| `server.name:`
| A human-readable display name that
identifies this {kib} instance. *Default: `"your-hostname"`*
`server.port:`:: *Default: 5601* {kib} is served by a back end server. This
setting specifies the port to use.
| `server.port:`
| {kib} is served by a back end server. This
setting specifies the port to use. *Default: `5601`*
`server.rewriteBasePath:`:: *Default: false* Deprecated setting that specifies if {kib} should
rewrite requests that are prefixed with `server.basePath`, or require that they
are rewritten by your reverse proxy.
| `server.rewriteBasePath:`
| Specifies whether {kib} should
rewrite requests that are prefixed with `server.basePath` or require that they
are rewritten by your reverse proxy. In {kib} 6.3 and earlier, the default is
`false`. In {kib} 7.x, the setting is deprecated. In {kib} 8.0 and later, the
default is `true`. *Default: `deprecated`*
`server.socketTimeout:`:: *Default: "120000"* The number of milliseconds to wait before closing an
inactive socket.
| `server.socketTimeout:`
| The number of milliseconds to wait before closing an
inactive socket. *Default: `"120000"`*
`server.ssl.certificate:` and `server.ssl.key:`:: Paths to a PEM-encoded X.509 server certificate and its corresponding private key. These
are used by {kib} to establish trust when receiving inbound SSL/TLS connections from end users.
+
NOTE: These settings cannot be used in conjunction with `server.ssl.keystore.path`.
| `server.ssl.certificate:` and `server.ssl.key:`
| Paths to a PEM-encoded X.509 server certificate and its corresponding private key. These
are used by {kib} to establish trust when receiving inbound SSL/TLS connections from users.
`server.ssl.certificateAuthorities:`:: Paths to one or more PEM-encoded X.509 certificate authority (CA) certificates which make up a
|===
[NOTE]
============
These settings cannot be used in conjunction with `server.ssl.keystore.path`.
============
[cols="2*<"]
|===
| `server.ssl.certificateAuthorities:`
| Paths to one or more PEM-encoded X.509 certificate authority (CA) certificates which make up a
trusted certificate chain for {kib}. This chain is used by {kib} to establish trust when receiving inbound SSL/TLS connections from end
users. If PKI authentication is enabled, this chain is also used by {kib} to verify client certificates from end users.
+
In addition to this setting, trusted certificates may be specified via `server.ssl.keystore.path` and/or `server.ssl.truststore.path`.
`server.ssl.cipherSuites:`::
*Default: ECDHE-RSA-AES128-GCM-SHA256, ECDHE-ECDSA-AES128-GCM-SHA256, ECDHE-RSA-AES256-GCM-SHA384, ECDHE-ECDSA-AES256-GCM-SHA384, DHE-RSA-AES128-GCM-SHA256, ECDHE-RSA-AES128-SHA256, DHE-RSA-AES128-SHA256, ECDHE-RSA-AES256-SHA384, DHE-RSA-AES256-SHA384, ECDHE-RSA-AES256-SHA256, DHE-RSA-AES256-SHA256, HIGH,!aNULL, !eNULL, !EXPORT, !DES, !RC4, !MD5, !PSK, !SRP, !CAMELLIA*.
Details on the format, and the valid options, are available via the
| `server.ssl.cipherSuites:`
| Details on the format, and the valid options, are available via the
https://www.openssl.org/docs/man1.0.2/apps/ciphers.html#CIPHER-LIST-FORMAT[OpenSSL cipher list format documentation].
*Default: `ECDHE-RSA-AES128-GCM-SHA256, ECDHE-ECDSA-AES128-GCM-SHA256, ECDHE-RSA-AES256-GCM-SHA384, ECDHE-ECDSA-AES256-GCM-SHA384, DHE-RSA-AES128-GCM-SHA256, ECDHE-RSA-AES128-SHA256, DHE-RSA-AES128-SHA256, ECDHE-RSA-AES256-SHA384, DHE-RSA-AES256-SHA384, ECDHE-RSA-AES256-SHA256, DHE-RSA-AES256-SHA256, HIGH,!aNULL, !eNULL, !EXPORT, !DES, !RC4, !MD5, !PSK, !SRP, !CAMELLIA`*.
`server.ssl.clientAuthentication:`:: *Default: `"none"`* Controls {kib}’s behavior in regard to requesting a certificate from client
| `server.ssl.clientAuthentication:`
| Controls the behavior in {kib} for requesting a certificate from client
connections. Valid values are `"required"`, `"optional"`, and `"none"`. Using `"required"` will refuse to establish the connection unless a
client presents a certificate, using `"optional"` will allow a client to present a certificate if it has one, and using `"none"` will
prevent a client from presenting a certificate.
prevent a client from presenting a certificate. *Default: `"none"`*
`server.ssl.enabled:`:: *Default: `false`* Enables SSL/TLS for inbound connections to {kib}. When set to `true`, a certificate and its
| `server.ssl.enabled:`
| Enables SSL/TLS for inbound connections to {kib}. When set to `true`, a certificate and its
corresponding private key must be provided. These can be specified via `server.ssl.keystore.path` or the combination of
`server.ssl.certificate` and `server.ssl.key`.
`server.ssl.certificate` and `server.ssl.key`. *Default: `false`*
`server.ssl.keyPassphrase:`:: The password that will be used to decrypt the private key that is specified via `server.ssl.key`. This value
| `server.ssl.keyPassphrase:`
| The password that decrypts the private key that is specified via `server.ssl.key`. This value
is optional, as the key may not be encrypted.
`server.ssl.keystore.path:`:: Path to a PKCS#12 keystore that contains an X.509 server certificate and its corresponding private key. If the
| `server.ssl.keystore.path:`
| Path to a PKCS#12 keystore that contains an X.509 server certificate and its corresponding private key. If the
keystore contains any additional certificates, those will be used as a trusted certificate chain for {kib}. All of these are used by {kib}
to establish trust when receiving inbound SSL/TLS connections from end users. The certificate chain is also used by {kib} to verify client
certificates from end users when PKI authentication is enabled.
+
--
In addition to this setting, trusted certificates may be specified via `server.ssl.certificateAuthorities` and/or
`server.ssl.truststore.path`.
NOTE: This setting cannot be used in conjunction with `server.ssl.certificate` or `server.ssl.key`.
--
|===
`server.ssl.keystore.password:`:: The password that will be used to decrypt the keystore specified via `server.ssl.keystore.path`. If the
[NOTE]
============
This setting cannot be used in conjunction with `server.ssl.certificate` or `server.ssl.key`
============
[cols="2*<"]
|===
| `server.ssl.keystore.password:`
| The password that will be used to decrypt the keystore specified via `server.ssl.keystore.path`. If the
keystore has no password, leave this unset. If the keystore has an empty password, set this to `""`.
`server.ssl.truststore.path:`:: Path to a PKCS#12 trust store that contains one or more X.509 certificate authority (CA) certificates which
| `server.ssl.truststore.path:`
| Path to a PKCS#12 trust store that contains one or more X.509 certificate authority (CA) certificates which
make up a trusted certificate chain for {kib}. This chain is used by {kib} to establish trust when receiving inbound SSL/TLS connections
from end users. If PKI authentication is enabled, this chain is also used by {kib} to verify client certificates from end users.
+
In addition to this setting, trusted certificates may be specified via `server.ssl.certificateAuthorities` and/or
`server.ssl.keystore.path`.
`server.ssl.truststore.password:`:: The password that will be used to decrypt the trust store specified via `server.ssl.truststore.path`. If
| `server.ssl.truststore.password:`
| The password that will be used to decrypt the trust store specified via `server.ssl.truststore.path`. If
the trust store has no password, leave this unset. If the trust store has an empty password, set this to `""`.
`server.ssl.redirectHttpFromPort:`:: {kib} binds to this port and redirects
| `server.ssl.redirectHttpFromPort:`
| {kib} binds to this port and redirects
all http requests to https over the port configured as `server.port`.
`server.ssl.supportedProtocols:`:: *Default: TLSv1.1, TLSv1.2* An array of
supported protocols with versions. Valid protocols: `TLSv1`, `TLSv1.1`, `TLSv1.2`
| `server.ssl.supportedProtocols:`
| An array of supported protocols with versions.
Valid protocols: `TLSv1`, `TLSv1.1`, `TLSv1.2`. *Default: TLSv1.1, TLSv1.2*
`server.xsrf.whitelist:`:: It is not recommended to disable protections for
| `server.xsrf.whitelist:`
| It is not recommended to disable protections for
arbitrary API endpoints. Instead, supply the `kbn-xsrf` header.
The `server.xsrf.whitelist` setting requires the following format:
[source,text]
|===
[source,text]
----
*Default: [ ]* An array of API endpoints which should be exempt from Cross-Site Request Forgery ("XSRF") protections.
----
`status.allowAnonymous:`:: *Default: false* If authentication is enabled,
setting this to `true` enables unauthenticated users to access the {kib} server
status API and status page.
[cols="2*<"]
|===
`telemetry.allowChangingOptInStatus`:: *Default: true*. If `true`,
users are able to change the telemetry setting at a later time in
<<advanced-options, Advanced Settings>>. If `false`,
| `status.allowAnonymous:`
| If authentication is enabled,
setting this to `true` enables unauthenticated users to access the {kib}
server status API and status page. *Default: `false`*
| `telemetry.allowChangingOptInStatus`
| When `true`, users are able to change the telemetry setting at a later time in
<<advanced-options, Advanced Settings>>. When `false`,
{kib} looks at the value of `telemetry.optIn` to determine whether to send
telemetry data or not. `telemetry.allowChangingOptInStatus` and `telemetry.optIn`
cannot be `false` at the same time.
cannot be `false` at the same time. *Default: `true`*.
`telemetry.optIn`:: *Default: true* If `true`, telemetry data is sent to Elastic.
If `false`, collection of telemetry data is disabled.
To enable telemetry and prevent users from disabling it,
set `telemetry.allowChangingOptInStatus` to `false` and `telemetry.optIn` to `true`.
| `telemetry.optIn`
| When `true`, telemetry data is sent to Elastic.
When `false`, collection of telemetry data is disabled.
To enable telemetry and prevent users from disabling it,
set `telemetry.allowChangingOptInStatus` to `false` and `telemetry.optIn` to `true`.
*Default: `true`*
`telemetry.enabled`:: *Default: true* Reporting your cluster statistics helps
| `telemetry.enabled`
| Reporting your cluster statistics helps
us improve your user experience. Your data is never shared with anyone. Set to
`false` to disable telemetry capabilities entirely. You can alternatively opt
out through the *Advanced Settings* in {kib}.
out through *Advanced Settings*. *Default: `true`*
`vis_type_vega.enableExternalUrls:`:: *Default: false* Set this value to true to allow Vega to use any URL to access external data sources and images. If false, Vega can only get data from {es}.
| `vis_type_vega.enableExternalUrls:`
| Set this value to true to allow Vega to use any URL to access external data
sources and images. When false, Vega can only get data from {es}. *Default: `false`*
`xpack.license_management.enabled`:: *Default: true* Set this value to false to
disable the License Management user interface.
| `xpack.license_management.enabled`
| Set this value to false to
disable the License Management UI. *Default: `true`*
`xpack.rollup.enabled:`:: *Default: true* Set this value to false to disable the
Rollup user interface.
| `xpack.rollup.enabled:`
| Set this value to false to disable the
Rollup UI. *Default: true*
`i18n.locale`:: *Default: en* Set this value to change the {kib} interface language. Valid locales are: `en`, `zh-CN`, `ja-JP`.
| `i18n.locale`
| Set this value to change the {kib} interface language.
Valid locales are: `en`, `zh-CN`, `ja-JP`. *Default: `en`*
|===
include::{docdir}/settings/alert-action-settings.asciidoc[]
include::{docdir}/settings/apm-settings.asciidoc[]