History

Mauro Mugnaini cba83cc162 Releasing `v.2.0.0` with Keycloak `19.0.2` support		2022-10-24 12:19:55 +02:00
..
src/main	Added `deleteAvatarImage` method and implementations	2020-08-21 11:07:00 +02:00
CHANGELOG.md	Releasing `v.2.0.0` with Keycloak `19.0.2` support	2022-10-24 12:19:55 +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	Wrong title in README.md files	2020-10-26 12:54:36 +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	Releasing `v.2.0.0` with Keycloak `19.0.2` support	2022-10-24 12:19:55 +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

The module can be installed inside the locally running 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 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]