diff --git a/jakarta/jaxrs-resource-server/README.md b/jakarta/jaxrs-resource-server/README.md index 208c4c121..40df15d02 100644 --- a/jakarta/jaxrs-resource-server/README.md +++ b/jakarta/jaxrs-resource-server/README.md @@ -1,9 +1,9 @@ jakarta-jaxrs-resource-server: JAX-RS Resource Server =================================================== -Level: Beginner -Technologies: Jakarta EE -Summary: A JAX-RS resource server protected with Wildfly Elytron OIDC +Level: Beginner \ +Technologies: Jakarta EE \ +Summary: A JAX-RS resource server protected with Wildfly Elytron OIDC\ Target Product: Keycloak, WildFly What is it? @@ -30,7 +30,7 @@ Starting and Configuring the Keycloak Server To start a Keycloak Server you can use OpenJDK on Bare Metal, Docker, Openshift or any other option described in [Keycloak Getting Started guides]https://www.keycloak.org/guides#getting-started. For example when using Docker just run the following command in the root directory of this quickstart: ```shell -docker run --name keycloak \ +docker run --name keycloak \ -e KEYCLOAK_ADMIN=admin \ -e KEYCLOAK_ADMIN_PASSWORD=admin \ --network=host \ @@ -45,8 +45,10 @@ You should be able to access your Keycloak Server at http://localhost:8180. Log in as the admin user to access the Keycloak Administration Console. Username should be `admin` and password `admin`. -Import the [realm configuration file](config/realm-import.json) to create a new realm called `quickstart`. -For more details, see the Keycloak documentation about how to [create a new realm](https://www.keycloak.org/docs/latest/server_admin/index.html#_create-realm). +Import the [realm configuration file](config/realm-import.json) to create a new realm called `quickstart`. The easiest way to do this is using the gui. After you click on `Create Realm`, you have the option to choose a Resource JSON file. + +You can also import the realm with cli. +For more details, see the Keycloak documentation about how to [import a realm using cli](https://www.keycloak.org/docs/latest/server_admin/index.html#importing-a-realm-from-exported-json-file) and [create a new realm](https://www.keycloak.org/docs/latest/server_admin/index.html#proc-creating-a-realm_server_administration_guide). Starting the Wildfly Server ------------------- @@ -55,6 +57,8 @@ In order to deploy the example application, you need a Wildfly Server up and run Make sure the server is accessible from `localhost` and listening on port `8080`. +> You no longer need the Keycloak OIDC Client Adapter anymore as `elytron-oidc-client` subsystem has been added to Wildfly 25 + Build and Deploy the Quickstart ------------------------------- @@ -71,9 +75,9 @@ Access the Quickstart There are 3 endpoints exposed by the service: -* http://localhost:8080/service/public - requires no authentication -* http://localhost:8080/service/secured - can be invoked by users with the `user` role -* http://localhost:8080/service/admin - can be invoked by users with the `admin` role +* http://localhost:8080/jakarta-jaxrs-resource-server/public - requires no authentication +* http://localhost:8080/jakarta-jaxrs-resource-server/secured - can be invoked by users with the `user` role +* http://localhost:8080/jakarta-jaxrs-resource-server/admin - can be invoked by users with the `admin` role You can open the public endpoint directly in the browser to test the service. The two other endpoints are protected and require invoking them with a bearer token. diff --git a/jakarta/servlet-authz-client/README.md b/jakarta/servlet-authz-client/README.md index 2ea9369f4..f60bf111c 100644 --- a/jakarta/servlet-authz-client/README.md +++ b/jakarta/servlet-authz-client/README.md @@ -1,9 +1,9 @@ jakarta-servlet-authz-client: Servlet Application Using Fine-grained Authorization ================================================ -Level: Beginner -Technologies: Jakarta EE -Summary: Servlet application protected with Elytron OIDC and Keycloak Authorization Services +Level: Beginner \ +Technologies: Jakarta EE \ +Summary: Servlet application protected with Elytron OIDC and Keycloak Authorization Services \ Target Product: Keycloak, WildFly What is it? @@ -58,8 +58,10 @@ You should be able to access your Keycloak Server at http://localhost:8180. Log in as the admin user to access the Keycloak Administration Console. Username should be `admin` and password `admin`. -Import the [realm configuration file](config/realm-import.json) to create a new realm called `quickstart`. -For more details, see the Keycloak documentation about how to [create a new realm](https://www.keycloak.org/docs/latest/server_admin/index.html#_create-realm). +Import the [realm configuration file](config/realm-import.json) to create a new realm called `quickstart`. The easiest way to do this is using the gui. After you click on `Create Realm`, you have the option to choose a Resource JSON file. + +You can also import the realm with cli. +For more details, see the Keycloak documentation about how to [import a realm using cli](https://www.keycloak.org/docs/latest/server_admin/index.html#importing-a-realm-from-exported-json-file) and [create a new realm](https://www.keycloak.org/docs/latest/server_admin/index.html#proc-creating-a-realm_server_administration_guide). Starting the Wildfly Server ------------------- @@ -68,6 +70,8 @@ In order to deploy the example application, you need a Wildfly Server up and run Make sure the server is accessible from `localhost` and listening on port `8080`. +> You no longer need the Keycloak OIDC Client Adapter anymore as `elytron-oidc-client` subsystem has been added to Wildfly 25 + Build and Deploy the Quickstart ------------------------------- diff --git a/jakarta/servlet-saml-service-provider/README.md b/jakarta/servlet-saml-service-provider/README.md index 2e18c994f..9f450ca84 100755 --- a/jakarta/servlet-saml-service-provider/README.md +++ b/jakarta/servlet-saml-service-provider/README.md @@ -1,9 +1,9 @@ servlet-saml-service-provider: Servlet SAML Service Provider ============================================================= -Level: Beginner -Technologies: JavaEE -Summary: JSP Profile Application +Level: Beginner \ +Technologies: JavaEE \ +Summary: JSP Profile Application \ Target Product: Keycloak, WildFly What is it? @@ -17,9 +17,9 @@ System Requirements To compile and run this quickstart you will need: -* JDK 11 +* JDK 17 * Apache Maven 3.8.6 -* Wildfly 28+ +* Wildfly <= 23 * Keycloak 21+ * Docker 20+ @@ -44,8 +44,10 @@ You should be able to access your Keycloak Server at http://localhost:8180. Log in as the admin user to access the Keycloak Administration Console. Username should be `admin` and password `admin`. -Import the [realm configuration file](config/realm-import.json) to create a new realm called `quickstart`. -For more details, see the Keycloak documentation about how to [create a new realm](https://www.keycloak.org/docs/latest/server_admin/index.html#_create-realm). +Import the [realm configuration file](config/realm-import.json) to create a new realm called `quickstart`. The easiest way to do this is using the gui. After you click on `Create Realm`, you have the option to choose a Resource JSON file. + +You can also import the realm with cli. +For more details, see the Keycloak documentation about how to [import a realm using cli](https://www.keycloak.org/docs/latest/server_admin/index.html#importing-a-realm-from-exported-json-file) and [create a new realm](https://www.keycloak.org/docs/latest/server_admin/index.html#proc-creating-a-realm_server_administration_guide). Starting the Wildfly Server ------------------- @@ -54,6 +56,15 @@ In order to deploy the example application, you need a Wildfly Server up and run Make sure the server is accessible from `localhost` and listening on port `8080`. +Installing the SAML 2.0 Wildfly Adapter +----------------------------------- + +Install the WildFly SAML 2.0 Client Adapter following [this guide](https://www.keycloak.org/docs/latest/securing_apps/index.html#_saml-jboss-adapter-installation). + +> Please consider the supported WildFly version for this adapter + + + Build and Deploy the Quickstart ------------------------------- diff --git a/pom.xml b/pom.xml index a9f04e0e2..9af37330b 100644 --- a/pom.xml +++ b/pom.xml @@ -57,7 +57,7 @@ 2.3.1 true - 1.2.2.Final + 4.1.1.Final ./jboss-cli.sh 10090 3.11.0