[KEYCLOAK-17864] - Improving themes support
This commit is contained in:
Pedro Igor
parent
478319348b
commit
a3a88d7d3c
7 changed files with 43 additions and 20 deletions
|
|
@ -31,10 +31,6 @@
|
|||
<outputDirectory/>
|
||||
<filtered>false</filtered>
|
||||
</fileSet>
|
||||
<fileSet>
|
||||
<directory>target/unpacked-themes/theme</directory>
|
||||
<outputDirectory>themes</outputDirectory>
|
||||
</fileSet>
|
||||
<fileSet>
|
||||
<directory>src/main</directory>
|
||||
<outputDirectory></outputDirectory>
|
||||
|
|
@ -48,6 +44,7 @@
|
|||
<includes>
|
||||
<include>*.*</include>
|
||||
</includes>
|
||||
<filtered>true</filtered>
|
||||
</fileSet>
|
||||
<fileSet>
|
||||
<directory>src/main/content/bin</directory>
|
||||
|
|
|
|||
|
|
@ -1,12 +1,14 @@
|
|||
Keycloak.X
|
||||
==========
|
||||
|
||||
To run on Linux/Unix:
|
||||
|
||||
$ cd bin
|
||||
$ ./kc.sh
|
||||
$ bin/kc.sh
|
||||
|
||||
To run on Windows:
|
||||
|
||||
> ...\bin\kc.bat
|
||||
$ bin\kc.bat
|
||||
|
||||
After the server boots, open http://localhost:8080 in your web browser. The welcome page will indicate that the server is running.
|
||||
After the server boots, open http://localhost:8080 in your web browser. The welcome page will indicate that the server is running.
|
||||
|
||||
To get started, check the [Server Administration Guide](https://www.keycloak.org/docs/latest/server_admin).
|
||||
|
|
@ -1,3 +1,4 @@
|
|||
# Configure the server
|
||||
Configure the server
|
||||
====================
|
||||
|
||||
Use files in this directory to configure the server
|
||||
Use files in this directory to configure the server.
|
||||
|
|
@ -1,9 +1,10 @@
|
|||
# Installing Custom Providers
|
||||
Installing Custom Providers
|
||||
===========================
|
||||
|
||||
You should add to this directory your custom provider JAR files.
|
||||
|
||||
Once you have your providers in this directory you should run the following command to complete the installation:
|
||||
|
||||
```
|
||||
${keycloak.home.dir}/bin/kc.sh config
|
||||
${kc.home.dir}/bin/kc.sh config
|
||||
```
|
||||
24
distribution/server-x-dist/src/main/content/themes/README.md
Normal file
24
distribution/server-x-dist/src/main/content/themes/README.md
Normal file
|
|
@ -0,0 +1,24 @@
|
|||
Creating Themes
|
||||
===============
|
||||
|
||||
Themes are used to configure the look and feel of login pages and the account management console.
|
||||
|
||||
Custom themes packaged in a JAR file should be deployed to the `${kc.home.dir}/providers` directory and you should run
|
||||
the `config` command to install them prior to running the server.
|
||||
|
||||
You should also be able to create your custom themes in this directory, directly. Themes within this directory do not require
|
||||
the `config` command to install them.
|
||||
|
||||
When running the server in development mode, themes are not cached so that you can easily work on them without any need to restart
|
||||
the server when making changes.
|
||||
|
||||
See the theme section in the [Server Developer Guide](https://www.keycloak.org/docs/latest/server_development/#_themes) for more details about how to create custom themes.
|
||||
|
||||
Overriding the built-in templates
|
||||
---------------------------------
|
||||
|
||||
While creating custom themes especially when overriding templates it may be useful to use the built-in templates as
|
||||
a reference. These can be found within the theme directory of `../lib/lib/main/org.keycloak.keycloak-themes-${project.version}.jar`, which can be opened using any
|
||||
standard ZIP archive tool.
|
||||
|
||||
**Built-in themes should not be modified directly, instead a custom theme should be created.**
|
||||
|
|
@ -1,8 +0,0 @@
|
|||
Themes are used to configure the look and feel of login pages and the account management console.
|
||||
|
||||
Built-in themes should not be modified directly, instead a custom theme should be created. See the theme
|
||||
section in the Server Developer Guide for more details.
|
||||
|
||||
While creating custom themes especially when overriding templates it may be useful to use the built-in templates as
|
||||
a reference. These can be found within themes directory of lib/keycloak-runner.jar, which can be opened using any
|
||||
standard ZIP archive tool.
|
||||
|
|
@ -6,10 +6,16 @@ db=h2-file
|
|||
%dev.db.username = sa
|
||||
%dev.db.password = keycloak
|
||||
%dev.cluster=local
|
||||
%dev.spi.theme.cache-themes=false
|
||||
%dev.spi.theme.cache-templates=false
|
||||
%dev.spi.theme.static-max-age=-1
|
||||
|
||||
# Metrics and healthcheck are disabled by default
|
||||
metrics.enabled=false
|
||||
|
||||
# Themes
|
||||
spi.theme.folder.dir=${kc.home.dir:}/themes
|
||||
|
||||
# Logging configuration. INFO is the default level for most of the categories
|
||||
#quarkus.log.level = DEBUG
|
||||
quarkus.log.category."org.jboss.resteasy.resteasy_jaxrs.i18n".level=WARN
|
||||
|
|
|
|||
Loading…
Reference in a new issue