WARNING: Version 4.5 of Kibana has passed its EOL date.
This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.
Setting Kibana Server Properties
editSetting Kibana Server Properties
editThe Kibana server reads properties from the kibana.yml
file on startup. The default settings configure Kibana to run
on localhost:5601
. To change the host or port number, or connect to Elasticsearch running on a different machine,
you’ll need to update your kibana.yml
file. You can also enable SSL and set a variety of other options.
Table 3. Kibana Configuration Settings
|
Default: 5601 Kibana is served by a back end server. This setting specifies the port to use. |
|
Default: "0.0.0.0" This setting specifies the IP address of the back end server. |
|
Enables you to specify a path to mount Kibana at if you are running behind a proxy. This setting cannot
end in a slash ( |
|
Default: 1048576 The maximum payload size in bytes for incoming server requests. |
|
Default: "http://localhost:9200" The URL of the Elasticsearch instance to use for all your queries. |
|
Default: true When this setting’s value is true Kibana uses the hostname specified in
the |
|
Default: ".kibana" Kibana uses an index in Elasticsearch to store saved searches, visualizations and dashboards. Kibana creates a new index if the index doesn’t already exist. |
|
Default: "discover" The default application to load. |
Default: |
|
|
Default: 1 The minimum zoom level. [4.5.3] Added in 4.5.3. |
|
Default: 10 The maximum zoom level. [4.5.3] Added in 4.5.3. |
|
Default: |
|
An array of subdomains used by the tile service.
Specify the position of the subdomain the URL with the token |
|
If your Elasticsearch is protected with basic authentication, these settings provide the username and password that the Kibana server uses to perform maintenance on the Kibana index at startup. Your Kibana users still need to authenticate with Elasticsearch, which is proxied through the Kibana server. |
|
Paths to the PEM-format SSL certificate and SSL key files, respectively. These files enable SSL for outgoing requests from the Kibana server to the browser. |
|
Optional settings that provide the paths to the PEM-format SSL certificate and key files. These files validate that your Elasticsearch backend uses the same key files. |
|
Optional setting that enables you to specify a path to the PEM file for the certificate authority for your Elasticsearch instance. |
|
Default: true To disregard the validity of SSL certificates, change this setting’s value
to |
|
Default: the value of the |
|
Default: 30000 Time in milliseconds to wait for responses from the back end or Elasticsearch. This value must be a positive integer. |
|
Default: 0 Time in milliseconds for Elasticsearch to wait for responses from shards. Set to 0 to disable. |
|
Default: 5000 Time in milliseconds to wait for Elasticsearch at Kibana startup before retrying. |
|
Specifies the path where Kibana creates the process ID file. |
|
Default: |
|
Default: |
|
Default: false Set the value of this setting to |
|
Default: false Set the value of this setting to |
|
Default: false Set the value of this setting to |
Deprecated in 4.2.
The names of several Kibana server properties changed in the 4.2 release of Kibana. The previous names remain as functional aliases, but are now deprecated and will be removed in a future release of Kibana
Table 4. Kibana Server Properties Changed in the 4.2 Release
|
The port that the Kibana server runs on. alias: default: |
|
The host to bind the Kibana server to. alias: default: |
|
The Elasticsearch instance where the indices you want to query reside. alias: default: |
|
By default, the host specified in the incoming request from the browser is specified as the host in the corresponding request Kibana sends to Elasticsearch. If you set this option to alias: default: |
|
This parameter specifies the path to the SSL certificate for Elasticsearch instances that require a client certificate. alias: |
|
This parameter specifies the path to the SSL key for Elasticsearch instances that require a client key. alias: |
|
This parameter specifies the password for Elasticsearch instances that use HTTP basic authentication. Kibana users still need to authenticate with Elasticsearch, which is proxied through the Kibana server. alias: |
|
This parameter specifies the username for Elasticsearch instances that use HTTP basic authentication. Kibana users still need to authenticate with Elasticsearch, which is proxied through the Kibana server. alias: |
|
This parameter specifies the maximum wait time in milliseconds for ping responses by Elasticsearch. alias: default: |
|
This parameter specifies the maximum wait time in milliseconds for Elasticsearch discovery at Kibana startup. Kibana repeats attempts to discover an Elasticsearch cluster after the specified time elapses. alias: default: |
|
The name of the index where saved searched, visualizations, and dashboards will be stored.. alias: default: |
|
The page that will be displayed when you launch Kibana: alias: default: |
|
Set this value to default: |
|
Set this value to default: |
|
Set this value to default: |
|
You can specify a map of log types to output tags for this parameter to create a customized set of loggable events, as in the following example: { log: ['info', 'warning', 'error', 'fatal'], response: '*', error: '*' } |
|
How long to wait for responses from the Kibana backend or Elasticsearch, in milliseconds. alias: default: |
|
How long Elasticsearch should wait for responses from shards. Set to 0 to disable. alias: default: |
|
Indicates whether or not to validate the Elasticsearch SSL certificate. Set to false to disable SSL verification. alias: default: |
|
An array of paths to the CA certificates for your Elasticsearch instance. Specify if
you are using a self-signed certificate so the certificate can be verified. Disable alias: |
|
The path to your Kibana server’s key file. Must be set to encrypt communications between the browser and Kibana. alias: |
|
The path to your Kibana server’s certificate file. Must be set to encrypt communications between the browser and Kibana. alias: |
|
The location where you want to store the process ID file. alias: default: |
|
The location where you want to store the Kibana’s log output. If not specified, log output is written to standard output and not stored. Specifying a log file suppresses log writes to standard output. alias: |