Keycloakify
HomeGitHubStorybookAlternative to keycloak-js
v11
  • Documentation
  • Release Notes & Upgrade Instructions
  • FAQ
v11
  • Quick Start
  • CSS Customization
  • Testing your Theme
    • Outside of Keycloak
    • Inside of Keycloak
  • Deploying Your Theme
  • Integrating Keycloakify in your Codebase
    • Vite
    • Create-React-App / Webpack
    • yarn/npm/pnpm/bun Workspaces
    • Turborepo
    • Nx
    • Angular Workspace
  • Common Use Case Examples
    • Using a Component Library
    • Custom Fonts
    • Changing the background image
    • Adding your Logo
    • Using Tailwind
    • Dark Mode Persistence
  • Features
    • Internationalization and Translations
      • Basic principles
      • Previewing Your Pages in Different Languages
      • Adding New Translation Messages or Changing the Default Ones
      • Adding Support for Extra Languages
    • Theme Variants
    • Environment Variables
    • Styling a Custom Page Not Included in Base Keycloak
    • Integrating an Existing Theme into Your Keycloakify Project
    • Compiler Options
      • --project
      • keycloakVersionTargets
      • environmentVariables
      • themeName
      • startKeycloakOptions
      • themeVersion
      • accountThemeImplementation
      • postBuild
      • XDG_CACHE_HOME
      • kcContextExclusionsFtl
      • keycloakifyBuildDirPath
      • groupId
      • artifactId
      • Webpack specific options
        • projectBuildDirPath
        • staticDirPathInProjectBuildDirPath
        • publicDirPath
  • Page-Specific Guides
    • Registration Page
    • Terms and Conditions Page
  • Theme types
    • Differences Between Login Themes and Other Types of Themes
    • Account Theme
      • Single-Page
      • Multi-Page
    • Email Theme
    • Admin Theme
Powered by GitBook
On this page
  • Using keycloakify-emails
  • Using FreeMarker
  • Using assets in native email theme

Was this helpful?

Edit on GitHub
  1. Theme types

Email Theme

Last updated 3 months ago

Was this helpful?

There are two ways you can create a Keycloak Email theme with Keycloakify

Using keycloakify-emails

is a Keycloakify plugin that enable to create an email theme using or any other email templating solution.

This plugin will evenutally be integrated to Keycloakify core.

This approach only works in Vite project. So not with Webpack/Create-React-App

yarn add keycloakify-emails jsx-email

yarn add keycloakify-emails @keycloakify/svelte-email

Using FreeMarker

npx keycloakify initialize-email-theme, select the native option.

Running this command will initialize a native email theme in the src/email directory.

Using assets in native email theme

To use images you can put them into src/email/resources/ example:

And then you can import them using the FreeMarker varialble url.resourcesUrl. Example:

For more instruction on how to configure Keycloak to send emails .

see this video
keycloakify-email
jsx-email
GitHub - garronej/keycloakify-emails at email_dir_locationGitHub
Logo
kc-logo.png in src/email/resources
Using kc-logo.png