Skip to content

Commit 6d9a60d

Browse files
authored
Update elasticsearch-keystore.md
Moving the section out of Examples as advised.
1 parent a485fc6 commit 6d9a60d

File tree

1 file changed

+10
-11
lines changed

1 file changed

+10
-11
lines changed

docs/reference/elasticsearch/command-line-tools/elasticsearch-keystore.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,16 @@ Only some settings are designed to be read from the keystore. However, there is
8888
`-v, --verbose`
8989
: Shows verbose output.
9090

91+
## Handling special characters
92+
93+
Exclamation mark: `!`
94+
: When using the shell, the combination `\!` is stored as just `!`. This can lead to authentication failures if the password is not stored as intended.
95+
96+
Quotes: `"`
97+
: If quotes are used around the password, they become part of the password itself. This can cause the password to be incorrect when retrieved from the keystore.
98+
99+
Backslash: `\`
100+
: The backslash character needs to be properly escaped. If not escaped correctly, it may be omitted or misinterpreted, leading to incorrect password storage.
91101

92102
## Examples [elasticsearch-keystore-examples]
93103

@@ -158,17 +168,6 @@ echo -n 'your\!password' | bin/elasticsearch-keystore add the.setting.name.to.se
158168

159169
Values for multiple settings must be separated by carriage returns or newlines.
160170

161-
## Handling special characters
162-
163-
Exclamation mark: `!`
164-
: When using the shell, the combination `\!` is stored as just `!`. This can lead to authentication failures if the password is not stored as intended.
165-
166-
Quotes: `"`
167-
: If quotes are used around the password, they become part of the password itself. This can cause the password to be incorrect when retrieved from the keystore.
168-
169-
Backslash: `\`
170-
: The backslash character needs to be properly escaped. If not escaped correctly, it may be omitted or misinterpreted, leading to incorrect password storage.
171-
172171
### Add files to the keystore [add-file-to-keystore]
173172

174173
You can add sensitive files, like authentication key files for Cloud plugins, using the `add-file` command. Settings and file paths are specified in pairs consisting of `setting path`. The value of the setting will be the binary contents of the file path at the time the file is added to the keystore.

0 commit comments

Comments
 (0)