Sunbird RC
v2.0.0
v2.0.0
  • Learn
    • Introduction
    • Sunbird RC Overview
      • Why do we need Sunbird RC?
      • Core Capabilities
      • Core Registry Verbs
      • Workflows
      • What Sunbird RC is and what it's not? (WIP)
      • Possibilities
      • Demo Links
    • Technical Overview
      • Registry
        • High-Level architecture
        • Technical Specification Draft
        • Tech Stack and Requirements
      • Credentialling
        • High-Level Architecture
        • Technical Specification Draft
        • Tech Stack and Requirements
    • Adopters
    • Roadmap
  • Use
    • Getting started
      • Pre-requisites
      • Install Sunbird-RC
    • Developer's Guide
      • Functional Registry
        • Installation Guide
          • Registry CLI
            • Setup A Registry Instance
          • Manual installation through docker-compose
          • Production setup through Helm
        • Working with Source Code
        • Configurations
          • Frontend Configurations
          • Frontend - Proxy configuration
          • Audit Configuration
          • Notifications Configuration
          • View Templates Configuration
        • Schema Setup
          • Introduction To Schemas
          • Creating Your Own Schemas
          • Schema Configuration
          • Create Schemas With Custom Password
        • Setup the Backend
        • Setup the Frontend
        • 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
        • Generic Identity And Access Management
        • Metrics
        • Custom Keycloak Build
        • Custom QR Code design
        • VC Verification Module
      • Credentialling Services
        • Installation Guide
          • Run for development
          • Docker compose based
          • Helm based
        • Configurations
        • Working with the Vault
    • Integrations
      • SSO with existing systems
      • Digilocker Meripehchaan SSO
      • Digilocker Integration
    • Connectors
      • G2P Connect
      • Open ID for Verifiable Credentials (OID4VCI)
    • Release Notes
      • Registry
      • Credentialling
    • Admin Portal
      • Login
      • Get Started
        • Create Schema
        • Attestation Workflows (WIP)
        • VC Template
          • Custom VC Template (WIP)
        • Ownership (WIP)
        • Publish (WIP)
      • Dashboard
  • API Reference
    • Registry APIs
      • Registry
        • Using The APIs
        • 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
      • Metrics APIs
        • Get Count
        • Get Aggregates
    • Credentialling APIs
      • Identity Service APIs
      • Credential Schema APIs
      • Credential Issuance APIs
    • Other APIs
      • Sign API
      • Verify API
      • Swagger JSON API
      • Health API
  • Reference Solutions for Functional Registries
    • Education
      • Education Ecosystem
        • Installation
      • Education Registries
        • Installation
        • User Guide
    • Health Registries
      • Organ Registries
        • Frontend Setup
        • Backend Setup
        • User Guide
      • Health Facility Registry
    • Govt to Person (G2P)
  • Reference Solutions for Digital Credentials
    • Certificate Issuance
      • Installation(WIP)
      • User Guide
    • eLocker
      • High Level Diagram
      • Installation (WIP)
        • Frontend Setup E-locker
      • User Guide
    • Vaccination Platform
    • Skills & Work Credentials
    • 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
    • Contributors
    • Contributing
    • Contribution Guidebook
    • Code of Conduct
    • Community Events
    • Status By Track
  • HELP
    • Roadmap
    • FAQs
    • Glossary
    • Guide to Electronic Registries and Verifiable Credentials
      • 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
      • Leveraging Existing data stores
    • External Open Source Software Attributions
Powered by GitBook

Copyright (c) 2023 EkStep Foundation under MIT License

On this page
  • Identity Service
  • Credential Schema Service
  • Credential Issuance Service
Edit on GitHub
  1. Use
  2. Developer's Guide
  3. Credentialling Services

Configurations

The services can be configured by passing values to the environment.

Identity Service

Environment Variable
Description

DATABASE_URL

JDBC URL for the database. Example: postgres://<username>:<password>@<db_url>:<db_port>/<db_name>

VAULT_ADDR

Address for the Hashicorp vault

VAULT_TOKEN

Vault API Token

VAULT_BASE_URL

Vault API Endpoint: http://<vault_address>:8200/v1

VAULT_ROOT_PATH

Vault Root Path for the Key-Value store:http://<vault_address>:8200/v1/kv

VAULT_TIMEOUT

API Timeout for vault in milli seconds. Example: 5000

VAULT_PROXY

false

SIGNING_ALGORITHM

Algorithm to generate Key Pair in. Example: Ed25519Signature2020, Ed25519Signature2018, RSASignature2018

JWKS_URI

JWKS URI of the OAuth2 Resource server for handling Bearer tokens.

ENABLE_AUTH

To enable or disable authentication. Example: false

WEB_DID_BASE_URL

To set base URL to generate a web based DID

Credential Schema Service

Environment Variable
Description

DATABASE_URL

JDBC URL for the database. Example: postgres://<username>:<password>@<db_url>:<db_port>/<db_name>

IDENTITY_BASE_URL

Address for the Identity Microservice: http://identity-service:3332

JWKS_URI

JWKS URI of the OAuth2 Resource server for handling Bearer tokens.

ENABLE_AUTH

To enable or disable authentication. Example: false

Credential Issuance Service

Environment Variable
Description

DATABASE_URL

JDBC URL for the database. Example: postgres://<username>:<password>@<db_url>:<db_port>/<db_name>

IDENTITY_BASE_URL

Address for the Identity Microservice: http://identity-service:3332

SCHEMA_BASE_URL

Address for the Credential Schema Microservice: http://cred-schema-service:3333

CREDENTIAL_SERVICE_BASE_URL

base url for credential service to be exposed with to set the verify url in the qr code

JWKS_URI

JWKS URI of the OAuth2 Resource server for handling Bearer tokens.

ENABLE_AUTH

To enable or disable authentication. Example: false

QR_TYPE

set it as W3C_VC to have compressed vc in the qr code instead of verify credential url

PreviousHelm basedNextWorking with the Vault

Last updated 11 months ago