Skip to content

Latest commit

 

History

History
89 lines (77 loc) · 3.07 KB

README.md

File metadata and controls

89 lines (77 loc) · 3.07 KB
Raw

eSignet Signup

Overview

This repository contains a signup UI and signup service to handle signup operations by the end user. This module can be used to fast-track the availability of any digital service to end users via eSignet. eSignet has built-in support for the integration with the signup module. The signup service is flexible to connect to any ID registry system via a well-defined plugin interface.

Currently, signup supports below features:

  1. Register User
  2. Reset password
  3. Online video based identity verification workflow integration via plugin

Build (for developers)

The project requires JDK 11.

  1. Build: 
    $ mvn clean install -Dgpg.skip=true -Dmaven.gitcommitid.skip=true

Installing in k8s cluster using helm

signup-service is part of the esignet, but has a separate Helm chart to install and manage it in a completely independent namespace.

Pre-requisites

  1. Set the kube config file of the Esignet k8 cluster having esignet services is set correctly in PC.
  2. Below are the dependent services required for signup service integrated with Mock Identity System
    Chart Chart version
    Keycloak 7.1.18
    Keycloak-init 12.0.1-B3
    Kafka 0.4.2

Setup pre-requisites for signup services

cd deploy
./prereq.sh

Install Signup service

  • Install kubectl and helm utilities.
  • Run install-signup.sh to deploy signup services. 
    cd deploy
./install-signup.sh

Delete

  • Run delete-signup.sh to remove signup services. 
    cd deploy
./delete-signup.sh

Restart

  • Run restart-signup.sh to restart signup services. 
    cd deploy
./restart-signup.sh

Additional services required

To complete the signup portal deployment below MOSIP kernel services are required to be deployed.

  • otpmanager

  • authmanager

  • auditmanager

  • notifier

  • Initialize the db script to create mosip_kernel and mosip_audit databases make sure to update the existing db-common-secret in init_values.yaml if postgres-initialization already done

    • copy db-common-secret from existing postgres deployment secret if its already created
    • run the postgres-init.sh
      cd deploy
  ./postgres-init.sh

Prerequisites for MOSIP kernel services:

  1. msg-gateway
  2. config-server
  3. artifactory
  4. mock-smtp
  5. kernel
  cd deploy (follow the above sequence and run the install.sh for each module installation)

Partner onboarding

  • Perform Partner onboarding for esignet Signup OIDC client using steps only if mosip-identity plugin is used.

APIs

API documentation is available here.

License

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