Sunbird RC
v0.0.14
v0.0.14
  • Learn
    • Introduction
    • Verifiable Credentials
      • What issues will Verifiable Credentials address?
      • What are the key roles in Verifiable Credentials?
      • What are the components of Verifiable Credentials?
      • What are the benefits of Verifiable Credentials?
      • Digital Credentials vs Verifiable Credentials
      • QR code vs Verifiable QR code
      • Use Cases
    • Electronic Registries
      • Evolution of Electronic Registries
      • What issues will Electronic Registries address?
      • Benefits of Electronic Registries
      • Registry vs Database
      • Design Principles
      • Use Cases
    • Sunbird RC Overview
      • Features
      • Core Registry Verbs
      • Why do we need Sunbird RC?
      • What Sunbird RC is and what it's not? (WIP)
      • Core Capabilities
      • Technical Specification Draft
      • Workflows
      • High level architecture
    • Sunbird RC in action
      • Implementations (Work in Progress)
      • Possibilities
  • Use
    • Technical Requirements
    • Releases
    • Setup the Backend
    • Setup the Frontend
    • Leveraging Existing data stores
    • SSO with existing systems
      • Digilocker Meripehchaan SSO
  • Developer Documentation
    • Installation Guide
      • Registry CLI
        • Setup A Registry Instance
      • Manual installation through docker-compose
      • Production setup through Helm
    • Introduction To Schemas
    • Creating Your Own Schemas
    • Schema Configuration
    • Using The APIs
    • Create Schemas With Custom Password
    • Admin Portal
      • Login
      • Get Started
        • Create Schema
        • Attestation Workflows (WIP)
        • VC Template
          • Custom VC Template (WIP)
        • Ownership (WIP)
        • Publish (WIP)
      • Dashboard
    • Configuration
    • Developer Setup
    • VC Verification Module
    • Audit Configuration
    • Custom Keycloak Build
    • Metrics
    • Digilocker Integration
    • Custom QR Code design
    • Notifications Configuration
    • View Templates Configuration
    • Generic Identity And Access Management
    • Backup and Restore
      • PostgreSQL
        • SQL Dump
        • File System Level Backup
        • Continuous Archiving and Point-in-Time Recovery (PITR)
      • Cassandra
        • Snapshot-based backup method
        • Incremental backup method
        • Data Restore
    • Frontend Configurations
    • Frontend - Proxy configuration
  • API Reference
    • Registry
      • Create An Entity
      • Invite An Entity
      • Generate token
      • Generate admin token
      • Get An Entity
      • Get An Entity By Id
      • Update An Entity
      • Create A Property Of An Entity
      • Update A Property Of An Entity
      • Revoke a Credential
      • Delete An Entity
    • Schema
      • Create Schema
      • Get Schema
      • Update Schema
      • Delete Schema
      • Publish A Schema
    • Attestation API
      • Raise An Attestation
      • Get Attestation Certificate
    • Claims API
      • Get All Claims
      • Get Claim by ID
      • Attest A Claim
    • Discovery API
      • Search An Entity
    • File Storage API
      • Upload A File
      • Get Uploaded File
      • Delete A File/ Multiple Files
    • Bulk Issuance API
      • Get Sample Template
      • Upload CSV
      • Get all uploaded Files
      • Download a Report File
    • Metrics APIs
      • Get Count
      • Get Aggregates
    • Other APIs
      • Sign API
      • Verify API
      • Swagger JSON API
      • Health API
  • Reference Solutions
    • Education
      • Education Ecosystem
        • Installation
      • Education Registries
        • Installation
    • Certificate Issuance
      • Installation(WIP)
      • User Guide
    • eLocker
      • High Level Diagram
      • Installation (WIP)
        • Frontend Setup E-locker
      • User Guide
    • Health Registries
      • Organ Registries
        • Frontend Setup
        • Backend Setup
        • User Guide
    • Vaccination Platform
    • Skills & Work Credentials
    • Govt to Person (G2P)
    • Unified Learners Passport (ULP)
      • ULP Capabilities
      • Example Scenario
      • Technical Components (WIP)
      • Demo/Sandbox Links (WIP)
      • Installation Guide (WIP)
        • Frontend Setup
        • Installation through docker-compose
        • Dummy records setup for refrence
  • Links
    • Source Code
    • Releases & Changelogs
    • Website
    • Roadmap
    • Reference links
    • Design
  • Community
    • Discussion Forum
    • Contributing
    • Contributors
    • Contribution Guidebook
    • Code of Conduct
    • Community Events
    • Status By Track
  • HELP
    • Roadmap
    • FAQs
    • Glossary
Powered by GitBook

Copyright (c) 2023 EkStep Foundation under MIT License

On this page
  1. Reference Solutions
  2. Unified Learners Passport (ULP)

Installation Guide (WIP)

PreviousDemo/Sandbox Links (WIP)NextFrontend Setup

Last updated 1 year ago

Step 1 –

git clone

(this will be the Sunbird RC link once the code is merged)

Go to the specific directory where you have cloned the repository i.e. ref-automation Then perform the following command

sudo chmod -R +x nginx.sh

Export your_domain= Example : (export your_domain=test.automation.com) Then run the nginx.sh file ./nginx.sh

Step 2 - Setting Up the services

After installing certificates to the domain go to a specific directory i.e. ref-automation And perform the following command

sudo docker-compose up -d

Once all the containers are up and running then perform the below commands step by step

sudo docker exec -it postgres_db bash psql -U postgres CREATE DATABASE cred_ms CREATE DATABASE cred_ms_schema CREATE DATABASE identity

And exit the container Perform the following command in the terminal :

sudo docker restart credential_ms cred_schema_ms_service did_l3_service

Below Steps are required only if we want to set up on the server

Step 3 - Register your server to the Domain

Register The Server IP in the domain name in A records and wait for the validation.

Install Certbot

To install certbot for the ubuntu20.04 for nginx use cases follow the below command

sudo apt install certbot python3-certbot-nginx

sudo certbot

Add your mail id in the next step.

Then agree to the terms and conditions by Typing "Y" + Enter After that certbot will show you domain name you have setup select the appropriate domain name there with number Ex :

  1. Test.automation.com

Then select 1

Select the option redirecting the http to https access and you are done with the SSL certificates

Step 4 - Nginx configurations

Go to the /etc/nginx/sites-enabled/ and go to the config file of your domain that we have created add the below entity in the file in the server block

Like above add your service name and in proxy_pass add container name with assign Port save and close the file then run the below commands

sudo nginx -t sudo systemctl restart nginx

check the domain name with https access.

location /registry/ { proxy_pass ; }

https://github.com/Unified-Learner-Passbook/ref-automation.git
www.test.automation.com
http://regisry:8081/