|
1 | 1 | [[kibana-encryption-keys]] |
2 | 2 | === Set up encryptions keys to protect sensitive information |
3 | 3 |
|
4 | | -The `kibana-encryption-keys` command helps you set up encryption keys that {kib} uses |
| 4 | +The `kibana-encryption-keys` command helps you generate encryption keys that {kib} uses |
5 | 5 | to protect sensitive information. |
6 | 6 |
|
7 | | -[discrete] |
8 | | -=== Synopsis |
9 | | - |
10 | | -[source,shell] |
11 | | --------------------------------------------------- |
12 | | -bin/kibana-encryption-keys generate |
13 | | -[-i, --interactive] [-q, --quiet] |
14 | | -[-f, --force] [-h, --help] |
15 | | --------------------------------------------------- |
16 | | - |
17 | | -[discrete] |
18 | | -=== Description |
19 | | - |
20 | 7 | {kib} uses encryption keys in several areas, ranging from encrypting data |
21 | 8 | in {kib} associated indices to storing session information. By defining these |
22 | 9 | encryption keys in your configuration, you'll ensure consistent operations |
23 | 10 | across restarts. |
24 | 11 |
|
25 | 12 | [discrete] |
26 | | -[[encryption-key-parameters]] |
27 | | -=== Parameters |
28 | | - |
29 | | -`generate`:: Randomly generates passwords to the console. |
| 13 | +=== Usage |
30 | 14 |
|
31 | | -`-i, --interactive`:: Prompts you for which encryption keys to set and optionally |
32 | | -where to save a sample configuration file. |
33 | | - |
34 | | -`-q, --quiet`:: Outputs the encryption keys without helper information. |
| 15 | +[source,shell] |
| 16 | +-------------------------------------------------- |
| 17 | +bin/kibana-encryption-keys [command] [options] |
| 18 | +-------------------------------------------------- |
35 | 19 |
|
36 | | -`-f, --force`:: Shows help information. |
| 20 | +[discrete] |
| 21 | +[[encryption-key-parameters]] |
| 22 | +=== Commands |
| 23 | + |
| 24 | +`generate`:: Generate encryption keys. |
| 25 | ++ |
| 26 | +Unless interactive mode (`-i`) is used, the generated encryption keys will be output to your console only. |
| 27 | +From here, you should manually copy the keys into either `kibana.yml` or where else you're configurating {kib}. |
| 28 | ++ |
| 29 | +`-i, --interactive`::: Prompts you for which encryption keys to set and optionally where to save a sample configuration file. |
| 30 | +`-q, --quiet`::: Outputs the config options/encryption keys only (without helper information). |
| 31 | +`-f, --force`::: Generates new keys for all settings. By default, only un-configured encryption keys will be generated. |
| 32 | +`-h, --help`::: Shows help information. |
37 | 33 |
|
38 | 34 | [discrete] |
39 | 35 | === Examples |
|
0 commit comments