Inji
GitHubCommunityWhat's NewChatBot
  • Inji
    • Try It Out
      • Using Mock Data
    • Use case
    • Resources
    • Roadmap
      • Roadmap 2025
      • Roadmap 2024
    • Supported Integrations
      • MOSIP
    • Project Governance
    • Contribution
      • Code Contribution
      • Code of Conduct
    • GenderMag
    • License
    • Setup
      • Infrastructure Requirements
  • Inji Wallet
    • Inji Mobile
      • Overview
        • Features
      • Develop
        • Architecture
        • Technical Stack
        • Components
        • Integration Guides
          • Face Match
          • Secure Keystore
          • Tuvali
            • Permissions & Requirements
            • Tuvali API Documentation
          • BLE Verifier
          • PixelPass
          • Telemetry
          • VCI-Client
          • OpenID4VP
        • Specifications
          • Face SDK Specifications
        • Backend Services
          • Mimoto
          • eSignet
          • Inji Certify
        • Customizations
          • Workflow customization
          • UI customization
          • Locale customization
          • Configuration
          • Credential Providers
      • Test
        • Try It Out
          • Inji Mobile - Collab Guide
        • Workflow
        • End User Guide
      • Setup
        • Local Setup
      • Releases
        • Version 0.16.0
          • Test Report
        • Version 0.15.1
          • Test Report
        • Version 0.15.0
          • Test Report
        • Version 0.14.1
          • Test Report
        • Version 0.14.0
          • Test Report
        • Version 0.13.1
          • Test Report
        • Version 0.13.0
          • Test Report
        • Version 0.12.0
          • Test Report
        • Version 0.11.0-Inji
          • Test Report
        • Version 0.11.0
        • Version DP2
          • Test Report
        • Version 0.10.0
          • Test Report
        • Version DP1
        • Version 0.9.1
          • Test Report
        • Version 0.9.0
          • Test Report
    • Inji Web
      • Overview
        • Features
      • Develop
        • Architecture
        • Technology Stack
        • Backend services
          • Mimoto - BFF
          • eSignet - Authentication Layer
          • Configurations
        • Customizations
          • UI Customizations
          • Locale Customizations
          • Credential Providers
          • Customize VC PDF Template
        • Supported Browsers
      • Test
        • Try It Out
          • Inji Web - Collab Guide
        • Workflow
        • End User Guide
      • Setup
        • Local setup
      • Releases
        • Version 0.12.0
          • Test Report
        • Version v0.11.1
          • Test Report
        • Version 0.11.0
          • Test Report
        • Version 0.10.0
          • Test Report
        • Version 0.9.0
          • Test Report
        • Version 0.8.1
        • Version 0.8.0
          • Test Report
  • INJI CERTIFY
    • Overview
      • Features
    • Develop
      • Technology Stack
      • Components
      • Tested Operating Systems
    • Test
      • Functional Overview
      • Workflow
    • Setup
      • Local Setup
    • Releases
      • Version 0.11.0
        • Test Report
      • Version 0.10.2
        • Test Report
      • Version 0.10.1
        • Test Report
      • Version 0.9.1
        • Test Report
      • Version 0.9.0
        • Test Report
      • Version 0.8.1
      • Version 0.8.0
    • FAQ
      • FAQ
  • INJI VERIFY
    • Overview
      • Features
    • Develop
      • Technology Stack
      • Components
      • Supported Browsers
      • Customization
        • UI Customizations
        • Locale Customizations
    • Test
      • Try It Out
        • Inji Verify - Collab Guide
      • Workflow
      • End User Guide
      • Functional Overview
    • Setup
      • Local Setup
      • Generate QR Code
    • Releases
      • Version 0.11.1
        • Test Report
      • Version 0.11.0
        • Test Report
      • Version 0.10.0
        • Test Report
      • Version 0.9.0
        • Test Report
      • Version 0.8.1
      • Version 0.8.0
        • Test Report
  • FAQ
  • Deploy
Powered by GitBook

Copyright © 2021 MOSIP. This work is licensed under a Creative Commons Attribution (CC-BY-4.0) International License unless otherwise noted.

On this page
  • Repositories:
  • Run Inji Web locally using Docker Compose:
  • Steps:
  • Run Inji Web locally (Non-Docker Compose Setup):
  • Summary:

Was this helpful?

Export as PDF
  1. Inji Wallet
  2. Inji Web
  3. Setup

Local setup

Last updated 2 months ago

Was this helpful?

This document aims to assist users in setting up Inji Web on their local environment, offering step-by-step instructions to replicate the platform's functionality on their machine for development or testing purposes.

Repositories:

Clone the repositories locally to bring up your own setup. Repository information can be fetched from .

Pre-requisite:

In order to run Inji Web locally, Node 18 is required. Please follow the below steps to install node.

Node 18 can be installed using . Run the following commands to install node:

$ curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash
$ nvm install 18

Folder Structure:

  • helm: folder contains helm charts required to deploy on K8S

  • inji-web: contains the source code and Dockerfile

  • docker-compose: contains docker-compose.yml, environment files, and service configurations.


Run Inji Web locally using Docker Compose:

This setup uses Docker Compose to run DataShare Service (Service to store VC), Mimoto Service (Backend for Frontend) and Inji Web (Frontend) together locally, providing a simple and easy-to-manage environment.

Steps:

  1. Navigate to the inji-web folder and build the Inji Web image locally.

cd ./inji-web
docker build -t inji-web:local .
  1. Prepare the environment:

    • In the docker-compose folder, there are configuration files and certificates for integrating Mimoto as the BFF (Backend for Frontend) for the web and mobile services.

    • Create a certs folder in the docker-compose directory and add the necessary OIDC client certificate (as mentioned below).

    • Update the configuration files:

      • mimoto-issuers-config.json (Add Id providers as issuers)

      • mimoto-trusted-verifiers.json (Add verifiers clientId and redirect URI for online sharing)

      • Update Esignet host references in the mimoto-default.properties, mimoto-issuers-config.json files.

      • Set the oidc_p12_password environment variable value as per the documentation.

    • Update mimoto-issuers-config.json with the client ID and client alias as per your OIDC onboarding.

  2. Start the Docker Compose environment:

cd docker-compose
docker-compose up -d
  1. Stop the Docker Compose environment:

docker-compose down

Run Inji Web locally (Non-Docker Compose Setup):

If you'd prefer to run Inji Web without Docker Compose, you can manually set up and run the app on your local machine.

  1. Navigate to the inji-web folder and install dependencies:

cd ./inji-web
npm install
  1. Start the Inji Web application:

npm start
  1. Troubleshooting CORS issues:

    If you encounter CORS errors when running the web app locally, you will need to set up a proxy server and configure it to point to https://api.collab.mosip.net for Mimoto's API.

    • Once the proxy server is running, update the Inji Web app to use the proxy by modifying the window.location.origin in the src/utils/api.ts file.

  2. Run tests:

npm test

Summary:

  • Docker Compose Setup: This is the recommended setup for running Inji Web along with Mimoto locally.

  • Standalone Setup: If you prefer, you can run Inji Web as a standalone Node.js application.

Create OIDC client and generate oidckeystore.p12. You can follow the setup guide for this process .

Follow this to set up the proxy.

here
nvm
README link
here
guide