DIVOC
DIVOC 3.0
DIVOC 3.0
  • Introduction to DIVOC
    • What DIVOC is and what it's not
    • DIVOC Docs Index
  • Platform
    • Release Notes
      • DIVOC 2.0 Release Features
      • DIVOC 3.0 Release Features
    • Specification
      • API Documentation
      • Setting up DIVOC development environment
    • DIVOC's Verifiable Certificate Features 2.0
      • Creating a DIVOC Certificate
        • Overview of DIVOC’s digital certificates
        • What information is included in the DIVOC certificate?
        • DIVOC’s certificate generation service: How does it work?
        • Compliance with internationally used COVID-19 certificate schemas
      • Distributing a DIVOC Certificate
      • Updating a DIVOC Certificate
      • Revoking a DIVOC Certificate
      • Verifying a DIVOC Certificate
      • DIVOC's Native COVID-19 Certificate Specification
      • DIVOC’s EU-DCC Adapter Service
      • DIVOC’s SHC Adapter Service
      • Adding a User Type in DIVOC
      • Printing Certificates at a Facility
      • Normal QR Code Versus Signed/Verifiable QR Code
      • What Information Goes Into a QR Code?
      • WHO Master Vaccine Checklist
      • EU Master Vaccine Checklist
    • DIVOC's Verifiable Certificate Features 3.0
      • How to Configure a New Tenant?
      • How to Access the VC System and Generate Tokens
      • How to Generate Certificates
      • How to Fetch Certificates
      • How to Update Certificates
      • How to Revoke Certificates
      • How to Suspend Certificates
    • DIVOC Architecture
    • Installation
      • Skills needed to set up DIVOC
      • Implementation Checklist
      • Setting Up DIVOC in k8 Cluster
        • How to Install DIVOC
        • How to Install DIVOC for V3.0
        • Backup & Restore: Postgres, Clickhouse, Kafka, & Redis
        • Infrastructure Recovery
        • Server Hardening
    • Verifiable Credential (VC): Production Deployment
    • Configuration
      • Configuring the Certification and Verification Component
        • Generating Signed Key Pairs
        • Configuring certificates
          • Step 1: Create a certification generation request
          • Step 2: Configure the QR code content
          • Step 3: Configure the certificate template
        • How to set up the verification portal for implementation
        • How to configure the update certificate API
        • Configuring Environment Variables in 2.0
      • Configuration Management Via ETCD
        • Adding a New Vaccine and ICD-11 Mapping
          • Adding a New Vaccine and ICD-11 Mapping Using ETCD CLI
        • PDF Template Change for Vaccine Certificates
          • PDF Template Change for Vaccine Certificates via ETCD CLI
        • EU Vaccine Configurations
          • Adding a New Vaccine and its Mapping via ETCD CLI
        • Payload Changes in the QR Code
          • Payload Changes in the QR Code via ETCD CLI
    • Performance Report
  • Products
    • Issuing COVID-19 Vaccination Certificates in India
    • Issuing COVID-19 Test Reports in India
    • Issuing COVID-19 Vaccination Certificates in Sri Lanka
    • Issuing COVID-19 Vaccination Certificates in the Philippines
    • Issuing COVID-19 Vaccination Certificates in Jamaica
      • Troubleshooting
    • Issuing COVID-19 Vaccination Certificates in Indonesia
    • Open Events
      • Past Events
      • DIVOC in the Media
  • DIVOC Demo
    • Program Setup (Via Orchestration Module)
    • Facility App
    • Issue and Verify Certificates
    • Citizen Portal
    • Feedback
    • Analytics
  • Community
    • Roadmap
    • Partner Support
      • Terms and Conditions of Using the DIVOC Site
      • Privacy Policy: Short Version for Display
      • Privacy Policy: Detailed
      • Platform Policy Guidelines
      • Privacy Policy Recommendations
      • Troubleshooting Guide
    • Source Code
    • Discussion Forum
    • Issues
    • Project Repo
Powered by GitBook
On this page
  1. Platform
  2. Specification

Setting up DIVOC development environment

PreviousAPI DocumentationNextDIVOC's Verifiable Certificate Features 2.0

Last updated 2 years ago

Steps

Step 1: Install prerequisites and dependencies

  • Update package list - sudo apt-get update.

  • Install docker - sudo apt install docker.io.

  • Install docker-compose - sudo curl -L "https://github.com/docker/compose/releases/download/1.29.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose.

  • Install git - sudo apt install git.

  • For additional details on Docker, you can find the instructions.

  • You can find the basic Docker Compose commands below: (DIVOC repo has file which lists all the services required for VC Issuance)

- Starting services.

- Restarting services.

- Checking the status of services.

- Monitoring service logs.

Step 2: Install DIVOC

  • Clone DIVOC repository onto your local machine - git clone.

  • Navigate to the DIVOC directory - cd DIVOC.

  • Configure DIVOC: Configurations are provided as environment variables and a default set of configurations is provided in the ‘.env.example’ file. Make a copy of this file named ‘.env’ that docker will pick up. Edit these configurations as per your need.

'cp .env.example .env'

Step 3: Start keycloak and kafka services in the detached mode.

docker-compose -f docker-compose-vc-issuance.yml up -d kafka keycloak
  • Verify the state of kafka and keycloak containers. If they are up and running, Other services can be started now in detached mode.

docker-compose -f docker-compose-vc-issuance.yml up -d

Step 4: To build docker images locally after making changes, run following commands make docker (Available within the individual micro services folder and at parent level folder as well).

docker-compose -f docker-compose-vc-issuance.yml up -d

Step 5: Explore DIVOC

  • The following are the routes to access local apps. The remaining routes can be found in nginx/nginx.conf.

Address
Application

localhost

tenant-portal

localhost/vc-verification-app

Verification app

. All containers should be up.

Some services might fail to start because the dependent service may not be ready yet. should start it successfully in this case.

On Mac/Windows, services may crash with exit code:137, if sufficient memory is not set for docker. This can be changed in the Docker desktop preferences, resources tab, as shown.

All content on this page by is licensed under a .

here
docker-compose-vc-issuance.yml
docker-compose -f docker-compose-vc-issuance.yml up
docker-compose
-f docker-compose-vc-issuance.yml
restart
docker-compose
-f docker-compose-vc-issuance.yml
ps
docker-compose
-f docker-compose-vc-issuance.yml
logs
https://github.com/egovernments/DIVOC
Verify the state of containers
Restarting the failed service
here
eGov Foundation
Creative Commons Attribution 4.0 International License
Creative Commons License