Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update description of theme configuration. #124

Merged
merged 1 commit into from
May 23, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions themes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,14 @@ This directory contains the custom Fairspace theme for Keycloak. The theme is ba
The theme is packaged into a Docker image and made available in the Kubernetes setup using init container as theme provider.

More information about the theme setup with Kubernetes and Helm can be found in [Keycloakx Helm chart documentation](https://github.com/codecentric/helm-charts/tree/master/charts/keycloakx#providing-a-custom-theme).

### Selecting Fairspace theme for user login page
To use a Fairspace theme for the user login page, the `fairspace_theme` needs to be selected in the Keycloak admin console,
in the Fairspace client settings.
The theme should be configured under *Client details >> Settings >> Login settings >> Login theme*.

To have the Fairspace logo displayed on the login page, the *HTML Display name* needs to be changed to:
```
<div class="kc-logo-text"><span>Fairspace</span></div>
```
in *Realm settings >> General >> HTML Display name*.