https://github.com/vshn/keycloak-theme
VSHN Keycloak IDP Theme
https://github.com/vshn/keycloak-theme
vshn-project-ignore
Last synced: 2 months ago
JSON representation
VSHN Keycloak IDP Theme
- Host: GitHub
- URL: https://github.com/vshn/keycloak-theme
- Owner: vshn
- License: bsd-3-clause
- Created: 2021-07-29T14:24:07.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2025-03-13T17:43:43.000Z (3 months ago)
- Last Synced: 2025-03-19T13:44:58.289Z (2 months ago)
- Topics: vshn-project-ignore
- Language: CSS
- Homepage:
- Size: 1.36 MB
- Stars: 1
- Watchers: 11
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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
1. Tag it with
```bash
git tag -am v1.x.y v1.x.y
git push --tags
```
1. This will trigger the GitHub Action and pushes the image to https://quay.io/repository/vshn/keycloak-theme?tab=tags
1. Add the tag of the version to your extraInitContainers ([see codecentric helm chart documentation](https://github.com/codecentric/helm-charts/blob/master/charts/keycloak/README.md#providing-a-custom-theme))
```yaml
extraInitContainers: |
- name: theme-provider
image: quay.io/vshn/keycloak-theme:v1.x.x
```
1. If you plan to use a redirect for the welcome page, then ensure you set `REDIRECT_URL` as environment variable