Deprecated/removed for build the Wildfly/JEE EAR artifact and updated the docs for the Quarkus based deploy and both Wildfly (deprecated) and Quarkus related configs
**Avatar Realm Resource** defines the new avatar resource inside Keycloak and exposes it on REST, implements the SPI defined in the `avatar-storage` module to store avatar on file system or in an user's property (to be deeply tested on all the persistence since it could be limited by the JDBC driver/JPA implementation.
**Avatar Realm Resource** defines the new avatar resource inside Keycloak and exposes it on REST, implements the SPI defined in the `avatar-storage` module to store avatars on file system or in an user's property; the last option is discouraged since the DB's property mapping could be limited by the JDBC driver/JPA settings/DB defaults.
## Structure of the project
@ -19,6 +19,23 @@ To build the JAR artifact it is sufficient to type
mvn clean package
### Installation and configuration
#### Qurkus based Keycloak
In order to deploy the module it is sufficient to copy into the `[keycloak-home]/providers` folder.
If you need to customize the folder where avatars images are saved (defaulting `[user-home]/avatar`) you can add the following line to the `[keycloak-home]/conf/keycloak.conf` file:
( For example: `spi-avatar-storage-avatar-storage-file-avatar-folder=/opt/keycloak/avatar` )
By default the `username` of the user is used as a filename for the image into the filesystem but is possible to use the user's email simply adding the following line in the previously seen configuration file:
@ -19,7 +19,15 @@ To build the module JAR file it is sufficient to type
mvn clean package
The module can be installed inside the locally running Keycloak runtime (when the Keycloak server is stopped) by using the shell file:
### Installation
#### Qurkus based Keycloak
In order to deploy the module it is sufficient to copy into the `[keycloak-home]/providers` folder.
#### Wildfly based Keycloak [DEPRECATED]
The module can be installed inside the locally running Wildfly based Keycloak runtime (when the Keycloak server is stopped) by using the shell file:
install-keycloak-module.sh
@ -27,7 +35,7 @@ Then, after the module has been installed and the server has been started, you c
add-avatar-resource-provider.sh [host:port]
This will make the new defined SPI available in the Keycloak server. The `[host:port]` parameter is optional and defaults to Wildfly control default host and port (`localhost:9990`)
This will make the new defined SPI available in the Wildfly based Keycloak server. The `[host:port]` parameter is optional and defaults to Wildfly control default host and port (`localhost:9990`)
(NOTE: Both commands are using the `$KEYCLOAK_HOME` environment variable to find where Keycloak server is located)
