WARNING: Version 6.2 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.
Secure Settings
editSecure Settings
editSome settings are sensitive, and relying on filesystem permissions to protect
their values is not sufficient. For this use case, Kibana provides a
keystore, and the kibana-keystore
tool to manage the settings in the keystore.
All commands here should be run as the user which will run Kibana.
Creating the keystore
editTo create the kibana.keystore
, use the create
command:
bin/kibana-keystore create
The file kibana.keystore
will be created in the directory defined by the
path.data
configuration setting.
Listing settings in the keystore
editA list of the settings in the keystore is available with the list
command:
bin/kibana-keystore list
Adding string settings
editSensitive string settings, like authentication credentials for Elasticsearch
can be added using the add
command:
bin/kibana-keystore add the.setting.name.to.set
Once added to the keystore, these setting will be automatically applied to this instance of Kibana when started. For example if you do
bin/kibana-keystore add elasticsearch.username
you will be prompted to provide the value for elasticsearch.username. (Your input will show as asterisks.)
The tool will prompt for the value of the setting. To pass the value
through stdin, use the --stdin
flag:
cat /file/containing/setting/value | bin/kibana-keystore add the.setting.name.to.set --stdin
Removing settings
editTo remove a setting from the keystore, use the remove
command:
bin/kibana-keystore remove the.setting.name.to.remove