Skip to content

Commit 41ef658

Browse files
chetankh239chetankh239
authored
[MOSIP-44051]: Updated README (#158)
* [MOSIP-44051]: Updated README Signed-off-by: Chetan Kumar Hirematha <chetankumar.h.239@gmail.com> * [MOSIP-44051]: Updated README Signed-off-by: Chetan Kumar Hirematha <chetankumar.h.239@gmail.com> * [MOSIP-44051]: Updated README Signed-off-by: Chetan Kumar Hirematha <chetankumar.h.239@gmail.com> --------- Signed-off-by: Chetan Kumar Hirematha <chetankumar.h.239@gmail.com>
1 parent 79ce942 commit 41ef658

2 files changed

Lines changed: 82 additions & 34 deletions

File tree

‎README.md‎

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,21 @@
11
[![Maven Package upon a push](https://github.com/mosip/biosdk-client/actions/workflows/push-trigger.yml/badge.svg?branch=release-1.3.x)](https://github.com/mosip/biosdk-client/actions/workflows/push-trigger.yml)
22
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?branch=release-1.3.x&project=mosip_biosdk-client&metric=alert_status)](https://sonarcloud.io/dashboard?branch=release-1.3.x&id=mosip_biosdk-client)
3-
43
# Bio-SDK Client
5-
64
## Overview
75
This library provides implementation of [IBioAPIV2](https://github.com/mosip/bio-utils/blob/master/kernel-biometrics-api/src/main/java/io/mosip/kernel/biometrics/spi/IBioApiV2.java) that internally connects with Bio-SDK serivces for Bio SDK related functionality. It can be used by ID authentication & ID repo services to perform 1:N match, segmentation, extraction etc.
86

9-
To know more, refer [here](https://https://docs.mosip.io/1.2.0/biometrics/biometric-sdk).
7+
To know more about Biometric SDK Specification, refer [here](https://docs.mosip.io/1.2.0/id-lifecycle-management/supporting-components/biometrics/biometric-sdk).
108

11-
### License
12-
This project is licensed under the terms of [Mozilla Public License 2.0](LICENSE).
9+
To know more about implementation, refer [here](biosdk-client/README.md).
10+
11+
## Contribution & Community
12+
13+
• To learn how you can contribute code to this application, [click here](https://docs.mosip.io/1.2.0/community/code-contributions).
1314

15+
• If you have questions or encounter issues, visit the [MOSIP Community](https://community.mosip.io/) for support.
16+
17+
• For any GitHub issues: [Report here](https://github.com/mosip/biosdk-client/issues)
18+
19+
20+
### License
21+
This project is licensed under the terms of [Mozilla Public License 2.0](LICENSE).

‎biosdk-client/README.md‎

Lines changed: 69 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,60 @@
11
# BioSDK-Client
2+
[![Maven Package upon a push](https://github.com/mosip/biosdk-client/actions/workflows/push-trigger.yml/badge.svg?branch=release-1.3.x)](https://github.com/mosip/biosdk-client/actions/workflows/push-trigger.yml)
3+
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?branch=release-1.3.x&project=mosip_biosdk-client&id=mosip_biosdk-client&metric=alert_status)](https://sonarcloud.io/dashboard?branch=release-1.3.x&id=mosip_biosdk-client)
24

35
## Overview
46

5-
The BioSDK-Client library provides an implementation of [IBioAPIV2](https://github.com/mosip/bio-utils/blob/master/kernel-biometrics-api/src/main/java/io/mosip/kernel/biometrics/spi/IBioApiV2.java), enabling seamless integration with Bio-SDK services for biometric-related functionalities. It supports operations like 1:N matching, segmentation, and extraction, making it a critical component for ID authentication and ID repository services.
7+
The **BioSDK-Client** library provides an implementation of [IBioApiV2](https://github.com/mosip/bio-utils/blob/master/kernel-biometrics-api/src/main/java/io/mosip/kernel/biometrics/spi/IBioApiV2.java), enabling seamless integration with Bio-SDK services for biometric-related functionalities. It supports operations like 1:N matching, segmentation, and extraction, making it a critical component for ID authentication and ID repository services.
68

7-
It is used by:
9+
For a complete functional overview and capabilities, refer to the **[official documentation](https://docs.mosip.io/1.2.0/biometrics/biometric-sdk)**.
10+
11+
### Used By
12+
13+
This library is used by the following MOSIP services:
814

915
* [authentication-internal-service](https://github.com/mosip/id-authentication/tree/master/authentication/authentication-internal-service)
1016
* [authentication-service](https://github.com/mosip/id-authentication/tree/master/authentication/authentication-service)
1117
* [id-repository-identity-service](https://github.com/mosip/id-repository/tree/master/id-repository)
1218

1319
---
1420

21+
## Features
22+
23+
- Implementation of IBioApiV2 interface
24+
- 1:N biometric matching
25+
- Biometric segmentation and extraction
26+
- Quality assessment and validation
27+
- Multi-modal biometric support (fingerprint, iris, face)
28+
- Format-specific and default URL configuration
29+
- Integration with external Bio-SDK services
30+
- Retry and fault-tolerance mechanisms
31+
- Caching for improved performance
32+
33+
---
34+
1535
## Table of Contents
1636

17-
* [Overview](#overview)
18-
* [Prerequisites](#prerequisites)
19-
* [Setting Up Locally](#setting-up-locally)
20-
* [Configurations](#configurations)
21-
* [Deployment](#deployment)
22-
* [License](#license)
37+
* [Overview](#overview)
38+
* [Features](#features)
39+
* [Prerequisites](#prerequisites)
40+
* [Setting Up Locally](#setting-up-locally)
41+
* [Configurations](#configurations)
42+
* [Deployment](#deployment)
43+
* [Upgrade](#upgrade)
44+
* [Documentation](#documentation)
45+
* [Contribution & Community](#contribution--community)
46+
* [License](#license)
2347

2448
---
2549

2650
## Prerequisites
2751

2852
Ensure you have the following dependencies installed before proceeding:
2953

30-
1. **Java**: Version 21.0.3
31-
2. **Maven**: Version 3.9.6 for building the project.
32-
3. **Git**: To clone the repository
33-
4. **Postman (optional)**: For testing the APIs
54+
- **JDK**: 21
55+
- **Maven**: 3.9.6
56+
- **Docker**: Latest stable version
57+
- **PostgreSQL**: 10.2 or higher
3458

3559
---
3660

@@ -40,14 +64,14 @@ Ensure you have the following dependencies installed before proceeding:
4064

4165
1. **Clone the repository**
4266

43-
```bash
67+
```text
4468
git clone https://github.com/mosip/biosdk-client.git
4569
cd biosdk-client
4670
```
4771

4872
2. **Build the project using Maven to resolve dependencies**
4973

50-
```bash
74+
```text
5175
mvn clean install -Dgpg.skip=true
5276
```
5377
---
@@ -61,17 +85,17 @@ Bio-SDK service URLs can vary based on the modality and format. Specify these in
6185
For example, to configure the URL for the minutiae format of fingerprints:
6286

6387
```text
64-
finger.format.url.minutiea -> "<Bio-SDK Service URL for minutiea format>"
88+
finger.format.url.minutiae -> "<Bio-SDK Service URL for minutiae format>"
6589
```
6690

6791
## Default Format Configuration
6892

6993
For a generic format configuration, use the `.default` suffix:
7094

7195
```text
72-
finger.format.url.default -> "<Default Bio-SDK Service URL for any unspecified format of finger biomertrics>"
73-
iris.format.url.default -> "<Default Bio-SDK Service URL for any unspecified format of iris biometrics>"
74-
face.format.url.default -> "<Default Bio-SDK Service URL for any unspecified format or face biometrics>"
96+
finger.format.url.default -> "<Default Bio-SDK Service URL for any unspecified format of finger biometrics>"
97+
iris.format.url.default -> "<Default Bio-SDK Service URL for any unspecified format of iris biometrics>"
98+
face.format.url.default -> "<Default Bio-SDK Service URL for any unspecified format of face biometrics>"
7599
```
76100

77101
If the above URLs are not specified in initParams, it will take a default Bio-SDK service URL from below property.
@@ -83,13 +107,13 @@ If the above URLs are not specified in initParams, it will take a default Bio-SD
83107
If the above URLs are not specified in initParams, the system will fallback to a global default URL:
84108

85109
```properties
86-
mosip_biosdk_service=<Bio SDK service url>
110+
mosip_biosdk_service=<Bio SDK service url>
87111
```
88112

89113
for example:
90114

91115
```properties
92-
mosip_biosdk_service=http://localhost:9099/biosdk-service/
116+
mosip_biosdk_service=http://localhost:<port>/biosdk-service/
93117
```
94118
---
95119

@@ -99,10 +123,10 @@ There are multiple ways to deploy biosdk-client with mosip-services. According t
99123

100124
### Create install script
101125

102-
1. Create a bash script file named "install.sh", as shown below:
126+
1. Create a text script file named "install.sh", as shown below:
103127

104-
```sh
105-
#!/bin/bash
128+
```text
129+
#!/bin/text
106130
107131
#installs the Bio-SDK
108132
set -e
@@ -122,12 +146,12 @@ There are multiple ways to deploy biosdk-client with mosip-services. According t
122146

123147
1. Place the following files in the same folder:
124148

125-
* biosdk-client-x.x.x-jar-with-dependencies.jar
126-
* install.sh
149+
* biosdk-client-x.x.x-jar-with-dependencies.jar
150+
* install.sh
127151

128152
2. Create a ZIP file:
129153

130-
```bash
154+
```text
131155
zip biosdk.zip biosdk-client-x.x.x-jar-with-dependencies.jar install.sh
132156
```
133157

@@ -136,12 +160,28 @@ zip biosdk.zip biosdk-client-x.x.x-jar-with-dependencies.jar install.sh
136160

137161
For more information on deployment, please refer to [mosip-infra](https://github.com/mosip/mosip-infra) README file.
138162

139-
**Note:** Set the mosip_biosdk_service environment variable when running Docker containers that use the biosdk-client.
163+
**Note:** Set the `mosip_biosdk_service` environment variable when running Docker containers that use the biosdk-client.
140164

141165
---
142166

143-
## License
167+
## Documentation
144168

145-
This project is licensed under the [MOSIP License](LICENSE).
169+
To learn more about Bio-SDK Client from a functional perspective and use case scenarios, refer to our main documentation: [Biometric SDK](https://docs.mosip.io/1.2.0/biometrics/biometric-sdk).
146170

147171
---
172+
173+
## Contribution & Community
174+
175+
• To learn how you can contribute code to this application, [click here](https://docs.mosip.io/1.2.0/community/code-contributions).
176+
177+
• If you have questions or encounter issues, visit the [MOSIP Community](https://community.mosip.io/) for support.
178+
179+
• For any GitHub issues: [Report here](https://github.com/mosip/biosdk-client/issues)
180+
181+
---
182+
183+
## License
184+
185+
This project is licensed under the [Mozilla Public License 2.0](LICENSE).
186+
187+
---

0 commit comments

Comments
 (0)