History

Mauro Mugnaini 6368ed3a2d Skipping javadoc creation in all the sub-modules to avoid Jenkins build issue		2023-10-13 16:54:02 +02:00
..
src/main	Added `deleteAvatarImage` method and implementations	2020-08-21 11:07:00 +02: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	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
add-avatar-resource-provider.sh	Added shell declaration	2020-08-13 17:19:12 +02:00
install-keycloak-module.sh	Added filename expansion from template to match every released file	2020-08-13 17:20:01 +02:00
pom.xml	Skipping javadoc creation in all the sub-modules to avoid Jenkins build issue	2023-10-13 16:54:02 +02:00

README.md

Avatar Storage

Avatar Storage defines a new Keycloak's SPI to plug avatar persistence strategy via services definition.

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 module JAR file it is sufficient to type

mvn clean package

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

Then, after the module has been installed and the server has been started, you can enable it with:

add-avatar-resource-provider.sh [host:port]

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)

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]