From e5366cb95eb503e68cc06119c2a51bb6a3a42832 Mon Sep 17 00:00:00 2001 From: ase-101 Date: Mon, 2 Dec 2024 00:31:35 +0530 Subject: [PATCH] ES-1856 Signed-off-by: ase-101 --- docker-compose/README.md | 22 ++++++++++++++-------- 1 file changed, 14 insertions(+), 8 deletions(-) diff --git a/docker-compose/README.md b/docker-compose/README.md index 7da8a84ea..3c3c51e80 100644 --- a/docker-compose/README.md +++ b/docker-compose/README.md @@ -6,10 +6,10 @@ This is the docker compose setup to run esignet UI and esignet-service with mock 1. Open terminal and go to "docker-compose" folder. 2. Run `docker compose --file dependent-docker-compose.yml up` to start all the dependent services. -2. Go to command line for the project root directory and run `mvn clean install -Dgpg.skip=true -DskipTests=true` -3. Add [esignet-mock-plugin.jar](../esignet-service/target/esignet-plugins/esignet-mock-plugin.jar) to esignet-service classpath in your IDE. -4. Start the [EsignetServiceApplication.java](../esignet-service/src/main/java/io/mosip/esignet/EsignetServiceApplication.java) from your IDE. -5. Import files under [postman-collection](../postman-collection) folder into your postman to test/validate OIDC flow. +3. Go to command line for the project root directory and run `mvn clean install -Dgpg.skip=true -DskipTests=true` +4. Add [esignet-mock-plugin.jar](../esignet-service/target/esignet-plugins/esignet-mock-plugin.jar) to esignet-service classpath in your IDE. +5. Start the [EsignetServiceApplication.java](../esignet-service/src/main/java/io/mosip/esignet/EsignetServiceApplication.java) from your IDE. +6. Import files under [postman-collection](../postman-collection) folder into your postman to test/validate OIDC flow. ## How to bring up the complete eSignet setup for a Demo? @@ -18,12 +18,18 @@ This is the docker compose setup to run esignet UI and esignet-service with mock 3. Access eSignet UI at http://localhost:3000 4. Access eSignet backend services at http://localhost:8088/v1/esignet/swagger-ui.html 5. Onboard relying party in eSignet, import all files under [postman-collection](../postman-collection) folder into your postman. Choose `eSignet-with-mock` environment in the postman and invoke below requests under `OIDC Client Mgmt` -> `Mock` folder in postman. - a. `Get CSRF token` - b. `Create OIDC client` -> Make sure to update redirect Urls and logo URL as per your requirement in the request body. + + a. `Get CSRF token` + + b. `Create OIDC client` -> Make sure to update redirect Urls and logo URL as per your requirement in the request body. + 6. Copy the client ID in the `Create OIDC client` response. 7. Add a `SignIn with eSignet` button in the relying party website and embed [eSignet authorize URL](http://localhost:3000/authorize?nonce=ere973eieljznge2311&state=eree2311&client_id=client_id&redirect_uri=redirect_uri&scope=openid&response_type=code&acr_values=mosip:idp:acr:generated-code&claims_locales=en&ui_locales=en-IN) in the button. Update the below query parameter in the eSignet authorize URL before embedding in the button. - a. client_id -> value should be replace with the value copied in the step 6 - b. redirect_uri -> As updated in step 5 + + a. `client_id` -> value should be replace with the value copied in the step 6 + + b. `redirect_uri` -> As updated in step 5 + 8. Add a user in the mock-identity-system. Invoke `Creat User` request under `User Mgmt` -> `Mock` folder in the postman. 9. Now the setup is completely ready to start the OIDC flow. [Refer eSignet user guides](https://docs.esignet.io/end-user-guide) for more information.