libre.sh/keycloak-scim
3
0
Fork 0
Code Issues 15 Pull requests Releases 1 Packages Activity Actions

Minor improvements to email config in admin console. Added documentation for configuring smtp server

Browse source
This commit is contained in:
Stian Thorgersen 2014-01-20 10:31:47 +00:00
parent 2b38df9495
commit fa677055cc
12 changed files with 65 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
admin-ui/src/main/resources/META-INF/resources/admin/partials/realm-credentials.html
View file

@ -11,7 +11,7 @@
<li class="active"><a href="#/realms/{{realm.realm}}/required-credentials">Credentials</a></li>
<li><a href="#/realms/{{realm.realm}}/token-settings">Token</a></li>
<li><a href="#/realms/{{realm.realm}}/keys-settings">Keys</a></li>
<li><a href="#/realms/{{realm.realm}}/smtp-settings">SMTP</a></li>
<li><a href="#/realms/{{realm.realm}}/smtp-settings">Email</a></li>
</ul>
</div>
<div id="content">

2
admin-ui/src/main/resources/META-INF/resources/admin/partials/realm-default-roles.html
View file

@ -11,7 +11,7 @@
<li><a href="#/realms/{{realm.realm}}/required-credentials">Credentials</a></li>
<li><a href="#/realms/{{realm.realm}}/token-settings">Token</a></li>
<li><a href="#/realms/{{realm.realm}}/keys-settings">Keys</a></li>
<li><a href="#/realms/{{realm.realm}}/smtp-settings">SMTP</a></li>
<li><a href="#/realms/{{realm.realm}}/smtp-settings">Email</a></li>
</ul>
</div>
<div id="content">

2
admin-ui/src/main/resources/META-INF/resources/admin/partials/realm-detail.html
View file

@ -11,7 +11,7 @@
<li><a href="#/realms/{{realm.realm}}/required-credentials">Credentials</a></li>
<li><a href="#/realms/{{realm.realm}}/token-settings">Token</a></li>
<li><a href="#/realms/{{realm.realm}}/keys-settings">Keys</a></li>
<li><a href="#/realms/{{realm.realm}}/smtp-settings">SMTP</a></li>
<li><a href="#/realms/{{realm.realm}}/smtp-settings">Email</a></li>
</ul>
</div>
<div id="content">

2
admin-ui/src/main/resources/META-INF/resources/admin/partials/realm-keys.html
View file

@ -11,7 +11,7 @@
<li><a href="#/realms/{{realm.realm}}/required-credentials">Credentials</a></li>
<li><a href="#/realms/{{realm.realm}}/token-settings">Token</a></li>
<li class="active"><a href="#/realms/{{realm.realm}}/keys-settings">Keys</a></li>
<li><a href="#/realms/{{realm.realm}}/smtp-settings">SMTP</a></li>
<li><a href="#/realms/{{realm.realm}}/smtp-settings">Email</a></li>
</ul>
</div>
<div id="content">

14
admin-ui/src/main/resources/META-INF/resources/admin/partials/realm-smtp.html
View file

@ -11,7 +11,7 @@
<li><a href="#/realms/{{realm.realm}}/required-credentials">Credentials</a></li>
<li><a href="#/realms/{{realm.realm}}/token-settings">Token</a></li>
<li><a href="#/realms/{{realm.realm}}/keys-settings">Keys</a></li>
<li class="active"><a href="#/realms/{{realm.realm}}/smtp-settings">SMTP</a></li>
<li class="active"><a href="#/realms/{{realm.realm}}/smtp-settings">Email</a></li>
</ul>
</div>
<div id="content">
@ -20,7 +20,7 @@
<li><a href="#/realms/{{realm.realm}}">Settings</a></li>
<li class="active">SMTP Configuration</li>
</ol>
<h2 class="pull-left"><span>{{realm.realm}}</span> SMTP Settings</h2>
<h2 class="pull-left"><span>{{realm.realm}}</span> Email Server Settings</h2>
<p class="subtitle"><span class="required">*</span> Required fields</p>
<form name="realmForm" novalidate>
<fieldset>
@ -40,7 +40,7 @@
<div class="form-group clearfix">
<label for="smtpFrom" class="control-label">From <span class="required">*</span></label>
<div class="controls">
<input id="smtpFrom" type="email" ng-model="realm.smtpServer.from" placeholder="SMTP From" required>
<input id="smtpFrom" type="email" ng-model="realm.smtpServer.from" placeholder="Sender Email Address" required>
</div>
</div>
<div class="form-group clearfix">
@ -53,18 +53,18 @@
</div>
</fieldset>
<fieldset>
<legend collapsed><span class="text">Authentication</span></legend>
<legend uncollapsed><span class="text">Authentication</span></legend>
<div class="form-group clearfix">
<label for="smtpAuth" class="control-label">Enabled</label>
<label for="smtpAuth" class="control-label">Enable Authentication</label>
<input ng-model="realm.smtpServer.auth" name="smtpAuth" id="smtpAuth" onoffswitch />
</div>
<div class="form-group clearfix">
<div class="form-group clearfix" data-ng-show="realm.smtpServer.auth">
<label for="smtpUsername" class="control-label">Username <span class="required" ng-show="realm.smtpServer.auth">*</span></label>
<div class="controls">
<input id="smtpUsername" type="text" ng-model="realm.smtpServer.user" placeholder="Login Username" ng-disabled="!realm.smtpServer.auth" ng-required="realm.smtpServer.auth">
</div>
</div>
<div class="form-group clearfix">
<div class="form-group clearfix" data-ng-show="realm.smtpServer.auth">
<label for="smtpPassword" class="control-label">Password <span class="required" ng-show="realm.smtpServer.auth">*</span></label>
<div class="controls">
<input id="smtpPassword" type="password" ng-model="realm.smtpServer.password" placeholder="Login Password" ng-disabled="!realm.smtpServer.auth" ng-required="realm.smtpServer.auth">

2
admin-ui/src/main/resources/META-INF/resources/admin/partials/realm-social.html
View file

@ -11,7 +11,7 @@
<li><a href="#/realms/{{realm.realm}}/required-credentials">Credentials</a></li>
<li><a href="#/realms/{{realm.realm}}/token-settings">Token</a></li>
<li><a href="#/realms/{{realm.realm}}/keys-settings">Keys</a></li>
<li><a href="#/realms/{{realm.realm}}/smtp-settings">SMTP</a></li>
<li><a href="#/realms/{{realm.realm}}/smtp-settings">Email</a></li>
</ul>
</div>
<div id="content">

2
admin-ui/src/main/resources/META-INF/resources/admin/partials/realm-tokens.html
View file

@ -11,7 +11,7 @@
<li><a href="#/realms/{{realm.realm}}/required-credentials">Credentials</a></li>
<li class="active"><a href="#/realms/{{realm.realm}}/token-settings">Token</a></li>
<li><a href="#/realms/{{realm.realm}}/keys-settings">Keys</a></li>
<li><a href="#/realms/{{realm.realm}}/smtp-settings">SMTP</a></li>
<li><a href="#/realms/{{realm.realm}}/smtp-settings">Email</a></li>
</ul>
</div>
<div id="content">

2
admin-ui/src/main/resources/META-INF/resources/admin/partials/role-detail.html
View file

@ -11,7 +11,7 @@
<li><a href="#/realms/{{realm.realm}}/required-credentials">Credentials</a></li>
<li><a href="#/realms/{{realm.realm}}/token-settings">Token</a></li>
<li><a href="#/realms/{{realm.realm}}/keys-settings">Keys</a></li>
<li><a href="#/realms/{{realm.realm}}/smtp-settings">SMTP</a></li>
<li><a href="#/realms/{{realm.realm}}/smtp-settings">Email</a></li>
</ul>
</div>
<div id="content">

2
admin-ui/src/main/resources/META-INF/resources/admin/partials/role-list.html
View file

@ -11,7 +11,7 @@
<li><a href="#/realms/{{realm.realm}}/required-credentials">Credentials</a></li>
<li><a href="#/realms/{{realm.realm}}/token-settings">Token</a></li>
<li><a href="#/realms/{{realm.realm}}/keys-settings">Keys</a></li>
<li><a href="#/realms/{{realm.realm}}/smtp-settings">SMTP</a></li>
<li><a href="#/realms/{{realm.realm}}/smtp-settings">Email</a></li>
</ul>
</div>
<div id="content">

10
docbook/reference/en/en-US/master.xml
View file

@ -12,6 +12,7 @@
<!ENTITY SocialGoogle SYSTEM "modules/social-google.xml">
<!ENTITY SocialTwitter SYSTEM "modules/social-twitter.xml">
<!ENTITY SocialProviderSPI SYSTEM "modules/social-spi.xml">
<!ENTITY Email SYSTEM "modules/email.xml">
]>
<book>
@ -72,6 +73,15 @@
&SocialProviderSPI;
</chapter>
<chapter>
<title>Email</title>
<para>
Keycloak sends emails to users to verify their email address. Emails are also used to allow users to
safely restore their username and passwords.
</para>
&Email;
</chapter>
</book>

40
docbook/reference/en/en-US/modules/email.xml Normal file
View file

@ -0,0 +1,40 @@
<section id="email-config">
<title>Email Server Config</title>
<para>
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).
</para>
<para>
To configure your SMTP server, open the <literal>Keycloak Admin Console</literal>, select your realm from the drop-down box in the
top-menu, then click on <literal>Email</literal> in the sub-menu.
</para>
<para>
You are required to fill in the <literal>Host</literal> and <literal>Port</literal> for your SMTP server (the default port for SMTP is 25). You also have
to specify the sender email address (<literal>From</literal>). The other options are optional.
</para>
<para>
The screenshot below shows a simple example where the SMTP server doesn't use SSL or TLS and doesn't require authentication.
</para>
<imagedata fileref="images/email-simple-example.png"/>
<section>
<title>Enable SSL or TLS</title>
<para>
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 <literal>Enable SSL</literal> or to enable TLS click on <literal>Enable TLS</literal>.
You will most likely also need to change the <literal>Port</literal> (the default port for SSL/TLS is 465).
</para>
</section>
<section>
<title>Authentication</title>
<para>
If your SMTP server requires authentication click on <literal>Enable Authentication</literal> and insert
the <literal>Username</literal> and <literal>Password</literal>.
</para>
</section>
</section>

BIN
docbook/reference/en/images/email-simple-example.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 15 KiB