keycloak-scim/topics/realms/email.adoc

20 lines
927 B
Text
Raw Normal View History

2016-05-13 19:49:56 +00:00
[[_email]]
=== Email Settings
2016-05-13 19:55:51 +00:00
{{book.project.name}} sends emails to users to verify their email address, when the forget their passwords, or when an admin needs to
receive notifications about a server event.
To enable {{book.project.name}} to send emails you need to provide {{book.project.name}} with your SMTP server settings.
This is configured per realm. Go to the `Realm Settings` left menu
2016-05-13 19:49:56 +00:00
item and click the `Email` tab.
.Email Tab
2016-05-13 19:49:56 +00:00
image:../../{{book.images}}/email-tab.png[]
2016-05-13 19:55:51 +00:00
As emails are used for recovering usernames and passwords it's recommended to use SSL or TLS, especially if the SMTP server is on an external network.
To enable SSL click on `Enable SSL` or to enable TLS click on `Enable TLS`.
You will most likely also need to change the `Port` (the default port for SSL/TLS is 465).
If your SMTP server requires authentication click on `Enable Authentication` and insert the `Username` and `Password`.