ID Repository

Overview

This repository contains source code and design documents for MOSIP ID Repository which is the server-side module to manage ID lifecycle. The modules exposes API endpoints.

Database

See DB guide

Build & run (for developers)

The project requires JDK 1.11.

1. To build jars:

   $ cd id-repository
   $ mvn clean install 
   

2. To skip JUnit tests and Java Docs:

   $ mvn install -DskipTests=true -Dmaven.javadoc.skip=true
   

3. To build Docker for a service:

   $ cd <service folder>
   $ docker build -f Dockerfile
   

4. As a developer, to run a service jar individually:

   `java -Dspring.profiles.active=<profile> -Dspring.cloud.config.uri=<config-url> -Dspring.cloud.config.label=<config-label> -jar <jar-name>.jar`
   

   Example:
   profile: env (extension used on configuration property files*)
   config_label: master (git branch of config repo*)
   config-url: http://localhost:51000 (Url of the config server*)

   * Refer to kernel-config-server for details

5. kernel-auth-adapter.jar needs to added to the build path to run the service.

NOTE: To run identity service, Biometric SDK implementation jar or Mock SDK needs to be added to the build path.

Deploy

To deploy ID Repository on Kubernetes cluster using Dockers refer to mosip-infra

Configuration

Refer to the configuration guide.

Test

Automated functaionl tests available in Functional Tests repo

APIs

API documentation is available here.

License

This project is licensed under the terms of Mozilla Public License 2.0