History

Mauro Mugnaini 6a3fc9331a 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		2022-11-02 13:32:39 +01:00
..
src/main	Fixed Java9+ deprecated code	2022-09-30 17:03:01 +02:00
CHANGELOG.md	Prepared for new developing `v2.1.0`: updated to new Keycloak version 20.0.0	2022-11-02 13:30:13 +01:00
FUNDING.md	Completed the refactoring as Maven multi-module project and each project has been documented as the new project template advise. It also provide the avatar support (#19726 )	2020-08-13 16:27:32 +02:00
LICENSE.md	Completed the refactoring as Maven multi-module project and each project has been documented as the new project template advise. It also provide the avatar support (#19726 )	2020-08-13 16:27:32 +02:00
README.md	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	2022-11-02 13:32:39 +01:00
pom.xml	Prepared for new developing `v2.1.0`: updated to new Keycloak version 20.0.0	2022-11-02 13:30:13 +01:00

README.md

Avatar Realm Resource

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

The source code is present in src folder.

Built With

OpenJDK - The JDK used
Maven - Dependency Management

Documentation

This is one of the modules that composes the EAR deployment defined in the "brother" module keycloak-d4science-spi.

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:

spi-avatar-storage-avatar-storage-file-avatar-folder=[full-path-to-the-avatar-folder]

( 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:

spi-avatar-storage-avatar-storage-file-use-email-as-filename=true

Change log

See CHANGELOG.md.

Authors

Mauro Mugnaini (Nubisware S.r.l.)

How to Cite this Software

[Intentionally left blank]

License

This project is licensed under the EUPL V.1.1 License - see the LICENSE.md file for details.

About the gCube Framework

This software is part of the gCubeFramework: an open-source software toolkit used for building and operating Hybrid Data Infrastructures enabling the dynamic deployment of Virtual Research Environments by favouring the realisation of reuse oriented policies.

The projects leading to this software have received funding from a series of European Union programmes see FUNDING.md

Acknowledgments

[Intentionally left blank]