Merge pull request #1213 from stianst/master
Updated instructions on deploying example themes
This commit is contained in:
commit
92db89f9e8
1 changed files with 16 additions and 29 deletions
|
@ -1,54 +1,41 @@
|
|||
Example Themes
|
||||
==============
|
||||
|
||||
Sunrise Login Theme
|
||||
-------------------
|
||||
Deploy Themes
|
||||
-------------
|
||||
|
||||
Example login theme that changes the look of the login forms.
|
||||
You can either deploy the themes by copying to the themes folder or as modules.
|
||||
|
||||
To use the theme you can either deploy it as a module or copy it to the Keycloaks themes folder.
|
||||
### Copy
|
||||
|
||||
To deploy as a module run:
|
||||
Simplest way to deploy the themes is to copy `src/main/resources/theme/*` to `standalone/configuration/themes/`.
|
||||
|
||||
### Module
|
||||
|
||||
Alternatively you can deploy as modules. This can be done by first running:
|
||||
|
||||
mvn clean install
|
||||
$KEYCLOAK_HOME/bin/jboss-cli.sh --command="module add --name=org.keycloak.example.sunrisetheme --resources=target/keycloak-example-themes.jar"
|
||||
$KEYCLOAK_HOME/bin/jboss-cli.sh --command="module add --name=org.keycloak.example.themes --resources=target/keycloak-example-themes.jar"
|
||||
|
||||
Then open $KEYCLOAK_HOME/standalone/configuration/keycloak-server.json and register the theme module by adding:
|
||||
|
||||
"theme": {
|
||||
"module": {
|
||||
"modules": [ "org.keycloak.example.sunrisetheme" ]
|
||||
"modules": [ "org.keycloak.example.themes" ]
|
||||
}
|
||||
}
|
||||
|
||||
Alternatively you can copy `src/main/resources/theme/sunrise` to `standalone/configuration/themes/`.
|
||||
|
||||
Once you've added the theme open the admin console, select your realm, click on `Theme`. In the dropdown for `Login Theme` select `sunrise`. Click `Save` and login to the realm to see the new theme in action.
|
||||
Sunrise Login Theme
|
||||
-------------------
|
||||
|
||||
Example login theme that changes the look of the login forms. To enable the theme open the admin console, select your realm, click on `Theme`. In the dropdown for `Login Theme` select `sunrise`. Click `Save` and login to the realm to see the new theme in action.
|
||||
|
||||
|
||||
Change Logo Theme
|
||||
-----------------
|
||||
|
||||
Example themes for login forms, account management, admin console and welcome pages that changes the Keycloak logo.
|
||||
|
||||
To use the themes you can either deploy it as a module or copy it to the Keycloaks themes folder.
|
||||
|
||||
To deploy as a module run:
|
||||
|
||||
mvn clean install
|
||||
$KEYCLOAK_HOME/bin/jboss-cli.sh --command="module add --name=org.keycloak.example.logotheme --resources=target/keycloak-example-themes.jar"
|
||||
|
||||
Then open $KEYCLOAK_HOME/standalone/configuration/keycloak-server.json and register the theme module by adding:
|
||||
|
||||
"theme": {
|
||||
"module": {
|
||||
"modules": [ "org.keycloak.example.logotheme" ]
|
||||
}
|
||||
}
|
||||
|
||||
Alternatively you can copy `src/main/resources/theme/logo-example` to `standalone/configuration/themes/`.
|
||||
|
||||
Once you've added the theme open the admin console, select your realm, click on `Theme`. In the dropdowns for `Login Theme`, `Account Theme` and `Admin Console Theme` select `logo-example`. Click `Save` and login to the realm to see the new theme in action.
|
||||
To enable the theme open the admin console, select your realm, click on `Theme`. In the dropdowns for `Login Theme`, `Account Theme` and `Admin Console Theme` select `logo-example`. Click `Save` and login to the realm to see the new theme in action.
|
||||
|
||||
To change the theme for the welcome pages open `standalone/configuration/keycloak-server.json` find the config for `theme` and add 'welcomeTheme':
|
||||
|
||||
|
|
Loading…
Reference in a new issue