keycloak-d4science-spi-parent/avatar-importer/README.md

# Avatar Importer

**Avatar Importer** extends the [Keycloak](https://www.keycloak.org)'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](https://openjdk.java.net/) - The JDK used
* [Maven](https://maven.apache.org/) - Dependency Management

## Documentation

This is one of the modules that composes the EAR deployment defined in the "brother" module [keycloak-d4science-bundle](../keycloak-d4science-bundle/README.md).

To build the module's 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.

## Change log

See [CHANGELOG.md](CHANGELOG.md).

## Authors

* **Marco Lettere** ([Nubisware S.r.l.](http://www.nubisware.com))
* **Mauro Mugnaini** ([Nubisware S.r.l.](http://www.nubisware.com))

## How to Cite this Software
[Intentionally left blank]

## License

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

## About the gCube Framework
This software is part of the [gCubeFramework](https://www.gcube-system.org/ "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](FUNDING.md)

## Acknowledgments
[Intentionally left blank]
Wrong title in README.md files 2020-10-26 12:54:36 +01:00			`# Avatar Importer`
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
Update 'avatar-importer/README.md' 2022-07-13 10:22:21 +02:00			Avatar Importer extends the [Keycloak](https://www.keycloak.org)'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.
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
			`## 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](https://openjdk.java.net/) - The JDK used`
			`* [Maven](https://maven.apache.org/) - Dependency Management`

			`## Documentation`

Update 'avatar-importer/README.md' 2022-07-13 10:22:21 +02:00			`This is one of the modules that composes the EAR deployment defined in the "brother" module [keycloak-d4science-bundle](../keycloak-d4science-bundle/README.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
			`To build the module's JAR file it is sufficient to type`

			`mvn clean package`

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			`### Installation`

			`#### Qurkus based Keycloak`

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

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			`## Change log`

			`See [CHANGELOG.md](CHANGELOG.md).`

			`## Authors`

			`* Marco Lettere ([Nubisware S.r.l.](http://www.nubisware.com))`
			`* Mauro Mugnaini ([Nubisware S.r.l.](http://www.nubisware.com))`

			`## How to Cite this Software`
			`[Intentionally left blank]`

			`## License`

			`This project is licensed under the EUPL V.1.1 License - see the [LICENSE.md](LICENSE.md) file for details.`

			`## About the gCube Framework`
			`This software is part of the [gCubeFramework](https://www.gcube-system.org/ "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](FUNDING.md)`

			`## Acknowledgments`
			`[Intentionally left blank]`