Skip to content

Docs: Add password keystore setting for email account passwords #33409

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Dec 6, 2018
Merged

Docs: Add password keystore setting for email account passwords #33409

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8ae2249
Docs: Add password keystore setting for email account passwords
spinscale Sep 5, 2018
4f14807
review comment: remove cleartext setting mention, refer to secure set…
spinscale Sep 6, 2018
96e0c59
Merge branch 'master' into 1809-watcher-fix-email-docs-secure-password
spinscale Dec 6, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 32 additions & 4 deletions x-pack/docs/en/watcher/actions/email.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -318,7 +318,14 @@ xpack.notification.email.account:
host: smtp.gmail.com
port: 587
user: <username>
password: <password>
--------------------------------------------------

In order to store the account SMTP password, use the keystore command
(see {ref}/secure-settings.html[secure settings])

[source,yaml]
--------------------------------------------------
bin/elasticsearch-keystore xpack.notification.email.account.gmail_account.smtp.secure_password
--------------------------------------------------

If you get an authentication error that indicates that you need to continue the
Expand Down Expand Up @@ -349,9 +356,17 @@ xpack.notification.email.account:
host: smtp-mail.outlook.com
port: 587
user: <email.address>
password: <password>
--------------------------------------------------

In order to store the account SMTP password, use the keystore command
(see {ref}/secure-settings.html[secure settings])

[source,yaml]
--------------------------------------------------
bin/elasticsearch-keystore xpack.notification.email.account.outlook_account.smtp.secure_password
--------------------------------------------------


When sending emails, you have to provide a from address, either a default one
in your account configuration or as part of the email action in the watch.

Expand All @@ -377,10 +392,17 @@ xpack.notification.email.account:
host: email-smtp.us-east-1.amazonaws.com <1>
port: 587
user: <username>
password: <password>
--------------------------------------------------
<1> `smtp.host` varies depending on the region

In order to store the account SMTP password, use the keystore command
(see {ref}/secure-settings.html[secure settings])

[source,yaml]
--------------------------------------------------
bin/elasticsearch-keystore xpack.notification.email.account.ses_account.smtp.secure_password
--------------------------------------------------

NOTE: You need to use your Amazon SES SMTP credentials to send email through
Amazon SES. For more information, see
http://docs.aws.amazon.com/ses/latest/DeveloperGuide/smtp-credentials.html[Obtaining
Expand Down Expand Up @@ -409,14 +431,20 @@ xpack.notification.email.account:
host: <your exchange server>
port: 587
user: <email address of service account> <2>
password: <password>
--------------------------------------------------
<1> Some organizations configure Exchange to validate that the `from` field is a
valid local email account.
<2> Many organizations support use of your email address as your username, though
it is a good idea to check with your system administrator if you receive
authentication-related failures.

In order to store the account SMTP password, use the keystore command
(see {ref}/secure-settings.html[secure settings])

[source,yaml]
--------------------------------------------------
bin/elasticsearch-keystore xpack.notification.email.account.exchange_account.smtp.secure_password
--------------------------------------------------

[float]
[[email-html-sanitization]]
Expand Down