Back to Kibana

kibana-encryption-keys [kibana-encryption-keys]

docs/reference/commands/kibana-encryption-keys.md

9.4.01.3 KB
Original Source

kibana-encryption-keys [kibana-encryption-keys]

The kibana-encryption-keys command helps you generate encryption keys that {{kib}} uses to protect sensitive information.

{{kib}} uses encryption keys in several areas, ranging from encrypting data in {{kib}} associated indices to storing session information. By defining these encryption keys in your configuration, you’ll ensure consistent operations across restarts.

Usage [_usage]

shell
bin/kibana-encryption-keys [command] [options]

Commands [encryption-key-parameters]

generate : Generate encryption keys.

Unless interactive mode (`-i`) is used, the generated encryption keys will be output to your console only. From here, you should manually copy the keys into either `kibana.yml` or where else you’re configurating {{kib}}.

`-i, --interactive`
:   Prompts you for which encryption keys to set and optionally where to save a sample configuration file.

`-q, --quiet`
:   Outputs the config options/encryption keys only (without helper information).

`-f, --force`
:   Generates new keys for all settings. By default, only un-configured encryption keys will be generated.

`-h, --help`
:   Shows help information.

Examples [_examples]

shell
bin/kibana-encryption-keys generate