From 2446d9f6f5d55af06354611fa26586e7c9f35c6a Mon Sep 17 00:00:00 2001 From: Dhanendra Sahu Date: Tue, 16 Dec 2025 10:59:03 +0530 Subject: [PATCH 1/6] Added readme Signed-off-by: Dhanendra Sahu --- README.md | 227 +++++++++++++++++++++++++++++++++++++++++------------- 1 file changed, 172 insertions(+), 55 deletions(-) diff --git a/README.md b/README.md index 6913783a5c8..a81d46c41b7 100644 --- a/README.md +++ b/README.md @@ -1,61 +1,178 @@ +# MOSIP Commons + [![Maven Package upon a push](https://github.com/mosip/commons/actions/workflows/push-trigger.yml/badge.svg?branch=release-1.3.x)](https://github.com/mosip/commons/actions/workflows/push-trigger.yml) -[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=mosip_commons&metric=alert_status)](https://sonarcloud.io/dashboard?branch=release-1.3.x&id=mosip_commons) +[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=mosip_commons&metric=alert_status)](https://sonarcloud.io/dashboard?id=mosip_commons) + +## Overview +**MOSIP Commons** is a collection of foundational libraries and +utilities used across all MOSIP microservices.\ +It provides core building blocks such as cryptography, authentication +adapters, auditing utilities, key management, QR generation, OTP +handling, exception frameworks, HTTP utilities, logging, and more. -# Commons +These modules provides foundational, reusable, and infrastructure-level services required across the MOSIP ecosystem. +These services support configuration management, ID generation, notifications, and cryptographic salt generation. -## Overview -As the name suggests, Commons refers to all the common services (also called "kernel") that are used by other modules of MOSIP. - -## Databases -Refer to [SQL scripts](db_scripts). - -## Build & run (for developers) -The project requires JDK 21.0.3. -and mvn version - 3.9.6 -1. Build and install: - ``` - $ cd kernel - $ mvn install -DskipTests=true -Dmaven.javadoc.skip=true -Dgpg.skip=true - ``` -1. Build Docker for a service: - ``` - $ cd - $ docker build -f Dockerfile - ``` -## Deployment in K8 cluster with other MOSIP services: -### Pre-requisites -* Set KUBECONFIG variable to point to existing K8 cluster kubeconfig file: - * ``` - export KUBECONFIG=~/.kube/ - ``` -### Install - ``` - $ cd deploy - $ ./install.sh - ``` -### Delete - ``` - $ cd deploy - $ ./delete.sh - ``` -### Restart - ``` - $ cd deploy - $ ./restart.sh - ``` - - -## Deploy -To deploy Commons-Services on Kubernetes cluster using Dockers refer to [Sandbox Deployment](https://docs.mosip.io/1.2.0/deploymentnew/v3-installation). - -## Test -Automated functional tests available in [Functional Tests repo](https://github.com/mosip/mosip-functional-tests). - -## APIs -API documentation is available [here](https://mosip.github.io/documentation/1.2.0/1.2.0.html). - -## License -This project is licensed under the terms of [Mozilla Public License 2.0](LICENSE). +Commons acts as a backbone layer enabling consistency, reliability, and standardization across MOSIP services such as Registration Processor, Admin Services, and ID Repository. + +For detailed documentation, refer to the **official MOSIP documentation**: https://docs.mosip.io + +--- + +# Services + +The following core services are part of MOSIP Commons: + +--- + +## 1. Kernel Notification Service +**Path:** `kernel/kernel-notification-service` +**Purpose:** Centralized notification service for sending messages such as SMS, email, and system alerts. + +### Key Features +- Multi-channel notification support +- Template-driven messaging +- Asynchronous delivery +- Retry and fallback support +- Pluggable provider architecture +- Widely used across MOSIP modules + +--- + +## 2. Kernel Config Server +**Path:** `kernel/kernel-config-server` +**Purpose:** Centralized configuration service used by all MOSIP microservices. + +### Key Features +- Git-backed configuration management +- Environment-specific configuration loading +- Ensures consistent runtime configuration +- Required before launching MOSIP services + +--- + +## 3. Kernel RID Generator Service +**Path:** `kernel/kernel-ridgenerator-service` +**Purpose:** Generates globally unique Registration IDs (RID) for the MOSIP Registration Processor. + +### Key Features +- Guaranteed uniqueness +- High-performance ID generation +- Stateless and reliable + +--- + +## 4. Kernel ID Generator Service +**Path:** `kernel/kernel-idgenerator-service` +**Purpose:** Generates unique IDs required across MOSIP services. + +### Key Features +- Plug-and-play ID generation strategies +- High throughput +- Collision-free generation + +--- + +## 5. Kernel PRID Generator Service +**Path:** `kernel/kernel-pridgenerator-service` +**Purpose:** Generates Pre-Registration IDs (PRID) for MOSIP Pre-Registration flows. + +### Key Features +- Fast ID generation +- Stateless operation +- Ensures consistent PRID format + +--- + +## 6. Kernel Salt Generator +**Path:** `kernel/kernel-salt-generator` +**Purpose:** Generates cryptographically strong salts for securing sensitive data. + +### Key Features +- High entropy salt generation +- Used in hashing processes +- Enhances data integrity and protection + +--- + +# Configuration + +All Commons services rely on centralized configuration from the MOSIP Config Server. + +Required configuration files: + +- **kernel-default.properties** +- **application-default.properties** + +These must exist in the MOSIP Config repository: +https://github.com/mosip/mosip-config + +> **Note:** Config Server must be running before starting any Commons service. + +--- + +# Local Setup + +## Prerequisites +- **JDK:** 21 +- **Maven:** 3.9+ +- **Docker:** Latest +- **PostgreSQL:** 10+ +- **Keycloak/IDP:** Required for notification authentication +- **Config Server** with correct property files + +--- + +## Build Steps + +### 1. Clone the Repository +```sh +git clone https://github.com/mosip/commons.git +cd commons +``` + +### 2. Build with Maven +```sh +mvn clean install -Dmaven.javadoc.skip=true -Dgpg.skip=true +``` + +### 3. Run a Service +```sh +java -jar /target/ +``` + +**Example:** +```sh +java -jar kernel/kernel-notification-service/target/kernel-notification-service.jar +``` + +--- + +# Deployment + +Commons services can be deployed on Docker and Kubernetes. +Refer to the MOSIP Deployment Guide: +https://docs.mosip.io/1.2.0/deploymentnew/v3-installation + +--- + +# Documentation + +- Main MOSIP Docs: https://docs.mosip.io +- API Docs: https://mosip.github.io/documentation +- Commons Repo Docs: https://github.com/mosip/commons + +--- + +# Contribution & Community + +- Contribution Guide: https://docs.mosip.io/1.2.0/community/code-contributions +- Community Forum: https://community.mosip.io/ +- Issue Tracker: https://github.com/mosip/commons/issues + +--- +# License +Licensed under the **Mozilla Public License 2.0**. From 62c504316148d3d2a4e134a533b532724efdef13 Mon Sep 17 00:00:00 2001 From: Dhanendra Sahu Date: Tue, 16 Dec 2025 12:29:09 +0530 Subject: [PATCH 2/6] Updated readme Signed-off-by: Dhanendra Sahu --- README.md | 87 ++++++++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 79 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index a81d46c41b7..8fa51dbbf25 100644 --- a/README.md +++ b/README.md @@ -96,22 +96,93 @@ The following core services are part of MOSIP Commons: --- -# Configuration +# Required Configuration -All Commons services rely on centralized configuration from the MOSIP Config Server. +MOSIP Commons services obtain their configuration from the **MOSIP Config Server**. +Configuration is centrally managed to ensure consistency across environments. -Required configuration files: +Only the **minimum required configuration** is documented here. -- **kernel-default.properties** -- **application-default.properties** +--- -These must exist in the MOSIP Config repository: -https://github.com/mosip/mosip-config +### Configuration Files -> **Note:** Config Server must be running before starting any Commons service. +The following configuration files are required and must be available in the MOSIP Config repository: + +- `kernel-default.properties` +- `application-default.properties` + +--- + +### Configuration via Config Server Overrides + +Certain sensitive and environment-specific properties **must not be defined in property files**. +These values are provided to the Config Server using **override environment variables**, as defined in the Config Server Helm chart. + +**The following properties must be supplied via overrides:** + +- `db.dbuser.password` +- `keycloak.internal.url` +- `keycloak.external.url` +- `keycloak.admin.password` +- `mosip.auth.client.secret` +- `mosip.ida.client.secret` +- `mosip.admin.client.secret` +- `mosip.reg.client.secret` +- `mosip.prereg.client.secret` +- `softhsm.kernel.security.pin` +- `email.smtp.host` +- `email.smtp.username` +- `email.smtp.secret` +- `mosip.api.internal.url` --- +### Common Database Configuration + +```properties +mosip.kernel.database.hostname=postgres-postgresql.postgres +mosip.kernel.database.port=5432 +``` + +--- + +### Kernel Config Server + +```properties +spring.application.name=kernel-config-server +``` + +The Config Server must be running before starting any Commons service. + +--- + +### Notification Service + +```properties +mosip.kernel.sms.enabled=true +mosip.kernel.notification.email.from=do-not-reply@mosip.io +``` + +--- + +### ID / RID / PRID Generator Services + +```properties +mosip.kernel.prid.min-unused-threshold=1000 +mosip.kernel.prid.prids-to-generate=2000 +``` + +--- + +### Key and Salt Management + +```properties +mosip.kernel.keymanager.hsm.keystore-type=PKCS11 +``` +> **Note:** Config Server must be running before starting any Commons service. +--- + # Local Setup ## Prerequisites From d49d1773ef74ebfb3f5709c784fd44a35026356a Mon Sep 17 00:00:00 2001 From: Dhanendra Sahu Date: Wed, 17 Dec 2025 14:16:53 +0530 Subject: [PATCH 3/6] Modified the README.md based on review comments Signed-off-by: Dhanendra Sahu --- README.md | 196 +++++++++--------------------------------------------- 1 file changed, 30 insertions(+), 166 deletions(-) diff --git a/README.md b/README.md index 8fa51dbbf25..4bfe80cf62d 100644 --- a/README.md +++ b/README.md @@ -5,19 +5,10 @@ ## Overview -**MOSIP Commons** is a collection of foundational libraries and -utilities used across all MOSIP microservices.\ -It provides core building blocks such as cryptography, authentication -adapters, auditing utilities, key management, QR generation, OTP -handling, exception frameworks, HTTP utilities, logging, and more. +**MOSIP Commons** is a collection of foundational libraries used across all MOSIP microservices. -These modules provides foundational, reusable, and infrastructure-level services required across the MOSIP ecosystem. These services support configuration management, ID generation, notifications, and cryptographic salt generation. -Commons acts as a backbone layer enabling consistency, reliability, and standardization across MOSIP services such as Registration Processor, Admin Services, and ID Repository. - -For detailed documentation, refer to the **official MOSIP documentation**: https://docs.mosip.io - --- # Services @@ -26,162 +17,27 @@ The following core services are part of MOSIP Commons: --- -## 1. Kernel Notification Service -**Path:** `kernel/kernel-notification-service` -**Purpose:** Centralized notification service for sending messages such as SMS, email, and system alerts. - -### Key Features -- Multi-channel notification support -- Template-driven messaging -- Asynchronous delivery -- Retry and fallback support -- Pluggable provider architecture -- Widely used across MOSIP modules - ---- - -## 2. Kernel Config Server -**Path:** `kernel/kernel-config-server` -**Purpose:** Centralized configuration service used by all MOSIP microservices. - -### Key Features -- Git-backed configuration management -- Environment-specific configuration loading -- Ensures consistent runtime configuration -- Required before launching MOSIP services - ---- - -## 3. Kernel RID Generator Service -**Path:** `kernel/kernel-ridgenerator-service` -**Purpose:** Generates globally unique Registration IDs (RID) for the MOSIP Registration Processor. - -### Key Features -- Guaranteed uniqueness -- High-performance ID generation -- Stateless and reliable - ---- - -## 4. Kernel ID Generator Service -**Path:** `kernel/kernel-idgenerator-service` -**Purpose:** Generates unique IDs required across MOSIP services. - -### Key Features -- Plug-and-play ID generation strategies -- High throughput -- Collision-free generation - ---- - -## 5. Kernel PRID Generator Service -**Path:** `kernel/kernel-pridgenerator-service` -**Purpose:** Generates Pre-Registration IDs (PRID) for MOSIP Pre-Registration flows. - -### Key Features -- Fast ID generation -- Stateless operation -- Ensures consistent PRID format +1. **[Kernel Notification Service](https://github.com/mosip/commons/tree/release-1.3.x/kernel/kernel-notification-service)** - Centralized notification service for sending messages such as SMS, email, and system alerts. +2. **[Kernel Config Server](https://github.com/mosip/commons/tree/release-1.3.x/kernel/kernel-config-server)** - Centralized configuration service used by all MOSIP microservices. +3. **[Kernel RID Generator Service](https://github.com/mosip/commons/tree/release-1.3.x/kernel/kernel-ridgenerator-servic)** - Generates globally unique Registration IDs (RID) for the MOSIP Registration Processor. +4. **[Kernel ID Generator Service](https://github.com/mosip/commons/tree/release-1.3.x/kernel/kernel-idgenerator-servic)** - Generates unique IDs required across MOSIP service. +5. **[Kernel PRID Generator Service](https://github.com/mosip/commons/tree/release-1.3.x/kernel/kernel-pridgenerator-servic)** - Generates Pre-Registration IDs (PRID) for MOSIP Pre-Registration flows. +6. **[Kernel Salt Generator](https://github.com/mosip/commons/tree/release-1.3.x/kernel/kernel-salt-generator)** - Generates cryptographically strong salts for securing sensitive data. --- -## 6. Kernel Salt Generator -**Path:** `kernel/kernel-salt-generator` -**Purpose:** Generates cryptographically strong salts for securing sensitive data. - -### Key Features -- High entropy salt generation -- Used in hashing processes -- Enhances data integrity and protection - --- # Required Configuration -MOSIP Commons services obtain their configuration from the **MOSIP Config Server**. -Configuration is centrally managed to ensure consistency across environments. - -Only the **minimum required configuration** is documented here. - ---- - -### Configuration Files - -The following configuration files are required and must be available in the MOSIP Config repository: - -- `kernel-default.properties` -- `application-default.properties` - ---- - -### Configuration via Config Server Overrides +### Configuration -Certain sensitive and environment-specific properties **must not be defined in property files**. -These values are provided to the Config Server using **override environment variables**, as defined in the Config Server Helm chart. +Common 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. +- [application-default.properties](https://github.com/mosip/mosip-config/blob/master/application-default.properties) : Contains common configurations which are required across MOSIP modules. +- [kernel-default.properties](https://github.com/mosip/mosip-config/blob/master/kernel-default.properties) : Contains configurations required or to be overridden for Common module. -**The following properties must be supplied via overrides:** -- `db.dbuser.password` -- `keycloak.internal.url` -- `keycloak.external.url` -- `keycloak.admin.password` -- `mosip.auth.client.secret` -- `mosip.ida.client.secret` -- `mosip.admin.client.secret` -- `mosip.reg.client.secret` -- `mosip.prereg.client.secret` -- `softhsm.kernel.security.pin` -- `email.smtp.host` -- `email.smtp.username` -- `email.smtp.secret` -- `mosip.api.internal.url` - ---- - -### Common Database Configuration - -```properties -mosip.kernel.database.hostname=postgres-postgresql.postgres -mosip.kernel.database.port=5432 -``` - ---- - -### Kernel Config Server - -```properties -spring.application.name=kernel-config-server -``` - -The Config Server must be running before starting any Commons service. - ---- - -### Notification Service - -```properties -mosip.kernel.sms.enabled=true -mosip.kernel.notification.email.from=do-not-reply@mosip.io -``` - ---- - -### ID / RID / PRID Generator Services - -```properties -mosip.kernel.prid.min-unused-threshold=1000 -mosip.kernel.prid.prids-to-generate=2000 -``` - ---- - -### Key and Salt Management - -```properties -mosip.kernel.keymanager.hsm.keystore-type=PKCS11 -``` -> **Note:** Config Server must be running before starting any Commons service. ---- # Local Setup @@ -228,22 +84,30 @@ https://docs.mosip.io/1.2.0/deploymentnew/v3-installation --- -# Documentation +## 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 Swagger documentation: [MOSIP Common Service API Documentation](https://mosip.github.io/documentation/1.2.0/1.2.0.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://github.com/mosip/commons). -- Main MOSIP Docs: https://docs.mosip.io -- API Docs: https://mosip.github.io/documentation -- Commons Repo Docs: https://github.com/mosip/commons --- +## Contribution & Community + +• To learn how you can contribute code to this application, [click here](https://docs.mosip.io/1.2.0/community/code-contributions). -# Contribution & Community +• If you have questions or encounter issues, visit the [MOSIP Community](https://community.mosip.io/) for support. -- Contribution Guide: https://docs.mosip.io/1.2.0/community/code-contributions -- Community Forum: https://community.mosip.io/ -- Issue Tracker: https://github.com/mosip/commons/issues +• For any GitHub issues: [Report here](https://github.com/mosip/admin-services/issues) --- -# License +## License -Licensed under the **Mozilla Public License 2.0**. +This project is licensed under the [Mozilla Public License 2.0](LICENSE). From 08804f46433e4b61642570fcbc3fcd7cd03a03ed Mon Sep 17 00:00:00 2001 From: Dhanendra Sahu Date: Wed, 17 Dec 2025 14:18:43 +0530 Subject: [PATCH 4/6] Modified the README.md based on review comments Signed-off-by: Dhanendra Sahu --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index 4bfe80cf62d..eada7475577 100644 --- a/README.md +++ b/README.md @@ -26,8 +26,6 @@ The following core services are part of MOSIP Commons: --- ---- - # Required Configuration ### Configuration From 0373a463b91dd0e7fe628e7a088ab9da822260d6 Mon Sep 17 00:00:00 2001 From: Dhanendra Sahu Date: Wed, 17 Dec 2025 14:49:07 +0530 Subject: [PATCH 5/6] Modified the README.md based on review comments Signed-off-by: Dhanendra Sahu --- README.md | 138 +++++++++++++++++++++++++++++++++++++----------------- 1 file changed, 96 insertions(+), 42 deletions(-) diff --git a/README.md b/README.md index eada7475577..f84be427115 100644 --- a/README.md +++ b/README.md @@ -1,40 +1,30 @@ # MOSIP Commons [![Maven Package upon a push](https://github.com/mosip/commons/actions/workflows/push-trigger.yml/badge.svg?branch=release-1.3.x)](https://github.com/mosip/commons/actions/workflows/push-trigger.yml) -[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=mosip_commons&metric=alert_status)](https://sonarcloud.io/dashboard?id=mosip_commons) +[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?branch=release-1.3.x&project=mosip_commons&metric=alert_status)](https://sonarcloud.io/dashboard?branch=release-1.3.x&id=mosip_commons) ## Overview **MOSIP Commons** is a collection of foundational libraries used across all MOSIP microservices. -These services support configuration management, ID generation, notifications, and cryptographic salt generation. +It contains services to support configuration management, ID generation, notifications, and cryptographic salt generation. --- - # Services The following core services are part of MOSIP Commons: --- -1. **[Kernel Notification Service](https://github.com/mosip/commons/tree/release-1.3.x/kernel/kernel-notification-service)** - Centralized notification service for sending messages such as SMS, email, and system alerts. -2. **[Kernel Config Server](https://github.com/mosip/commons/tree/release-1.3.x/kernel/kernel-config-server)** - Centralized configuration service used by all MOSIP microservices. -3. **[Kernel RID Generator Service](https://github.com/mosip/commons/tree/release-1.3.x/kernel/kernel-ridgenerator-servic)** - Generates globally unique Registration IDs (RID) for the MOSIP Registration Processor. -4. **[Kernel ID Generator Service](https://github.com/mosip/commons/tree/release-1.3.x/kernel/kernel-idgenerator-servic)** - Generates unique IDs required across MOSIP service. -5. **[Kernel PRID Generator Service](https://github.com/mosip/commons/tree/release-1.3.x/kernel/kernel-pridgenerator-servic)** - Generates Pre-Registration IDs (PRID) for MOSIP Pre-Registration flows. -6. **[Kernel Salt Generator](https://github.com/mosip/commons/tree/release-1.3.x/kernel/kernel-salt-generator)** - Generates cryptographically strong salts for securing sensitive data. - ---- - -# Required Configuration +1. **[Kernel Notification Service](kernel/kernel-notification-service)** - Centralized notification service for sending messages such as SMS, emails. +2. **[Kernel Config Server](kernel/kernel-config-server)** - Centralized configuration service used by all MOSIP microservices. +3. **[Kernel RID Generator Service](kernel/kernel-ridgenerator-service)** - Generates globally unique Registration IDs (RID). +4. **[Kernel ID Generator Service](kernel/kernel-idgenerator-service)** - Generates unique IDs required across MOSIP service. +5. **[Kernel PRID Generator Service](kernel/kernel-pridgenerator-service)** - Generates Pre-Registration IDs (PRID). +6. **[Kernel Salt Generator](kernel/kernel-salt-generator)** - Generates cryptographically strong salts for cryptographic operation. -### Configuration - -Common 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. -- [application-default.properties](https://github.com/mosip/mosip-config/blob/master/application-default.properties) : Contains common configurations which are required across MOSIP modules. -- [kernel-default.properties](https://github.com/mosip/mosip-config/blob/master/kernel-default.properties) : Contains configurations required or to be overridden for Common module. +--- # Local Setup @@ -47,44 +37,108 @@ Please refer to the required released tagged version for configuration. - **Keycloak/IDP:** Required for notification authentication - **Config Server** with correct property files ---- -## Build Steps +### Runtime Dependencies +Add below runtime dependencies to the classpath, or include it as a Maven dependency: +- Add `kernel-auth-adapter.jar` +- Add `kernel-sms-provide.jar` -### 1. Clone the Repository -```sh -git clone https://github.com/mosip/commons.git -cd commons +### Configuration + +Common 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. +- [application-default.properties](https://github.com/mosip/mosip-config/blob/master/application-default.properties) : Contains common configurations which are required across MOSIP modules. +- [kernel-default.properties](https://github.com/mosip/mosip-config/blob/master/kernel-default.properties) : Contains configurations required or to be overridden for Commons module. + + +## 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 commons ``` -### 2. Build with Maven -```sh +3. Build the project: + +```text mvn clean install -Dmaven.javadoc.skip=true -Dgpg.skip=true ``` -### 3. Run a Service -```sh -java -jar /target/ +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. + +### 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/kernel-notification-service:1.3.0 + ``` -**Example:** -```sh -java -jar kernel/kernel-notification-service/target/kernel-notification-service.jar +#### 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 commons +mvn clean install -Dmaven.javadoc.skip=true -Dgpg.skip=true ``` ---- +2. Navigate to each service directory and build the Docker image: + +```text +cd kernel/ +docker build -t . +``` -# Deployment +#### 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 abov -Commons services can be deployed on Docker and Kubernetes. -Refer to the MOSIP Deployment Guide: -https://docs.mosip.io/1.2.0/deploymentnew/v3-installation --- -## Documentation +## Deployment + +### Kubernetes -For more detailed documents for repositories, you can [check here](https://github.com/mosip/documentation/tree/1.2.0/docs). +To deploy Admin services on a Kubernetes cluster, refer to the [Sandbox Deployment Guide](https://docs.mosip.io/1.2.0/deploymentnew/v3-installation). + + +## Documentation ### API Documentation @@ -92,7 +146,7 @@ API endpoints, base URL, and mock server details are available via Swagger docum ### Product Documentation -To learn more about admin services from a functional perspective and use case scenarios, refer to our main documentation: [Click here](https://github.com/mosip/commons). +To learn more about MOSIP services from a functional perspective and use case scenarios, refer to our main documentation: [Click here](https://github.com/mosip/commons). --- @@ -102,7 +156,7 @@ To learn more about admin services from a functional perspective and use case sc • 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/admin-services/issues) +• For any GitHub issues: [Report here](https://github.com/mosip/commons/issues) --- From c06f2809bb6aabcb45d95fd7df842071f6f045c1 Mon Sep 17 00:00:00 2001 From: Dhanendra Sahu Date: Wed, 17 Dec 2025 14:56:46 +0530 Subject: [PATCH 6/6] Modified the README.md based on review comments Signed-off-by: Dhanendra Sahu --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f84be427115..1de2497bc58 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,9 @@ The following core services are part of MOSIP Commons: --- +## Database +Before starting the local setup, execute the required SQL scripts to initialize the database. +All database SQL scripts are available in the [db scripts](./db_scripts) directory. # Local Setup @@ -41,7 +44,7 @@ The following core services are part of MOSIP Commons: ### Runtime Dependencies Add below runtime dependencies to the classpath, or include it as a Maven dependency: - Add `kernel-auth-adapter.jar` -- Add `kernel-sms-provide.jar` +- Add `kernel-smsserviceprovider-msg91.jar` ### Configuration