libre.sh/keycloak-scim
2
0
Fork 0
Code Issues 14 Pull requests Releases Packages Activity Actions 6

email

Browse source
This commit is contained in:
Bill Burke 2016-05-13 15:55:51 -04:00
parent 02930a8616
commit d6c3200479
2 changed files with 10 additions and 32 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
topics/email.adoc
View file

@ -1,28 +0,0 @@
[[_email_config]]
= Email
Keycloak sends emails to users to verify their email address.
Emails are also used to allow users to safely restore their username and passwords.
== Email Server Config
To enable Keycloak to send emails you need to provide Keycloak with your SMTP server settings.
If you don't have a SMTP server you can use one of many hosted solutions (such as Sendgrid or smtp2go).
To configure your SMTP server, open the `Keycloak Admin Console`, select your realm from the drop-down box in the top left corner.
Then click on `Email` in the menu at the top.
You are required to fill in the `Host` and `Port` for your SMTP server (the default port for SMTP is 25). You also have to specify the sender email address (`From`). The other options are optional.
The screenshot below shows a simple example where the SMTP server doesn't use SSL or TLS and doesn't require authentication.
== Enable SSL or TLS
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).
== Authentication
If your SMTP server requires authentication click on `Enable Authentication` and insert the `Username` and `Password`.

14
topics/realms/email.adoc
View file

@ -2,12 +2,18 @@
=== Email Settings === Email Settings
{{book.project.name}} will sometimes need to send out emails for example, when a user forgets their password, or when an admin {{book.project.name}} sends emails to users to verify their email address, when the forget their passwords, or when an admin needs to
needs to receive a notification about a server event. This is configured per realm. Go to the `Realm Settings` left menu 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
item and click the `Email` tab. item and click the `Email` tab.
.Themes Tab .Themes Tab
image:../../{{book.images}}/email-tab.png[] image:../../{{book.images}}/email-tab.png[]
The email settings should be self explanatory. Consult your sys admin on the settings you need to connect to your email 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.
server. 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`.