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

KEYCLOAK-729

Browse source 
Update themes documentation
This commit is contained in:
Stian Thorgersen 2014-10-03 14:11:03 +02:00
parent 777999e0ea
commit 1d66bd9c15
1 changed files with 48 additions and 28 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

76
docbook/reference/en/en-US/modules/themes.xml
View file

@ -6,12 +6,38 @@
and feel of end-user facing pages so they can be integrated with your brand and applications. and feel of end-user facing pages so they can be integrated with your brand and applications.
</para> </para>
<section>
<title>Theme types</title>
<para>
There are several types of themes in Keycloak:
<itemizedlist>
<listitem>Account - Account management</listitem>
<listitem>Admin - Admin console</listitem>
<listitem>Common - Shared resources for themes</listitem>
<listitem>Email - Emails</listitem>
<listitem>Login - Login forms</listitem>
<listitem>Welcome - Welcome pages</listitem>
</itemizedlist>
</para>
</section>
<section> <section>
<title>Configure theme</title> <title>Configure theme</title>
<para> <para>
To configure the theme used by a realm open the <literal>Keycloak Admin Console</literal>, select your realm All theme types, except welcome, is configured through <literal>Keycloak Admin Console</literal>. To change
the theme used for a realm open the open the <literal>Keycloak Admin Console</literal>, select your realm
from the drop-down box in the top left corner. Under <literal>Settings</literal> click on <literal>Theme</literal>. from the drop-down box in the top left corner. Under <literal>Settings</literal> click on <literal>Theme</literal>.
</para> </para>
<para>
To change the welcome theme you need to edit <literal>standalone/configuration/keycloak-server.json</literal>
and add <literal>welcomeTheme</literal> to the theme element, for example:
<programlisting>
"theme": {
...
"welcomeTheme": "custom-theme"
}
</programlisting>
</para>
</section> </section>
<section> <section>
@ -25,26 +51,15 @@
<section> <section>
<title>Creating a theme</title> <title>Creating a theme</title>
<para>
There are several types of themes in Keycloak:
<itemizedlist>
<listitem>Account - Account management</listitem>
<listitem>Admin - Admin console</listitem>
<listitem>Common - Shared resources for themes</listitem>
<listitem>Email - Emails</listitem>
<listitem>Login - Login forms</listitem>
</itemizedlist>
</para>
<para> <para>
A theme consists of: A theme consists of:
<itemizedlist> <itemizedlist>
<listitem><para><ulink url="http://freemarker.org">FreeMarker</ulink> templates</para></listitem> <listitem><ulink url="http://freemarker.org">FreeMarker</ulink> templates</listitem>
<listitem><para>Stylesheets</para></listitem> <listitem>Stylesheets</listitem>
<listitem><para>Scripts</para></listitem> <listitem>Scripts</listitem>
<listitem><para>Images</para></listitem> <listitem>Images</listitem>
<listitem><para>Message bundles</para></listitem> <listitem>Message bundles</listitem>
<listitem><para>Theme properties</para></listitem> <listitem>Theme properties</listitem>
</itemizedlist> </itemizedlist>
</para> </para>
<para> <para>
@ -132,10 +147,9 @@
<section> <section>
<title>Theme SPI</title> <title>Theme SPI</title>
<para> <para>
The Theme SPI allows creating different mechanisms to providing themes for the default FreeMarker based The Theme SPI allows creating different mechanisms to load themes for the default FreeMarker based
implementations of login forms and account management. To create a theme provider you will need to implement implementations of login forms and account management. To create a theme provider you will need to implement
<literal>org.keycloak.freemarker.ThemeProvider</literal> and <literal>org.keycloak.freemarker.Theme</literal> in <literal>org.keycloak.freemarker.ThemeProviderFactory</literal> and <literal>org.keycloak.freemarker.ThemeProvider</literal>.
<literal>forms/common-freemarker</literal>.
</para> </para>
<para> <para>
Keycloak comes with two theme providers, one that loads themes from the classpath (used by default themes) Keycloak comes with two theme providers, one that loads themes from the classpath (used by default themes)
@ -149,12 +163,15 @@
<para> <para>
The Account SPI allows implementing the account management pages using whatever web framework or templating The Account SPI allows implementing the account management pages using whatever web framework or templating
engine you want. To create an Account provider implement <literal>org.keycloak.account.AccountProviderFactory</literal> engine you want. To create an Account provider implement <literal>org.keycloak.account.AccountProviderFactory</literal>
and <literal>org.keycloak.account.AccountProvider</literal> in <literal>forms/account-api</literal>. and <literal>org.keycloak.account.AccountProvider</literal>.
</para> </para>
<para> <para>
Keycloaks default account management provider is built on the FreeMarker template engine (<literal>forms/account-freemarker</literal>). Once you have deployed your account provider to Keycloak you need to configure <literal>keycloak-server.json</literal>to specify which provider should be used:
To make sure your provider is loaded you will either need to delete <literal>standalone/deployments/auth-server.war/WEB-INF/lib/keycloak-account-freemarker-&project.version;.jar</literal> <programlisting>
or disable it with the system property <literal>org.keycloak.account.freemarker.FreeMarkerAccountProviderFactory</literal>. "account": {
"provider": "custom-provider"
}
</programlisting>
</para> </para>
</section> </section>
<section> <section>
@ -165,9 +182,12 @@
and <literal>org.keycloak.login.LoginFormsProvider</literal> in <literal>forms/login-api</literal>. and <literal>org.keycloak.login.LoginFormsProvider</literal> in <literal>forms/login-api</literal>.
</para> </para>
<para> <para>
Keycloaks default login forms provider is built on the FreeMarker template engine (<literal>forms/login-freemarker</literal>). Once you have deployed your account provider to Keycloak you need to configure <literal>keycloak-server.json</literal>to specify which provider should be used:
To make sure your provider is loaded you will either need to delete <literal>standalone/deployments/auth-server.war/WEB-INF/lib/keycloak-login-freemarker-&project.version;.jar</literal> <programlisting>
or disable it with the system property <literal>org.keycloak.login.freemarker.FreeMarkerLoginFormsProviderFactory</literal>. "login": {
"provider": "custom-provider"
}
</programlisting>
</para> </para>
</section> </section>
</section> </section>