From 6a3fc9331aacb0a6b1d7460e52531705122fed75 Mon Sep 17 00:00:00 2001 From: Mauro Mugnaini Date: Wed, 2 Nov 2022 13:32:39 +0100 Subject: [PATCH] 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 --- README.md | 4 +++- avatar-importer/README.md | 6 ++++++ avatar-realm-resource/README.md | 19 ++++++++++++++++++- avatar-storage/README.md | 12 ++++++++++-- delete-account/README.md | 6 ++++++ event-listener-provider/README.md | 6 ++++++ identity-provider-mapper/README.md | 6 ++++++ keycloak-d4science-bundle/README.md | 1 + keycloak-d4science-script/README.md | 6 ++++++ keycloak-d4science-theme/README.md | 6 ++++++ ldap-storage-mapper/README.md | 6 ++++++ 11 files changed, 74 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 3da7bc9..1161077 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,9 @@ The project is a Maven master POM project and it is composed of several modules: * [avatar-storage](avatar-storage/README.md) * [event-listener-provider](event-listener-provider/README.md) * [identity-provider-mapper](identity-provider-mapper/README.md) -* [keycloak-d4science-spi-ear](keycloak-d4science-spi-ear/README.md) +* [keycloak-d4science-spi-ear](keycloak-d4science-spi-ear/README.md) [*** REMOVED from build since the wildfly distribution is no more available ***] +* [keycloak-d4science-theme](keycloak-d4science-theme/README.md) +* [keycloak-d4science-script](keycloak-d4science-script/README.md) * [ldap-storage-mapper](ldap-storage-mapper/README.md) ## Built With diff --git a/avatar-importer/README.md b/avatar-importer/README.md index 39956fd..b291ec9 100644 --- a/avatar-importer/README.md +++ b/avatar-importer/README.md @@ -22,6 +22,12 @@ 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). diff --git a/avatar-realm-resource/README.md b/avatar-realm-resource/README.md index bf0ee84..fd8ddc4 100644 --- a/avatar-realm-resource/README.md +++ b/avatar-realm-resource/README.md @@ -1,6 +1,6 @@ # 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 avatar on file system or in an user's property (to be deeply tested on all the persistence since it could be limited by the JDBC driver/JPA implementation. +**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 @@ -19,6 +19,23 @@ 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](CHANGELOG.md). diff --git a/avatar-storage/README.md b/avatar-storage/README.md index 2e0d3a2..d5a559a 100644 --- a/avatar-storage/README.md +++ b/avatar-storage/README.md @@ -19,7 +19,15 @@ 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: +### 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 @@ -27,7 +35,7 @@ Then, after the module has been installed and the server has been started, you c 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`) +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) diff --git a/delete-account/README.md b/delete-account/README.md index e760314..366a5b5 100644 --- a/delete-account/README.md +++ b/delete-account/README.md @@ -19,6 +19,12 @@ To build the JAR artifact 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). diff --git a/event-listener-provider/README.md b/event-listener-provider/README.md index d9b710a..4aa5d4b 100644 --- a/event-listener-provider/README.md +++ b/event-listener-provider/README.md @@ -19,6 +19,12 @@ To build the 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). diff --git a/identity-provider-mapper/README.md b/identity-provider-mapper/README.md index c38f24e..6b990e3 100644 --- a/identity-provider-mapper/README.md +++ b/identity-provider-mapper/README.md @@ -19,6 +19,12 @@ To build the JAR artifact 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). diff --git a/keycloak-d4science-bundle/README.md b/keycloak-d4science-bundle/README.md index 46e5214..1f8c82f 100644 --- a/keycloak-d4science-bundle/README.md +++ b/keycloak-d4science-bundle/README.md @@ -1,4 +1,5 @@ # Keycloak D4Science Bundle +[*** This module has been removed from build since the wildfly distribution (J2EE) is no more available ***] **Keycloak D4Science Bundle** assembles all the modules in one J2EE EAR ready to be deployed inside a Keycloak installation. diff --git a/keycloak-d4science-script/README.md b/keycloak-d4science-script/README.md index e2f0bc4..b0370f6 100644 --- a/keycloak-d4science-script/README.md +++ b/keycloak-d4science-script/README.md @@ -18,6 +18,12 @@ 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. + ## Change log See [CHANGELOG.md](CHANGELOG.md) file for details diff --git a/keycloak-d4science-theme/README.md b/keycloak-d4science-theme/README.md index 80de29e..93beee0 100644 --- a/keycloak-d4science-theme/README.md +++ b/keycloak-d4science-theme/README.md @@ -22,6 +22,12 @@ 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. + ### Development For details see [Theme section](https://www.keycloak.org/docs/latest/server_development/#_themes) of Keycloak developer docs. diff --git a/ldap-storage-mapper/README.md b/ldap-storage-mapper/README.md index 145a0ba..56ae7e8 100644 --- a/ldap-storage-mapper/README.md +++ b/ldap-storage-mapper/README.md @@ -19,6 +19,12 @@ To build the JAR 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).