kibana/docs/reference/commands/kibana-encryption-keys.md
Colleen McGinnis 1814c60017
[docs] Migrate docs from AsciiDoc to Markdown (#212558)
Migrate docs from AsciiDoc to Markdown. The preview can be built after
#212557 is merged.

@florent-leborgne please tag reviewers, add the appropriate label(s),
and take this out of draft when you're ready.

Note: More files are deleted than added here because the content from
some files was moved to
[elastic/docs-content](https://github.com/elastic/docs-content).

**What has moved to
[elastic/docs-content](https://github.com/elastic/docs-content)?**

Public-facing narrative and conceptual docs have moved. Most can now be
found under the following directories in the new docs:
- explore-analyze: Discover, Dashboards, Visualizations, Reporting,
Alerting, dev tools...
- deploy-manage: Stack management (Spaces, user management, remote
clusters...)
- troubleshooting: .... troubleshooting pages

**What is staying in the Kibana repo?**

- Reference content (= anything that is or could be auto-generated):
Settings, syntax references
- Release notes
- Developer guide

---------

Co-authored-by: Florent Le Borgne <florent.leborgne@elastic.co>
2025-03-04 14:56:07 +01:00

46 lines
1.4 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

---
mapped_pages:
- https://www.elastic.co/guide/en/kibana/current/kibana-encryption-keys.html
---
# 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, youll 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 youre 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
```