From fecd694d4ab4360e65069d4668b41712816c3892 Mon Sep 17 00:00:00 2001 From: kameshsr Date: Fri, 12 Dec 2025 18:37:48 +0530 Subject: [PATCH 01/12] MOSIP-37256 corrected readme Signed-off-by: kameshsr --- README.md | 187 ++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 182 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index d15709cc11..aeb76f85f4 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,186 @@ -[![Maven Package upon a push](https://github.com/mosip/mosip-ref-impl/actions/workflows/push-trigger.yml/badge.svg?branch=release-1.3.x)](https://github.com/mosip/mosip-ref-impl/actions/workflows/push-trigger.yml) +# MOSIP Ref Impl -# Mosip Ref Impl +[![Maven Package upon a push](https://github.com/mosip/mosip-ref-impl/actions/workflows/push-trigger.yml/badge.svg?branch=master)](https://github.com/mosip/mosip-ref-impl/actions/workflows/push-trigger.yml) +[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=mosip-ref-impl&id=mosip-ref-impl&metric=alert_status)](https://sonarcloud.io/dashboard?id=mosip-ref-impl) -## About -This repository contains components that can be customized by a country. For example, pre-registration-ui that builds on top of the Pre-Registration services can be customized by a country as per their needs. +## Overview +The MOSIP Reference Implementation (Ref Impl) repository contains country-specific customizations and implementations that extend the core MOSIP platform. It serves as a reference for how different countries can adapt and implement MOSIP according to their unique requirements and regulations. + +## Services + +The mosip-ref-impl contains the following services: + +1. **[cache-provider-hazelcast](https://github.com/mosip/mosip-ref-impl/tree/master/cache-provider-hazelcast)** - Hazelcast based cache provider implementation +2. **[cache-provider-redis](https://github.com/mosip/mosip-ref-impl/tree/master/cache-provider-redis)** - Redis based cache provider implementation +3. **[kernel](https://github.com/mosip/mosip-ref-impl/tree/master/kernel)** - MOSIP Kernel implementation for Ref Impl +4. **[keycloak](https://github.com/mosip/mosip-ref-impl/tree/master/keycloak)** - Keycloak customizations for Ref Impl +5. **[pre-registration-booking-service](https://github.com/mosip/mosip-ref-impl/tree/master/pre-registration-booking-service)** - Pre-registration booking service implementation +6. **[registration-processor](https://github.com/mosip/mosip-ref-impl/tree/master/registration-processor)** - Registration processor implementation + +## Local Setup + +The project can be set up in two ways: + +1. [Local Setup (for Development or Contribution)](#local-setup-for-development-or-contribution) +2. [Local Setup with Docker (Easy Setup for Demos)](#local-setup-with-docker-easy-setup-for-demos) + +### Prerequisites + +Before you begin, ensure you have the following installed: + +- **JDK**: 21.0.3 +- **Maven**: 3.9.6 +- **Docker**: Latest stable version +- **PostgreSQL**: 10.2 +- **Keycloak**: [Check here](https://github.com/mosip/keycloak) + +### Runtime Dependencies + +- Add `kernel-auth-adapter.jar` to the classpath, or include it as a Maven dependency — [Download](https://oss.sonatype.org/#nexus-search;gav~~kernel-auth-adapter~1.3.0-SNAPSHOT~~) + +### Configuration + +- This module uses the following configuration files that are accessible in this [repository](https://github.com/mosip/mosip-config/tree/master). + Please refer to the required released tagged version for configuration. + [Configuration-registration](https://github.com/mosip/mosip-config/blob/master/registration-default.properties) and + [Configuration-Application](https://github.com/mosip/mosip-config/blob/master/application-default.properties) are defined here. You need to run the config-server along with the files mentioned above. +- For generating clients, refer to MOSIP’s documentation here: [Client Generation Guide](https://docs.mosip.io/1.2.0/interoperability/integrations/mosip-crvs/approach/technical-details#id-1.-create-client-id-role-for-the-crvs) +- To authenticate a client, use the Auth Manager API as described here: [Auth API Documentation](https://docs.mosip.io/1.2.0/interoperability/integrations/mosip-crvs/approach/technical-details#id-2.-fetch-access-token-to-call-the-apis) + +#### Required Configuration Properties + +The following properties must be configured with your environment-specific values before deployment: + +**Database Configuration:** +- `mosip.registration.processor.database.hostname` - Database hostname (default: postgres-postgresql.postgres) +- `mosip.registration.processor.database.port` - Database port (default: 5432) +- `db.dbuser.password` - Database user password (passed as environment variable) + +**IAM/Keycloak Configuration:** +- `keycloak.internal.url` - Internal Keycloak URL (passed as environment variable) +- `keycloak.external.url` - External Keycloak URL (passed as environment variable) +- `mosip.regproc.client.secret` - Registration processor client secret (passed as environment variable) + +**Service URLs:** +- `mosip.kernel.authmanager.url` - Auth manager service URL +- `mosip.kernel.keymanager.url` - Key manager service URL +- `mosip.kernel.masterdata.url` - Masterdata service URL +- `mosip.kernel.notification.url` - Notification service URL +- `mosip.idrepo.identity.url` - ID repository identity service URL +- `mosip.api.internal.url` - Internal API base URL + +**Note**: +- **If using config-server**: Properties marked as environment variables (e.g., `db.dbuser.password`, `keycloak.internal.url`, `keycloak.external.url`, `mosip.admin.client.secret`, `mosip.regproc.client.secret`) must be passed through the config-server's 'overrides' environment variables and should NOT be defined in property files. Refer to the config-server helm chart for more details. +- **If using application properties directly**: Update these properties directly in your `application.properties` or `admin-default.properties` file with your environment-specific values. + +## Installation + +### Local Setup (for Development or Contribution) + +1. Make sure the config server is running. For detailed instructions on setting up and running the config server, refer to the [MOSIP Config Server Setup Guide](https://docs.mosip.io/1.2.0/modules/registration-processor/registration-processor-developers-guide#environment-setup). + +**Note**: Refer to the MOSIP Config Server Setup Guide for setup, and ensure the properties mentioned above in the configuration section are taken care of. Replace the properties with your own configurations (e.g., DB credentials, IAM credentials, URL). + +2. Clone the repository: + +```text +git clone +cd service-name +``` + +3. Build the project: + +```text +mvn clean install -Dmaven.javadoc.skip=true -Dgpg.skip=true +``` + +4. Start the application: + - Click the Run button in your IDE, or + - Run via command: `java -jar target/specific-service:<$version>.jar` + +5. Verify Swagger is accessible at: `http://localhost:8080/v1/admin/swagger-ui/index.html` + +### Local Setup with Docker (Easy Setup for Demos) + +#### Option 1: Pull from Docker Hub + +Recommended for users who want a quick, ready-to-use setup — testers, students, and external users. + +Pull the latest pre-built images from Docker Hub using the following commands: + +```text +docker pull mosipid/pre-registration-booking-service:1.2.0.2 +``` + +#### Option 2: Build Docker Images Locally + +Recommended for contributors or developers who want to modify or build the services from source. + +1. Clone and build the project: + +```text +git clone +cd service name +mvn clean install -Dmaven.javadoc.skip=true -Dgpg.skip=true +``` + +2. Navigate to each service directory and build the Docker image: + +```text +cd service-name/ +docker build -t . +``` + +#### Running the Services + +Start each service using Docker: + +```text +docker run -d -p : --name +``` + +#### Verify Installation + +Check that all containers are running: + +```text +docker ps +``` + +Access the services at `http://localhost:` using the port mappings listed above. + +## Deployment + +### Kubernetes + +To deploy mosip ref impl services on a Kubernetes cluster, refer to the [Sandbox Deployment Guide](https://docs.mosip.io/1.2.0/deploymentnew/v3-installation). + +## Usage + +### Pre-reg UI + +For the complete Admin UI implementation and usage instructions, refer to the [Prereg UI GitHub repository](https://github.com/mosip/pre-registration-ui). + +## Documentation + +For more detailed documents for repositories, you can [check here](https://github.com/mosip/documentation/tree/1.2.0/docs). + +### API Documentation + +API endpoints, base URL, and mock server details are available via Stoplight and Swagger documentation: [MOSIP Admin Service API Documentation](https://mosip.github.io/documentation/1.2.0/admin-service.html). + +### Product Documentation + +To learn more about admin services from a functional perspective and use case scenarios, refer to our main documentation: [Click here](https://docs.mosip.io/1.2.0/id-lifecycle-management/support-systems/administration). + +## Contribution & Community + +• To learn how you can contribute code to this application, [click here](https://docs.mosip.io/1.2.0/community/code-contributions). + +• If you have questions or encounter issues, visit the [MOSIP Community](https://community.mosip.io/) for support. + +• For any GitHub issues: [Report here](https://github.com/mosip/mosip-ref-impl/issues) ## License -This project is licensed under the terms of [Mozilla Public License 2.0](LICENSE). + +This project is licensed under the [Mozilla Public License 2.0](LICENSE). From 27e509da4debd2eee633aadb86e8e01987cf382b Mon Sep 17 00:00:00 2001 From: kameshsr Date: Tue, 16 Dec 2025 14:11:48 +0530 Subject: [PATCH 02/12] MOSIP-37256 corrected readme Signed-off-by: kameshsr --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index aeb76f85f4..71a8ef2324 100644 --- a/README.md +++ b/README.md @@ -70,8 +70,8 @@ The following properties must be configured with your environment-specific value - `mosip.api.internal.url` - Internal API base URL **Note**: -- **If using config-server**: Properties marked as environment variables (e.g., `db.dbuser.password`, `keycloak.internal.url`, `keycloak.external.url`, `mosip.admin.client.secret`, `mosip.regproc.client.secret`) must be passed through the config-server's 'overrides' environment variables and should NOT be defined in property files. Refer to the config-server helm chart for more details. -- **If using application properties directly**: Update these properties directly in your `application.properties` or `admin-default.properties` file with your environment-specific values. +- **If using config-server**: Properties marked as environment variables (e.g., `db.dbuser.password`, `keycloak.internal.url`, `keycloak.external.url`, `mosip.regproc.client.secret`) must be passed through the config-server's 'overrides' environment variables and should NOT be defined in property files. Refer to the config-server helm chart for more details. +- **If using application properties directly**: Update these properties directly in your `application.properties` file with your environment-specific values. ## Installation @@ -98,7 +98,7 @@ mvn clean install -Dmaven.javadoc.skip=true -Dgpg.skip=true - Click the Run button in your IDE, or - Run via command: `java -jar target/specific-service:<$version>.jar` -5. Verify Swagger is accessible at: `http://localhost:8080/v1/admin/swagger-ui/index.html` +5. Verify Swagger is accessible at: `http://localhost:9095/preregistration/v1/swagger-ui/index.html` ### Local Setup with Docker (Easy Setup for Demos) @@ -159,7 +159,7 @@ To deploy mosip ref impl services on a Kubernetes cluster, refer to the [Sandbox ### Pre-reg UI -For the complete Admin UI implementation and usage instructions, refer to the [Prereg UI GitHub repository](https://github.com/mosip/pre-registration-ui). +For the complete Pre-reg UI implementation and usage instructions, refer to the [Prereg UI GitHub repository](https://github.com/mosip/pre-registration-ui). ## Documentation @@ -167,11 +167,11 @@ For more detailed documents for repositories, you can [check here](https://githu ### API Documentation -API endpoints, base URL, and mock server details are available via Stoplight and Swagger documentation: [MOSIP Admin Service API Documentation](https://mosip.github.io/documentation/1.2.0/admin-service.html). +API endpoints, base URL, and mock server details are available via Stoplight and Swagger documentation: [MOSIP Pre-Registration Service API Documentation](https://mosip.github.io/documentation/1.2.0/pre-registration-booking-service.html). ### Product Documentation -To learn more about admin services from a functional perspective and use case scenarios, refer to our main documentation: [Click here](https://docs.mosip.io/1.2.0/id-lifecycle-management/support-systems/administration). +To learn more about pre-reg services from a functional perspective and use case scenarios, refer to our main documentation: [Click here](https://docs.mosip.io/1.2.0/id-lifecycle-management/support-systems/administration). ## Contribution & Community From 021d5f598e36138403a688a809118ca6c2900b73 Mon Sep 17 00:00:00 2001 From: kameshsr Date: Tue, 16 Dec 2025 14:14:35 +0530 Subject: [PATCH 03/12] MOSIP-37256 corrected readme Signed-off-by: kameshsr --- README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/README.md b/README.md index 71a8ef2324..1150690c39 100644 --- a/README.md +++ b/README.md @@ -40,12 +40,10 @@ Before you begin, ensure you have the following installed: ### Configuration -- This module uses the following configuration files that are accessible in this [repository](https://github.com/mosip/mosip-config/tree/master). +- This module uses the following configuration files that are accessible in this [mosip-config repository](https://github.com/mosip/mosip-config/tree/master). Please refer to the required released tagged version for configuration. [Configuration-registration](https://github.com/mosip/mosip-config/blob/master/registration-default.properties) and [Configuration-Application](https://github.com/mosip/mosip-config/blob/master/application-default.properties) are defined here. You need to run the config-server along with the files mentioned above. -- For generating clients, refer to MOSIP’s documentation here: [Client Generation Guide](https://docs.mosip.io/1.2.0/interoperability/integrations/mosip-crvs/approach/technical-details#id-1.-create-client-id-role-for-the-crvs) -- To authenticate a client, use the Auth Manager API as described here: [Auth API Documentation](https://docs.mosip.io/1.2.0/interoperability/integrations/mosip-crvs/approach/technical-details#id-2.-fetch-access-token-to-call-the-apis) #### Required Configuration Properties From 9a64b6dd4813fa829510aa80fbe11a0232862fef Mon Sep 17 00:00:00 2001 From: kameshsr Date: Wed, 17 Dec 2025 10:04:20 +0530 Subject: [PATCH 04/12] MOSIP-37256 Corrected link Signed-off-by: kameshsr --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1150690c39..511f76df1c 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # MOSIP Ref Impl [![Maven Package upon a push](https://github.com/mosip/mosip-ref-impl/actions/workflows/push-trigger.yml/badge.svg?branch=master)](https://github.com/mosip/mosip-ref-impl/actions/workflows/push-trigger.yml) -[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=mosip-ref-impl&id=mosip-ref-impl&metric=alert_status)](https://sonarcloud.io/dashboard?id=mosip-ref-impl) - +[![Quality Gate Status](https://sonarcloud.io/summary/new_code?id=mosip_kernel-ref-idobjectvalidator&branch=release-1.3.x&metric=alert_status)](https://sonarcloud.io/dashboard?id=mosip_kernel-ref-idobjectvalidator) +[![Quality Gate Status](https://sonarcloud.io/summary/new_code?id=mosip_pre-registration-booking-service&branch=release-1.3.x&metric=alert_status)](https://sonarcloud.io/dashboard?id=mosip_pre-registration-booking-service) ## Overview The MOSIP Reference Implementation (Ref Impl) repository contains country-specific customizations and implementations that extend the core MOSIP platform. It serves as a reference for how different countries can adapt and implement MOSIP according to their unique requirements and regulations. From 24b481cd16c55bff8d56ac93c700b46f06366cfa Mon Sep 17 00:00:00 2001 From: kameshsr Date: Wed, 17 Dec 2025 10:13:50 +0530 Subject: [PATCH 05/12] MOSIP-37256 Corrected link Signed-off-by: kameshsr --- README.md | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 511f76df1c..e7d3f9835b 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# MOSIP Ref Impl +# MOSIP Reference Implementation [![Maven Package upon a push](https://github.com/mosip/mosip-ref-impl/actions/workflows/push-trigger.yml/badge.svg?branch=master)](https://github.com/mosip/mosip-ref-impl/actions/workflows/push-trigger.yml) [![Quality Gate Status](https://sonarcloud.io/summary/new_code?id=mosip_kernel-ref-idobjectvalidator&branch=release-1.3.x&metric=alert_status)](https://sonarcloud.io/dashboard?id=mosip_kernel-ref-idobjectvalidator) @@ -10,12 +10,17 @@ The MOSIP Reference Implementation (Ref Impl) repository contains country-specif The mosip-ref-impl contains the following services: -1. **[cache-provider-hazelcast](https://github.com/mosip/mosip-ref-impl/tree/master/cache-provider-hazelcast)** - Hazelcast based cache provider implementation -2. **[cache-provider-redis](https://github.com/mosip/mosip-ref-impl/tree/master/cache-provider-redis)** - Redis based cache provider implementation -3. **[kernel](https://github.com/mosip/mosip-ref-impl/tree/master/kernel)** - MOSIP Kernel implementation for Ref Impl -4. **[keycloak](https://github.com/mosip/mosip-ref-impl/tree/master/keycloak)** - Keycloak customizations for Ref Impl -5. **[pre-registration-booking-service](https://github.com/mosip/mosip-ref-impl/tree/master/pre-registration-booking-service)** - Pre-registration booking service implementation -6. **[registration-processor](https://github.com/mosip/mosip-ref-impl/tree/master/registration-processor)** - Registration processor implementation +1. **[cache-provider-hazelcast](cache-provider-hazelcast)** - Hazelcast based cache provider Reference implementation +2. **[cache-provider-redis](cache-provider-redis)** - Redis based cache provider Reference implementation +3. **[kernel](kernel)** - MOSIP Kernel implementation for Reference Impl + a. **[kernel-ref-idobjectvalidator](kernel/kernel-ref-idobjectvalidator)** - ID Object Validator module for Reference Impl + b. **[kernel-smsserviceprovider-msg91](kernel/kernel-smsserviceprovider-msg91)** - MSG91 SMS Service Provider module for Reference Impl + c. **[kernel-virusscanner-clamav](kernel/kernel-virusscanner-clamav)** - ClamAV Virus Scanner module for Reference Impl +4. **[keycloak](keycloak)** - Keycloak customizations for Reference Impl +5. **[pre-registration-booking-service](pre-registration-booking-service)** - Pre-registration booking service Reference implementation +6. **[registration-processor](registration-processor)** - Registration processor Reference implementation + a. **[registration-processor-external-integration-service](registration-processor/registration-processor-external-integration-service)** - External Integration Service module for Reference Impl + b. **[registration-processor-external-stage](registration-processor/registration-processor-external-stage)** - External Stage module for Reference Impl ## Local Setup From b287324c5d8c62fd10713a4762d4d92fde366bd3 Mon Sep 17 00:00:00 2001 From: kameshsr Date: Wed, 17 Dec 2025 10:20:45 +0530 Subject: [PATCH 06/12] MOSIP-37256 Corrected link Signed-off-by: kameshsr --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e7d3f9835b..ba9be801ba 100644 --- a/README.md +++ b/README.md @@ -36,8 +36,8 @@ Before you begin, ensure you have the following installed: - **JDK**: 21.0.3 - **Maven**: 3.9.6 - **Docker**: Latest stable version -- **PostgreSQL**: 10.2 -- **Keycloak**: [Check here](https://github.com/mosip/keycloak) +- **PostgreSQL**: 16.0 +- **Keycloak**: [Check here](https://github.com/mosip/keycloak/tree/master) ### Runtime Dependencies From 3b64d96ad82bc25bb521982815cd3a49ee09c9ba Mon Sep 17 00:00:00 2001 From: kameshsr Date: Wed, 17 Dec 2025 10:31:54 +0530 Subject: [PATCH 07/12] MOSIP-37256 Corrected link Signed-off-by: kameshsr --- README.md | 19 ++++++++----------- 1 file changed, 8 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index ba9be801ba..f3f308145e 100644 --- a/README.md +++ b/README.md @@ -41,13 +41,14 @@ Before you begin, ensure you have the following installed: ### Runtime Dependencies -- Add `kernel-auth-adapter.jar` to the classpath, or include it as a Maven dependency — [Download](https://oss.sonatype.org/#nexus-search;gav~~kernel-auth-adapter~1.3.0-SNAPSHOT~~) +- Add `kernel-auth-adapter.jar` to the classpath, or include it as a Maven dependency in your `pom.xml`. ### Configuration - This module uses the following configuration files that are accessible in this [mosip-config repository](https://github.com/mosip/mosip-config/tree/master). Please refer to the required released tagged version for configuration. [Configuration-registration](https://github.com/mosip/mosip-config/blob/master/registration-default.properties) and +- [Configuration-pre-registration](https://github.com/mosip/mosip-config/blob/master/pre-registration-default.properties) and [Configuration-Application](https://github.com/mosip/mosip-config/blob/master/application-default.properties) are defined here. You need to run the config-server along with the files mentioned above. #### Required Configuration Properties @@ -72,10 +73,6 @@ The following properties must be configured with your environment-specific value - `mosip.idrepo.identity.url` - ID repository identity service URL - `mosip.api.internal.url` - Internal API base URL -**Note**: -- **If using config-server**: Properties marked as environment variables (e.g., `db.dbuser.password`, `keycloak.internal.url`, `keycloak.external.url`, `mosip.regproc.client.secret`) must be passed through the config-server's 'overrides' environment variables and should NOT be defined in property files. Refer to the config-server helm chart for more details. -- **If using application properties directly**: Update these properties directly in your `application.properties` file with your environment-specific values. - ## Installation ### Local Setup (for Development or Contribution) @@ -88,7 +85,7 @@ The following properties must be configured with your environment-specific value ```text git clone -cd service-name +cd ``` 3. Build the project: @@ -101,7 +98,7 @@ mvn clean install -Dmaven.javadoc.skip=true -Dgpg.skip=true - Click the Run button in your IDE, or - Run via command: `java -jar target/specific-service:<$version>.jar` -5. Verify Swagger is accessible at: `http://localhost:9095/preregistration/v1/swagger-ui/index.html` +5. Verify Swagger is accessible at: `http://localhost:${server.port}/${server.servlet.path}/swagger-ui/index.html` ### Local Setup with Docker (Easy Setup for Demos) @@ -112,7 +109,7 @@ Recommended for users who want a quick, ready-to-use setup — testers, students Pull the latest pre-built images from Docker Hub using the following commands: ```text -docker pull mosipid/pre-registration-booking-service:1.2.0.2 +docker pull mosipid/pre-registration-booking-service:1.3.0 ``` #### Option 2: Build Docker Images Locally @@ -123,14 +120,14 @@ Recommended for contributors or developers who want to modify or build the servi ```text git clone -cd service name +cd mvn clean install -Dmaven.javadoc.skip=true -Dgpg.skip=true ``` 2. Navigate to each service directory and build the Docker image: ```text -cd service-name/ +cd / docker build -t . ``` @@ -174,7 +171,7 @@ API endpoints, base URL, and mock server details are available via Stoplight and ### Product Documentation -To learn more about pre-reg services from a functional perspective and use case scenarios, refer to our main documentation: [Click here](https://docs.mosip.io/1.2.0/id-lifecycle-management/support-systems/administration). +To learn more about pre-reg services from a functional perspective and use case scenarios, refer to our main documentation: [Click here](https://docs.mosip.io/1.2.0/modules/pre-registration). ## Contribution & Community From 60aa8f98e1d40381dd8532e4943c0d29d48f66e0 Mon Sep 17 00:00:00 2001 From: kameshsr Date: Wed, 17 Dec 2025 12:49:33 +0530 Subject: [PATCH 08/12] MOSIP-37256 corrected readme Signed-off-by: kameshsr --- README.md | 35 ++++++++++++++++++----------------- 1 file changed, 18 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index f3f308145e..eae8da6afc 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,7 @@ # MOSIP Reference Implementation [![Maven Package upon a push](https://github.com/mosip/mosip-ref-impl/actions/workflows/push-trigger.yml/badge.svg?branch=master)](https://github.com/mosip/mosip-ref-impl/actions/workflows/push-trigger.yml) -[![Quality Gate Status](https://sonarcloud.io/summary/new_code?id=mosip_kernel-ref-idobjectvalidator&branch=release-1.3.x&metric=alert_status)](https://sonarcloud.io/dashboard?id=mosip_kernel-ref-idobjectvalidator) -[![Quality Gate Status](https://sonarcloud.io/summary/new_code?id=mosip_pre-registration-booking-service&branch=release-1.3.x&metric=alert_status)](https://sonarcloud.io/dashboard?id=mosip_pre-registration-booking-service) + ## Overview The MOSIP Reference Implementation (Ref Impl) repository contains country-specific customizations and implementations that extend the core MOSIP platform. It serves as a reference for how different countries can adapt and implement MOSIP according to their unique requirements and regulations. @@ -10,17 +9,17 @@ The MOSIP Reference Implementation (Ref Impl) repository contains country-specif The mosip-ref-impl contains the following services: -1. **[cache-provider-hazelcast](cache-provider-hazelcast)** - Hazelcast based cache provider Reference implementation -2. **[cache-provider-redis](cache-provider-redis)** - Redis based cache provider Reference implementation -3. **[kernel](kernel)** - MOSIP Kernel implementation for Reference Impl - a. **[kernel-ref-idobjectvalidator](kernel/kernel-ref-idobjectvalidator)** - ID Object Validator module for Reference Impl - b. **[kernel-smsserviceprovider-msg91](kernel/kernel-smsserviceprovider-msg91)** - MSG91 SMS Service Provider module for Reference Impl - c. **[kernel-virusscanner-clamav](kernel/kernel-virusscanner-clamav)** - ClamAV Virus Scanner module for Reference Impl -4. **[keycloak](keycloak)** - Keycloak customizations for Reference Impl -5. **[pre-registration-booking-service](pre-registration-booking-service)** - Pre-registration booking service Reference implementation -6. **[registration-processor](registration-processor)** - Registration processor Reference implementation - a. **[registration-processor-external-integration-service](registration-processor/registration-processor-external-integration-service)** - External Integration Service module for Reference Impl - b. **[registration-processor-external-stage](registration-processor/registration-processor-external-stage)** - External Stage module for Reference Impl +1. **[cache-provider-hazelcast](cache-provider-hazelcast)** : Hazelcast based cache provider Reference implementation +2. **[cache-provider-redis](cache-provider-redis)** : Redis based cache provider Reference implementation +3. **[kernel](kernel)** : Reference implementation for core libraries + - **[kernel-ref-idobjectvalidator](kernel/kernel-ref-idobjectvalidator)** : Reference implementation for ID Object Validator + - **[kernel-smsserviceprovider-msg91](kernel/kernel-smsserviceprovider-msg91)** : Reference implementation for msg91 SMS Service Provider + - **[kernel-virusscanner-clamav](kernel/kernel-virusscanner-clamav)** : Reference implementation for clamv Virus Scanner +4. **[keycloak](keycloak)** : Reference implementation for keycloak +5. **[pre-registration-booking-service](pre-registration-booking-service)** : Reference implementation for pre-registration booking service. +6. **[registration-processor](registration-processor)** : Reference implementation for registration processor external integration. + - **[registration-processor-external-integration-service](registration-processor/registration-processor-external-integration-service)** : Reference implementation for external integration service. + - **[registration-processor-external-stage](registration-processor/registration-processor-external-stage)** : Reference implementation for external stage. ## Local Setup @@ -41,14 +40,16 @@ Before you begin, ensure you have the following installed: ### Runtime Dependencies -- Add `kernel-auth-adapter.jar` to the classpath, or include it as a Maven dependency in your `pom.xml`. +Add the below dependencies to the classpath, or include it as a Maven dependency in your `pom.xml`. +- `kernel-auth-adapter.jar` +- `kernel-ref-idobjectvalidator.jar` ### Configuration - This module uses the following configuration files that are accessible in this [mosip-config repository](https://github.com/mosip/mosip-config/tree/master). Please refer to the required released tagged version for configuration. - [Configuration-registration](https://github.com/mosip/mosip-config/blob/master/registration-default.properties) and -- [Configuration-pre-registration](https://github.com/mosip/mosip-config/blob/master/pre-registration-default.properties) and + [Configuration-registration](https://github.com/mosip/mosip-config/blob/master/registration-default.properties), + [Configuration-pre-registration](https://github.com/mosip/mosip-config/blob/master/pre-registration-default.properties) and [Configuration-Application](https://github.com/mosip/mosip-config/blob/master/application-default.properties) are defined here. You need to run the config-server along with the files mentioned above. #### Required Configuration Properties @@ -98,7 +99,7 @@ mvn clean install -Dmaven.javadoc.skip=true -Dgpg.skip=true - Click the Run button in your IDE, or - Run via command: `java -jar target/specific-service:<$version>.jar` -5. Verify Swagger is accessible at: `http://localhost:${server.port}/${server.servlet.path}/swagger-ui/index.html` +5. Verify Swagger is accessible. ### Local Setup with Docker (Easy Setup for Demos) From d7c53e9ea14e5d00c90098954f6d23707fe1e268 Mon Sep 17 00:00:00 2001 From: kameshsr Date: Wed, 17 Dec 2025 12:55:01 +0530 Subject: [PATCH 09/12] MOSIP-37256 corrected readme Signed-off-by: kameshsr --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index eae8da6afc..c1a57961c6 100644 --- a/README.md +++ b/README.md @@ -47,10 +47,10 @@ Add the below dependencies to the classpath, or include it as a Maven dependency ### Configuration - This module uses the following configuration files that are accessible in this [mosip-config repository](https://github.com/mosip/mosip-config/tree/master). - Please refer to the required released tagged version for configuration. - [Configuration-registration](https://github.com/mosip/mosip-config/blob/master/registration-default.properties), - [Configuration-pre-registration](https://github.com/mosip/mosip-config/blob/master/pre-registration-default.properties) and - [Configuration-Application](https://github.com/mosip/mosip-config/blob/master/application-default.properties) are defined here. You need to run the config-server along with the files mentioned above. + Please refer to the required released tagged version for configuration: + - [Configuration-registration](https://github.com/mosip/mosip-config/blob/master/registration-default.properties), + [Configuration-pre-registration](https://github.com/mosip/mosip-config/blob/master/pre-registration-default.properties) and + [Configuration-Application](https://github.com/mosip/mosip-config/blob/master/application-default.properties) are defined here. You need to run the config-server along with the files mentioned above. #### Required Configuration Properties From 552dd1e4f221f6687d5c304ca8609ea846c3c5ea Mon Sep 17 00:00:00 2001 From: kameshsr Date: Wed, 17 Dec 2025 16:23:08 +0530 Subject: [PATCH 10/12] MOSIP-37256 Corrected readme Signed-off-by: kameshsr --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c1a57961c6..364802bc1c 100644 --- a/README.md +++ b/README.md @@ -164,7 +164,10 @@ For the complete Pre-reg UI implementation and usage instructions, refer to the ## Documentation -For more detailed documents for repositories, you can [check here](https://github.com/mosip/documentation/tree/1.2.0/docs). +For more detailed documents check below links: +- [Registration Processor](https://docs.mosip.io/1.2.0/setup/implementations/reference-implementations#registration-processor) +- [Pre-Registration Booking Service](https://docs.mosip.io/1.2.0/setup/implementations/reference-implementations#pre-registration) +- [Common components](https://docs.mosip.io/1.2.0/setup/implementations/reference-implementations#common-components) ### API Documentation From 2f10e9374dd31b669fcedb768c49d2aa1f09a34c Mon Sep 17 00:00:00 2001 From: kameshsr Date: Wed, 17 Dec 2025 16:26:52 +0530 Subject: [PATCH 11/12] MOSIP-37256 Corrected readme Signed-off-by: kameshsr --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 364802bc1c..5e70237f18 100644 --- a/README.md +++ b/README.md @@ -165,8 +165,9 @@ For the complete Pre-reg UI implementation and usage instructions, refer to the ## Documentation For more detailed documents check below links: -- [Registration Processor](https://docs.mosip.io/1.2.0/setup/implementations/reference-implementations#registration-processor) -- [Pre-Registration Booking Service](https://docs.mosip.io/1.2.0/setup/implementations/reference-implementations#pre-registration) +- [Registration Processor](https://docs.mosip.io/1.2.0/id-lifecycle-management/identity-issuance/registration-processor/overview) +- [Pre-Registration](https://docs.mosip.io/1.2.0/id-lifecycle-management/identity-issuance/pre-registration) +- [keycloak](https://docs.mosip.io/1.2.0/id-lifecycle-management/supporting-components/keycloak) - [Common components](https://docs.mosip.io/1.2.0/setup/implementations/reference-implementations#common-components) ### API Documentation From e0a6eaf7fd55e9383a978d0e3b8a43b65174e887 Mon Sep 17 00:00:00 2001 From: kameshsr Date: Thu, 18 Dec 2025 10:31:16 +0530 Subject: [PATCH 12/12] MOSIP-37256 corrected readme Signed-off-by: kameshsr --- README.md | 19 ++++++------------- 1 file changed, 6 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 5e70237f18..9501acbdd3 100644 --- a/README.md +++ b/README.md @@ -156,28 +156,21 @@ Access the services at `http://localhost:` using the port mappings listed To deploy mosip ref impl services on a Kubernetes cluster, refer to the [Sandbox Deployment Guide](https://docs.mosip.io/1.2.0/deploymentnew/v3-installation). -## Usage - -### Pre-reg UI +## Documentation -For the complete Pre-reg UI implementation and usage instructions, refer to the [Prereg UI GitHub repository](https://github.com/mosip/pre-registration-ui). +### API Documentation -## Documentation +API endpoints, base URL, and mock server details are available via Stoplight and Swagger documentation for below services: +- **[Registration Processor External Integration Service API Documentation](https://mosip.github.io/documentation/1.2.0/registration-processor-external-integration-service.html)**. +- **[Pre-Registration Booking Service API Documentation](https://mosip.github.io/documentation/1.2.0/pre-registration-booking-service.html)**. +### Product Documentation For more detailed documents check below links: - [Registration Processor](https://docs.mosip.io/1.2.0/id-lifecycle-management/identity-issuance/registration-processor/overview) - [Pre-Registration](https://docs.mosip.io/1.2.0/id-lifecycle-management/identity-issuance/pre-registration) - [keycloak](https://docs.mosip.io/1.2.0/id-lifecycle-management/supporting-components/keycloak) - [Common components](https://docs.mosip.io/1.2.0/setup/implementations/reference-implementations#common-components) -### API Documentation - -API endpoints, base URL, and mock server details are available via Stoplight and Swagger documentation: [MOSIP Pre-Registration Service API Documentation](https://mosip.github.io/documentation/1.2.0/pre-registration-booking-service.html). - -### Product Documentation - -To learn more about pre-reg services from a functional perspective and use case scenarios, refer to our main documentation: [Click here](https://docs.mosip.io/1.2.0/modules/pre-registration). - ## Contribution & Community • To learn how you can contribute code to this application, [click here](https://docs.mosip.io/1.2.0/community/code-contributions).