Document email template customization feature #9

This commit is contained in:
garronej 2022-04-20 20:40:40 +02:00
parent f2b7fe46a2
commit 2ad5ed7e73

View File

@ -72,6 +72,7 @@ If you already have a Keycloak custom theme, it can be easily ported to Keycloak
- [Advanced pages configuration](#advanced-pages-configuration) - [Advanced pages configuration](#advanced-pages-configuration)
- [Hot reload](#hot-reload) - [Hot reload](#hot-reload)
- [Enable loading in a blink of an eye of login pages ⚡ (--external-assets)](#enable-loading-in-a-blink-of-an-eye-of-login-pages----external-assets) - [Enable loading in a blink of an eye of login pages ⚡ (--external-assets)](#enable-loading-in-a-blink-of-an-eye-of-login-pages----external-assets)
- [Email template customization.](#email-template-customization)
- [User profile and frontend form validation](#user-profile-and-frontend-form-validation) - [User profile and frontend form validation](#user-profile-and-frontend-form-validation)
- [Support for Terms and conditions](#support-for-terms-and-conditions) - [Support for Terms and conditions](#support-for-terms-and-conditions)
- [Some pages still have the default theme. Why?](#some-pages-still-have-the-default-theme-why) - [Some pages still have the default theme. Why?](#some-pages-still-have-the-default-theme-why)
@ -309,6 +310,19 @@ performance boost if you jump through those hoops:
Checkout a complete setup [here](https://github.com/garronej/keycloakify-demo-app#about-keycloakify) Checkout a complete setup [here](https://github.com/garronej/keycloakify-demo-app#about-keycloakify)
# Email template customization.
_Introduced in [v4.8.0](https://github.com/InseeFrLab/keycloakify/releases/tag/v4.8.0)_
It is now possible to customize the emails sent to your users to confirm their email address ect.
Just run `npx create-keycloak-theme-email-directory`, it will create a `keycloak_theme_email` directory
at the root of your project.
This directory should be tracked by Git (`yarn add -A`)
You can start hacking the default template.
When `npx build-keycloak-theme` (`yarn keycloak`) is run. If the directory `keycloak_theme_email` exists
at the root of your project, it will be bundled into your `.jar` file and you will be able to select
it [in the Keycloak administration pages](https://user-images.githubusercontent.com/6702424/164299589-75f8008b-b24e-4836-ad6b-72149bb55621.png).
# User profile and frontend form validation # User profile and frontend form validation
<p align="center"> <p align="center">