Skip to content

Latest commit

 

History

History
185 lines (118 loc) · 6.24 KB

README.md

File metadata and controls

185 lines (118 loc) · 6.24 KB
Raw

Kalisio's Keycloak themes

This project brings together a set of Keycloak themes used by Kalisio applications. Just like the applications developed by Kalisio, these themes are based on the use of the Quasar Framework This allows to have the same look & feel between the applications and the different user interfaces provided by Keycloak.

Note

Before going any further, it is essential to understand how themes work in Keycloak and how one can create a theme. Please refer to the official documentation and Apache FreeMarker. You can also read the following articles:

Understanding the KDK theme

The KDK theme extends the Keycloak's base theme with the following types of customization:

  • Login

Important

Other types, such as Account and Admin, can be easily extented from the keycloak.v2 theme and we feel it is not worth providing such custom types in the KDK theme. In the kapp folder, we provide you with an example of customization of these different types.

Login

Login forms specialize a FreeMaker template file, template.ftl, that overwrites the default Keycloak template.ftl file. It is built on Quasar Framework to enable the use of web components that enhance user experience and simplify the use of Keycloak CSS classes.

The provided template.ftl introduces 4 areas, called fragments which can be overwritten by child themes. The following image illustrates the 4 fragments: header, banner, options and footer.

Template fragments

Note

Remember that all these fragments are shared by all the different login forms.

Internationalization

Internationalization is in line with Keycloak's approach.

Consequently, the popup function will attempt to localize the specified file based on the current locale settings using the following schema: <basename>_<locale>.<extension>

Important

If internationalization is disabled, the locale is set to en.

Extending the KDK theme

Minimum file stucture

The minimum file structure you need to create is the following:

my-theme
 └─login
     |_ theme.properties
     └─ resources
        ├─ js
        |   └─ config.js
        └─ img
            └─ logo.png

Note

These informations are used by the default footer.ftl fragment which displays the different version in a tooltip.

theme.properties

The theme.properties file allows setting some configuration for the theme.

A theme.properties file commonly has content like this

parent=kdk 
import=common/keycloak
locales=fr,en
meta=viewport==width=device-width,initial-scale=1

In addition, this theme provides 2 additional variables:

  • version: which allows you to define the version of your theme.
  • kdkVersion: which allows you to define the version of the KDK theme.

Tip

These variables can be useful to customize your CI process.

config.js

The config.js file allows you to configure Quasar by defining a Quasar Config Object.

Tip

Use the Quasar Config Object to define the brand colors to be used in the application.

logo.png

This file represents the application logo.

Tip

The recommended size is about 400x150 pixels.

Overwriting fragments

In addition, one can overwrite each fragments to adapt the page to its current need.You just need to add the desired <fragment>.ftl file in a fragments folder under the login folder.

For instance, if you need to overwrite the options fragment, add options.ftl file as shown below:

my-theme
 ├ login
     |_ theme.properties
     ├─ fragments
     |   └─ options.ftl
     └─ resources
        ├─ theme.json     
        ├─ js
        |   └─ config.js
        └─ img
           └─ logo.png

Helper functions

The KDK theme comes with an the popup function that enables you to display an HTML within a popup.

For example, the following lines allow to open the legal-notice html file when clicking on the button. In that special case, the complete file name will be resolved according the the locale of the browser:

<q-btn flat label="${msg('legalNotice')}" flat no-caps rounded 
  @click="popup('${msg('legalNotice')}', '${url.resourcesPath}/html/legal-notice_${locale.currentLanguageTag}.html')" 
/>

Checking the theme

To check the theme, we recomend to:

  1. create a realm for your application
  2. In Realm Settings, Themes tab, assign the app's theme to the Login theme
  3. Log in to the app: https://<keycloak.url>/realms/<app>/account/#/

Note

In local, the url for the kapp example will be the following: http://localhost:8080/realms/kapp/account/#/

Running Keycloak

We provide a generic Docker compose file to let you run Keycloak locally to check your theme.

Deploying the stack

As simple as that, just type the command:

docker compose up -d

You can now log in to Keycloak:

  1. Go to http://localhost:8080/
  2. Click Administration Console
  3. Login using the following credentials:
  • User: admin
  • Password: Pass;word1

Removing the stack

To remove the stack, simply type the following command:

docker compose up down

Contributing

Found a bug ? Missing a Feature ? Want to contribute ? check out our contribution guidelines for details

License

This project is licensed under the MIT License - see the license file for details

Authors

This project is sponsored by

Kalisio