History

Mauro Mugnaini e89c9adcd4 Moved from `commons-lang` to `commons-lang3` artifactId in `org.apache.commons` groupId		2024-03-27 15:01:37 +01:00
..
src	Moved from `commons-lang` to `commons-lang3` artifactId in `org.apache.commons` groupId	2024-03-27 15:01:37 +01:00
CHANGELOG.md	Prepating for 2.2.0-SNAPSHOT release with `maven-parent-1.2.0`, `keycloak-parent-22.0.4` and switch to JDK17	2023-10-09 17:10:28 +02: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	Fixed/updated documentation	2023-10-10 15:40:40 +02:00
pom.xml	Moved from `commons-lang` to `commons-lang3` artifactId in `org.apache.commons` groupId	2024-03-27 15:01:37 +01:00

README.md

Avatar Importer

Avatar Importer extends the Keycloak's Identity Provider (IdP) mapper SPI to import the avatar image from the IdP used for the login by default; if no image is provided by the IdP in the proper claim the importer can be set-up (enabled by default) to try to load the avatar using the libravatar (and gravatar) service.

Structure of the project

The source code is present in src folder.

Relevant information about how the repository is organized.
Description of the Maven modules (if any).
Any information needed to work with the code.

Built With

OpenJDK - The JDK used
Maven - Dependency Management

Documentation

This is one of the modules that composes the (DEPRECATED) EAR deployment defined in the "brother" module keycloak-d4science-bundle.

To build the module's JAR file it is sufficient to type

mvn clean package

Installation

Quarkus based Keycloak

In order to deploy the module it is sufficient to copy into the [keycloak-home]/providers folder.

Configuration

Once deployed, the mapper must be enabled for the realm in the specific Identity Provider Mappers.

Specific settings are present:

Use Libravatar service: Enable or not the avatar discovery on the libravatar (gravatar) service
Import avatar in a separate thread: the import of the avatar will be performed asynch in a separate thread to improve speed during a new identity import

Change log

See CHANGELOG.md.

Authors

Marco Lettere (Nubisware S.r.l.)
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]