keycloak-theme

VSHN Keycloak IDP Theme

Local Development

docker compose up to start a local Keycloak with the VSHN theme.

Configure the Themes

By default, the themes are already set in the keycloak/master.json file. This is the realm configuration file that is imported at startup.

If you want to change the theme, you can do so in the admin console, under Realm Settings -> Themes.

If the theme is not available in the dropdown, it usually means that it is not valid. (Except for the admin console, currently no custom theme is available)

You can export the realm via the admin console. This export does not include secrets, but since we only have one admin user, it is not a problem.

Deploy to Your Instance

1. Merge your Pull Request to master branch
2. Tag it with

   git tag -am v1.x.y v1.x.y
   git push --tags

3. This will trigger the GitHub Action and pushes the image to https://quay.io/repository/vshn/keycloak-theme?tab=tags
4. Add the tag of the version to your extraInitContainers (see codecentric helm chart documentation)

   extraInitContainers: |
     - name: theme-provider
       image: quay.io/vshn/keycloak-theme:v1.x.x

5. If you plan to use a redirect for the welcome page, then ensure you set REDIRECT_URL as environment variable