WARNING: Version 5.6 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.

« Install Kibana on Windows Running Kibana on Docker »
Elastic Docs ›Kibana User Guide [5.6] ›Set Up Kibana

Configuring Kibana

edit

Configuring Kibana

edit

The 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.

server.port:
Default: 5601 Kibana is served by a back end server. This setting specifies the port to use.
server.host:
Default: "localhost" This setting specifies the host of the back end server.
server.basePath:
Enables you to specify a path to mount Kibana at if you are running behind a proxy. This only affects the URLs generated by Kibana, your proxy is expected to remove the basePath value before forwarding requests to Kibana. This setting cannot end in a slash (/).
server.maxPayloadBytes:
Default: 1048576 The maximum payload size in bytes for incoming server requests.
server.name:
Default: "your-hostname" A human-readable display name that identifies this Kibana instance.
server.defaultRoute:
Default: "/app/kibana" This setting specifies the default route when opening Kibana. You can use this setting to modify the landing page when opening Kibana.
server.customResponseHeaders:
Default: {} Header names and values to send on all responses to the client from the Kibana server.
elasticsearch.url:
Default: "http://localhost:9200" The URL of the Elasticsearch instance to use for all your queries.
elasticsearch.preserveHost:
Default: true When this setting’s value is true Kibana uses the hostname specified in the server.host setting. When the value of this setting is false, Kibana uses the hostname of the host that connects to this Kibana instance.
kibana.index:
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.
kibana.defaultAppId:
Default: "discover" The default application to load.
tilemap.url:
The URL to the tile service that Kibana uses to display map tiles in tilemap visualizations. By default, Kibana reads this url from an external metadata service, but users can still 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"
tilemap.options.minZoom:
Default: 1 The minimum zoom level.
tilemap.options.maxZoom:
Default: 10 The maximum zoom level.
tilemap.options.attribution:
Default: "© [Elastic Maps Service](https://www.elastic.co/elastic-maps-service)" The map attribution string.
tilemap.options.subdomains:
An array of subdomains used by the tile service. Specify the position of the subdomain the URL with the token {s}.
regionmap

Specifies additional vector layers for use in Region Map visualizations. Each layer object points to an external vector file that contains a geojson FeatureCollection. The file must use the [WGS84 coordinate reference system](https://en.wikipedia.org/wiki/World_Geodetic_System) 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. The following example shows a valid regionmap configuration. 

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"
name:
Mandatory. A description of the map being provided.
url:
Mandatory. The location of the geojson file as provided by a webserver.
attribution:
Optional. References the originating source of the geojson file.
fields:
Mandatory. Each layer can contain multiple fields to indicate what properties from the geojson features you wish to expose. The example above shows how to define multiple properties.
fields.name:
Mandatory. This value is used to do an inner-join between the document stored in Elasticsearch and the geojson file. e.g. if the field in the geojson is called Location and has city names, there must be a field in Elasticsearch that holds the same values that Kibana can then use to lookup for the geoshape data.
fields.description:
Mandatory. The human readable text that is shown under the Options tab when building the Region Map visualization.
elasticsearch.username: and elasticsearch.password:
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.
server.ssl.enabled
Default: "false" Enables SSL for outgoing requests from the Kibana server to the browser. When set to true, server.ssl.certificate and server.ssl.key are required
server.ssl.cert:
Path to the PEM-format SSL certificate. This file enables SSL for outgoing requests from the Kibana server to the browser. [5.3.0] Deprecated in 5.3.0. Replaced by server.ssl.certificate
server.ssl.certificate: and server.ssl.key:
Paths to the PEM-format SSL certificate and SSL key files, respectively.
server.ssl.keyPassphrase:
The passphrase that will be used to decrypt the private key. This value is optional as the key may not be encrypted.
server.ssl.certificateAuthorities:
List of paths to PEM encoded certificate files that should be trusted.
server.ssl.supportedProtocols:
Default: TLSv1, TLSv1.1, TLSv1.2 Supported protocols with versions. Valid protocols: TLSv1, TLSv1.1, TLSv1.2
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 [OpenSSL cipher list format documentation](https://www.openssl.org/docs/man1.0.2/apps/ciphers.html#CIPHER-LIST-FORMAT)
elasticsearch.ssl.cert:
Optional setting that provides the path to the PEM-format SSL certificate. This file validates that your Elasticsearch backend uses the same key files. [5.3.0] Deprecated in 5.3.0. Replaced by elasticsearch.ssl.certificate
elasticsearch.ssl.certificate: and elasticsearch.ssl.key:
Optional settings that provide the paths to the PEM-format SSL certificate and key files. These files are used to verify the identity of Kibana to Elasticsearch and are required when xpack.ssl.verification_mode in Elasticsearch is set to either certificate or full.
elasticsearch.ssl.keyPassphrase:
The passphrase that will be used to decrypt the private key. This value is optional as the key may not be encrypted.
elasticsearch.ssl.ca:
Optional setting that enables you to specify a path to the PEM file for the certificate authority for your Elasticsearch instance. [5.3.0] Deprecated in 5.3.0. Replaced by elasticsearch.ssl.certificateAuthorities
elasticsearch.ssl.certificateAuthorities:
Optional setting that enables you to specify a list of paths to the PEM file for the certificate authority for your Elasticsearch instance.
elasticsearch.ssl.verify:
Default: true To disregard the validity of SSL certificates, change this setting’s value to false. [5.3.0] Deprecated in 5.3.0. Replaced by elasticsearch.ssl.verificationMode
elasticsearch.ssl.verificationMode:
Default: full Controls the verification of certificates presented by Elasticsearch. Valid values are none, certificate, and full. full performs hostname verification, and certificate does not.
elasticsearch.pingTimeout:
Default: the value of the elasticsearch.requestTimeout setting Time in milliseconds to wait for Elasticsearch to respond to pings.
elasticsearch.requestTimeout:
Default: 30000 Time in milliseconds to wait for responses from the back end or Elasticsearch. This value must be a positive integer.
elasticsearch.requestHeadersWhitelist:
Default: [ 'authorization' ] List of Kibana client-side headers to send to Elasticsearch. To send no client-side headers, set this value to [] (an empty list).
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.shardTimeout:
Default: 0 Time in milliseconds for Elasticsearch to wait for responses from shards. Set to 0 to disable.
elasticsearch.startupTimeout:
Default: 5000 Time in milliseconds to wait for Elasticsearch at Kibana startup before retrying.
pid.file:
Specifies the path where Kibana creates the process ID file.
path.data:
Default: ./data The path where Kibana stores persistent data not saved in Elasticsearch
logging.dest:
Default: stdout Enables you specify a file where Kibana stores log output.
logging.silent:
Default: false Set the value of this setting to true to suppress all logging output.
logging.quiet:
Default: false Set the value of this setting to true to suppress all logging output other than error messages.
logging.verbose:
Default: false Set the value of this setting to true to log all events, including system usage information and all requests.
ops.interval:
Default: 5000 Set the interval in milliseconds to sample system and process performance metrics. The minimum value is 100.
status.allowAnonymous:
Default: false If authentication is enabled, setting this to true allows unauthenticated users to access the Kibana server status API and status page.
cpu.cgroup.path.override:
Override for cgroup cpu path when mounted in manner that is inconsistent with /proc/self/cgroup
cpuacct.cgroup.path.override:
Override for cgroup cpuacct path when mounted in manner that is inconsistent with /proc/self/cgroup
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.
elasticsearch.tribe.url:
Optional URL of the Elasticsearch tribe instance to use for all your queries.
elasticsearch.tribe.username: and elasticsearch.tribe.password:
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.
elasticsearch.tribe.ssl.certificate: and elasticsearch.tribe.ssl.key:
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.
elasticsearch.tribe.ssl.keyPassphrase:
The passphrase that will be used to decrypt the private key. This value is optional as the key may not be encrypted.
elasticsearch.tribe.ssl.certificateAuthorities:
Optional setting that enables you to specify a path to the PEM file for the certificate authority for your tribe Elasticsearch instance.
elasticsearch.tribe.ssl.verificationMode:
Default: full Controls the verification of certificates. Valid values are none, certificate, and full. full performs hostname verification, and certificate does not.
elasticsearch.tribe.pingTimeout:
Default: the value of the elasticsearch.tribe.requestTimeout setting Time in milliseconds to wait for Elasticsearch to respond to pings.
elasticsearch.tribe.requestTimeout:
Default: 30000 Time in milliseconds to wait for responses from the back end or Elasticsearch. This value must be a positive integer.
elasticsearch.tribe.requestHeadersWhitelist:
Default: [ 'authorization' ] List of Kibana client-side headers to send to Elasticsearch. To send no client-side headers, set this value to [] (an empty list).
elasticsearch.tribe.customHeaders:
Default: {} Header names and values to send to Elasticsearch. Any custom headers cannot be overwritten by client-side headers, regardless of the elasticsearch.tribe.requestHeadersWhitelist configuration.
« Install Kibana on Windows Running Kibana on Docker »