# Sunbird RC ## v1.0.0 - [Introduction](https://rc.sunbird.org/v1.0.0/learn/readme.md) - [Sunbird RC Overview](https://rc.sunbird.org/v1.0.0/learn/readme-1.md) - [Why do we need Sunbird RC?](https://rc.sunbird.org/v1.0.0/learn/readme-1/why-do-we-need-sunbird-rc.md) - [Core Capabilities](https://rc.sunbird.org/v1.0.0/learn/readme-1/core-capabilities.md) - [Core Registry Verbs](https://rc.sunbird.org/v1.0.0/learn/readme-1/core-registry-verbs.md) - [Workflows](https://rc.sunbird.org/v1.0.0/learn/readme-1/workflows.md) - [What Sunbird RC is and what it's not? (WIP)](https://rc.sunbird.org/v1.0.0/learn/readme-1/what-sunbird-rc-is-and-what-its-not-wip.md) - [Possibilities](https://rc.sunbird.org/v1.0.0/learn/readme-1/possibilities.md) - [Demo Links](https://rc.sunbird.org/v1.0.0/learn/readme-1/demo-links.md) - [Technical Overview](https://rc.sunbird.org/v1.0.0/learn/technical-overview.md) - [High level architecture](https://rc.sunbird.org/v1.0.0/learn/technical-overview/high-level-architecture.md) - [Technical Specification Draft](https://rc.sunbird.org/v1.0.0/learn/technical-overview/technical-specification-draft.md) - [Tech Stack and Requirements](https://rc.sunbird.org/v1.0.0/learn/technical-overview/infrastructure-requirements.md) - [Adopters](https://rc.sunbird.org/v1.0.0/learn/adopters.md): Sunbird RC has been leveraged to develop the following solutions: - [Roadmap](https://rc.sunbird.org/v1.0.0/learn/roadmap.md) - [Getting started](https://rc.sunbird.org/v1.0.0/use/getting-started.md) - [Pre-requisites](https://rc.sunbird.org/v1.0.0/use/getting-started/developer-setup.md) - [Installation Guide](https://rc.sunbird.org/v1.0.0/use/getting-started/installation-guide.md): The following steps will help you to setup SunbirdRC components for a local/development/production environment. - [Registry CLI](https://rc.sunbird.org/v1.0.0/use/getting-started/installation-guide/installation-guide.md): The following steps will help you to setup SunbirdRC components for a local/development environment. - [Setup A Registry Instance](https://rc.sunbird.org/v1.0.0/use/getting-started/installation-guide/installation-guide/setup-a-registry-instance.md) - [Manual installation through docker-compose](https://rc.sunbird.org/v1.0.0/use/getting-started/installation-guide/manual-installation-through-docker-compose.md): The following steps will install SunbirdRC via docker compose file - [Production setup through Helm](https://rc.sunbird.org/v1.0.0/use/getting-started/installation-guide/production-setup-through-helm.md): The below scripts will help the adopters to deploy SunbirdRC services in the Kubernetes environment. - [Developer's Guide](https://rc.sunbird.org/v1.0.0/use/developers-guide.md) - [Configurations](https://rc.sunbird.org/v1.0.0/use/developers-guide/configuration.md): Registry provides following configuration properties - [Frontend Configurations](https://rc.sunbird.org/v1.0.0/use/developers-guide/configuration/frontend-configurations.md): Registry provides following configuration properties - [Frontend - Proxy configuration](https://rc.sunbird.org/v1.0.0/use/developers-guide/configuration/frontend-proxy-configuration.md): This setting is required when you want to run an application in a local environment. - [Audit Configuration](https://rc.sunbird.org/v1.0.0/use/developers-guide/configuration/audit-configuration.md): The following document describes about how audit on registry schema can be enabled - [Notifications Configuration](https://rc.sunbird.org/v1.0.0/use/developers-guide/configuration/notifications-configuration.md) - [View Templates Configuration](https://rc.sunbird.org/v1.0.0/use/developers-guide/configuration/view-templates-configuration.md): Sunbird RC provides a functionality to transform the entity response body with different transformation templates - [Schema Setup](https://rc.sunbird.org/v1.0.0/use/developers-guide/schema-setup.md) - [Introduction To Schemas](https://rc.sunbird.org/v1.0.0/use/developers-guide/schema-setup/introduction-to-schemas.md) - [Creating Your Own Schemas](https://rc.sunbird.org/v1.0.0/use/developers-guide/schema-setup/creating-your-own-schemas.md) - [Schema Configuration](https://rc.sunbird.org/v1.0.0/use/developers-guide/schema-setup/schema-configuration.md) - [Create Schemas With Custom Password](https://rc.sunbird.org/v1.0.0/use/developers-guide/schema-setup/create-schemas-with-custom-password.md) - [Setup the Backend](https://rc.sunbird.org/v1.0.0/use/developers-guide/setup-the-backend.md) - [Setup the Frontend](https://rc.sunbird.org/v1.0.0/use/developers-guide/setup-the-frontend.md) - [Backup and Restore](https://rc.sunbird.org/v1.0.0/use/developers-guide/backup-and-restore.md) - [PostgreSQL](https://rc.sunbird.org/v1.0.0/use/developers-guide/backup-and-restore/postgresql.md) - [SQL Dump](https://rc.sunbird.org/v1.0.0/use/developers-guide/backup-and-restore/postgresql/sql-dump.md) - [File System Level Backup](https://rc.sunbird.org/v1.0.0/use/developers-guide/backup-and-restore/postgresql/file-system-level-backup.md) - [Continuous Archiving and Point-in-Time Recovery (PITR)](https://rc.sunbird.org/v1.0.0/use/developers-guide/backup-and-restore/postgresql/continuous-archiving-and-point-in-time-recovery-pitr.md) - [Cassandra](https://rc.sunbird.org/v1.0.0/use/developers-guide/backup-and-restore/cassandra.md) - [Snapshot-based backup method](https://rc.sunbird.org/v1.0.0/use/developers-guide/backup-and-restore/cassandra/snapshot-based-backup-method.md) - [Incremental backup method](https://rc.sunbird.org/v1.0.0/use/developers-guide/backup-and-restore/cassandra/incremental-backup-method.md) - [Data Restore](https://rc.sunbird.org/v1.0.0/use/developers-guide/backup-and-restore/cassandra/data-restore.md) - [Generic Identity And Access Management](https://rc.sunbird.org/v1.0.0/use/developers-guide/generic-identity-and-access-management.md): SunbirdRC was tightly coupled with keycloak for authentication & authorization of users. Currently, SunbirdRC is updated to support any identity layer (oauth2 compliant) for IAM - [Metrics](https://rc.sunbird.org/v1.0.0/use/developers-guide/metrics.md): The following document describes how the metrics can be emitted through registry - [Custom Keycloak Build](https://rc.sunbird.org/v1.0.0/use/developers-guide/custom-keycloak-build.md) - [Custom QR Code design](https://rc.sunbird.org/v1.0.0/use/developers-guide/custom-qr-code-design.md): Sunbird RC support configuring a custom design for the QR code instead of a plain black coloured QR Code - [VC Verification Module](https://rc.sunbird.org/v1.0.0/use/developers-guide/vc-verification-module.md): This is a common library created to be used in any Sunbird RC platform for VC verification. - [Integrations](https://rc.sunbird.org/v1.0.0/use/integrations.md) - [SSO with existing systems](https://rc.sunbird.org/v1.0.0/use/integrations/sso-with-existing-systems.md) - [Digilocker Meripehchaan SSO](https://rc.sunbird.org/v1.0.0/use/integrations/digilocker-meripehchaan-sso.md): This document will illustrate on how digilocker meripehchaan can be configured. - [Digilocker Integration](https://rc.sunbird.org/v1.0.0/use/integrations/digilocker-integration.md): This document covers the process of integrating digilocker with SunbirdRC, to pull the credentials from SunbirdRC to digilocker wallet - [Release Notes](https://rc.sunbird.org/v1.0.0/use/latest-release-v1.0.0.md) - [Latest Release - v1.0.0](https://rc.sunbird.org/v1.0.0/use/latest-release-v1.0.0/release-notes.md) - [Admin Portal](https://rc.sunbird.org/v1.0.0/use/admin-portal.md) - [Login](https://rc.sunbird.org/v1.0.0/use/admin-portal/login.md): Access Administrator/Tenant Portal - [Get Started](https://rc.sunbird.org/v1.0.0/use/admin-portal/get-started.md): Access Administrator Portal - [Create Schema](https://rc.sunbird.org/v1.0.0/use/admin-portal/get-started/create-schema.md) - [Attestation Workflows (WIP)](https://rc.sunbird.org/v1.0.0/use/admin-portal/get-started/attestation-workflows-wip.md) - [VC Template](https://rc.sunbird.org/v1.0.0/use/admin-portal/get-started/vc-template.md) - [Custom VC Template (WIP)](https://rc.sunbird.org/v1.0.0/use/admin-portal/get-started/vc-template/verifiable-credential-template-wip.md) - [Ownership (WIP)](https://rc.sunbird.org/v1.0.0/use/admin-portal/get-started/ownership-wip.md) - [Publish (WIP)](https://rc.sunbird.org/v1.0.0/use/admin-portal/get-started/publish-wip.md): Publish Schema one at a time - [Dashboard](https://rc.sunbird.org/v1.0.0/use/admin-portal/dashboard.md): The dashboard provides users with a comprehensive view of schema-related information, allowing seamless navigation and management of schema creation, exploration of APIs, and handling of VC. - [Registry](https://rc.sunbird.org/v1.0.0/api-reference/registry.md) - [Using The APIs](https://rc.sunbird.org/v1.0.0/api-reference/registry/using-the-apis.md) - [Create An Entity](https://rc.sunbird.org/v1.0.0/api-reference/registry/create-an-entity.md): To create an entity, we need to make the following HTTP request - [Invite An Entity](https://rc.sunbird.org/v1.0.0/api-reference/registry/invite-an-entity.md): To invite an entity, we need to make the following HTTP request - [Generate token](https://rc.sunbird.org/v1.0.0/api-reference/registry/authenticating-as-an-entity.md) - [Generate admin token](https://rc.sunbird.org/v1.0.0/api-reference/registry/generate-admin-token.md) - [Get An Entity](https://rc.sunbird.org/v1.0.0/api-reference/registry/get-an-entity.md): To get an entity created by the owner, we need to make the following HTTP request - [Get An Entity By Id](https://rc.sunbird.org/v1.0.0/api-reference/registry/get-an-entity-by-id.md): To get an entity, we need to make the following HTTP request - [Update An Entity](https://rc.sunbird.org/v1.0.0/api-reference/registry/update-an-entity.md): To update an entity, we need to make the following HTTP request - [Create A Property Of An Entity](https://rc.sunbird.org/v1.0.0/api-reference/registry/create-a-property-of-an-entity.md): To add property to an existing entity, we need to make the following HTTP request - [Update A Property Of An Entity](https://rc.sunbird.org/v1.0.0/api-reference/registry/update-a-property-of-an-entity.md): To update the property of an existing entity, we need to make the following HTTP request - [Revoke a Credential](https://rc.sunbird.org/v1.0.0/api-reference/registry/create-a-property-of-an-entity-1.md): To revoke an existing VC (Verifiable Credential) or an entity, we need to make the following HTTP request - [Delete An Entity](https://rc.sunbird.org/v1.0.0/api-reference/registry/delete-an-entity.md): To soft delete an entity, we need to make the following HTTP request - [Schema](https://rc.sunbird.org/v1.0.0/api-reference/schema.md) - [Create Schema](https://rc.sunbird.org/v1.0.0/api-reference/schema/create-schema.md) - [Get Schema](https://rc.sunbird.org/v1.0.0/api-reference/schema/get-schema.md) - [Update Schema](https://rc.sunbird.org/v1.0.0/api-reference/schema/update-schema.md) - [Delete Schema](https://rc.sunbird.org/v1.0.0/api-reference/schema/delete-schema.md) - [Publish A Schema](https://rc.sunbird.org/v1.0.0/api-reference/schema/publish-a-schema.md) - [Attestation API](https://rc.sunbird.org/v1.0.0/api-reference/attestation-api.md) - [Raise An Attestation](https://rc.sunbird.org/v1.0.0/api-reference/attestation-api/raise-an-attestation.md) - [Get Attestation Certificate](https://rc.sunbird.org/v1.0.0/api-reference/attestation-api/get-attestation-certificate.md) - [Claims API](https://rc.sunbird.org/v1.0.0/api-reference/claims-api.md) - [Get All Claims](https://rc.sunbird.org/v1.0.0/api-reference/claims-api/get-all-claims.md) - [Get Claim by ID](https://rc.sunbird.org/v1.0.0/api-reference/claims-api/get-claim-by-id.md) - [Attest A Claim](https://rc.sunbird.org/v1.0.0/api-reference/claims-api/attest-a-claim.md) - [Discovery API](https://rc.sunbird.org/v1.0.0/api-reference/discovery-api.md) - [Search An Entity](https://rc.sunbird.org/v1.0.0/api-reference/discovery-api/search-an-entity.md) - [File Storage API](https://rc.sunbird.org/v1.0.0/api-reference/file-storage-api.md) - [Upload A File](https://rc.sunbird.org/v1.0.0/api-reference/file-storage-api/upload-a-file.md) - [Get Uploaded File](https://rc.sunbird.org/v1.0.0/api-reference/file-storage-api/get-uploaded-file.md) - [Delete A File/ Multiple Files](https://rc.sunbird.org/v1.0.0/api-reference/file-storage-api/delete-a-file-multiple-files.md) - [Bulk Issuance API](https://rc.sunbird.org/v1.0.0/api-reference/bulk-issuance-api.md) - [Get Sample Template](https://rc.sunbird.org/v1.0.0/api-reference/bulk-issuance-api/get-sample-template.md) - [Upload CSV](https://rc.sunbird.org/v1.0.0/api-reference/bulk-issuance-api/upload-csv.md) - [Get all uploaded Files](https://rc.sunbird.org/v1.0.0/api-reference/bulk-issuance-api/get-all-uploaded-files.md) - [Download a Report File](https://rc.sunbird.org/v1.0.0/api-reference/bulk-issuance-api/download-a-report-file.md) - [Metrics APIs](https://rc.sunbird.org/v1.0.0/api-reference/metrics-apis.md) - [Get Count](https://rc.sunbird.org/v1.0.0/api-reference/metrics-apis/get-count.md) - [Get Aggregates](https://rc.sunbird.org/v1.0.0/api-reference/metrics-apis/get-aggregates.md) - [Other APIs](https://rc.sunbird.org/v1.0.0/api-reference/other-apis.md) - [Sign API](https://rc.sunbird.org/v1.0.0/api-reference/other-apis/sign-api.md) - [Verify API](https://rc.sunbird.org/v1.0.0/api-reference/other-apis/verify-api.md) - [Swagger JSON API](https://rc.sunbird.org/v1.0.0/api-reference/other-apis/swagger-json-api.md) - [Health API](https://rc.sunbird.org/v1.0.0/api-reference/other-apis/health-api.md) - [Education](https://rc.sunbird.org/v1.0.0/reference-solutions-for-functional-registries/education.md) - [Education Ecosystem](https://rc.sunbird.org/v1.0.0/reference-solutions-for-functional-registries/education/education-ecosystem.md) - [Installation](https://rc.sunbird.org/v1.0.0/reference-solutions-for-functional-registries/education/education-ecosystem/installation.md) - [Education Registries](https://rc.sunbird.org/v1.0.0/reference-solutions-for-functional-registries/education/edu-registries.md) - [Installation](https://rc.sunbird.org/v1.0.0/reference-solutions-for-functional-registries/education/edu-registries/installation.md) - [Health Registries](https://rc.sunbird.org/v1.0.0/reference-solutions-for-functional-registries/health-registries.md) - [Organ Registries](https://rc.sunbird.org/v1.0.0/reference-solutions-for-functional-registries/health-registries/organ-registries.md) - [Frontend Setup](https://rc.sunbird.org/v1.0.0/reference-solutions-for-functional-registries/health-registries/organ-registries/frontend-setup.md) - [Backend Setup](https://rc.sunbird.org/v1.0.0/reference-solutions-for-functional-registries/health-registries/organ-registries/backend-setup.md) - [User Guide](https://rc.sunbird.org/v1.0.0/reference-solutions-for-functional-registries/health-registries/organ-registries/user-guide.md) - [Health Facility Registry](https://rc.sunbird.org/v1.0.0/reference-solutions-for-functional-registries/health-registries/health-facility-registry.md) - [Govt to Person (G2P)](https://rc.sunbird.org/v1.0.0/reference-solutions-for-functional-registries/govt-to-person-g2p.md) - [Certificate Issuance](https://rc.sunbird.org/v1.0.0/reference-solution-for-digital-credentials/certificate-issuance.md) - [Installation(WIP)](https://rc.sunbird.org/v1.0.0/reference-solution-for-digital-credentials/certificate-issuance/installation-wip.md) - [User Guide](https://rc.sunbird.org/v1.0.0/reference-solution-for-digital-credentials/certificate-issuance/portal-user-guide.md) - [Vaccination Platform](https://rc.sunbird.org/v1.0.0/reference-solution-for-digital-credentials/vaccination.md) - [Unified Learners Passport (ULP)](https://rc.sunbird.org/v1.0.0/reference-solution-for-digital-credentials/unified-learners-passport-ulp.md): Unified Learners Passport (ULP) is a single source of digital credentials for learners across levels, that will help them easily discover and avail opportunities for academic or professional growth - [ULP Capabilities](https://rc.sunbird.org/v1.0.0/reference-solution-for-digital-credentials/unified-learners-passport-ulp/ulp-capabilities.md): The ULP software system contains capabilities of issuance, receipt and verification of learners’ credentials. - [Example Scenario](https://rc.sunbird.org/v1.0.0/reference-solution-for-digital-credentials/unified-learners-passport-ulp/example-scenario.md) - [Technical Components (WIP)](https://rc.sunbird.org/v1.0.0/reference-solution-for-digital-credentials/unified-learners-passport-ulp/technical-components-wip.md) - [Demo/Sandbox Links (WIP)](https://rc.sunbird.org/v1.0.0/reference-solution-for-digital-credentials/unified-learners-passport-ulp/demo-sandbox-links-wip.md) - [Installation Guide (WIP)](https://rc.sunbird.org/v1.0.0/reference-solution-for-digital-credentials/unified-learners-passport-ulp/installation-guide-wip.md) - [Frontend Setup](https://rc.sunbird.org/v1.0.0/reference-solution-for-digital-credentials/unified-learners-passport-ulp/installation-guide-wip/frontend-setup.md): Below is the link - [Installation through docker-compose](https://rc.sunbird.org/v1.0.0/reference-solution-for-digital-credentials/unified-learners-passport-ulp/installation-guide-wip/installation-through-docker-compose.md) - [Dummy records setup for refrence](https://rc.sunbird.org/v1.0.0/reference-solution-for-digital-credentials/unified-learners-passport-ulp/installation-guide-wip/dummy-records-setup-for-refrence.md) - [eLocker](https://rc.sunbird.org/v1.0.0/reference-solution-for-digital-credentials/elocker.md) - [High Level Diagram](https://rc.sunbird.org/v1.0.0/reference-solution-for-digital-credentials/elocker/digital-locker.md) - [Installation (WIP)](https://rc.sunbird.org/v1.0.0/reference-solution-for-digital-credentials/elocker/installation-wip.md) - [Frontend Setup E-locker](https://rc.sunbird.org/v1.0.0/reference-solution-for-digital-credentials/elocker/installation-wip/frontend-setup-e-locker.md) - [User Guide](https://rc.sunbird.org/v1.0.0/reference-solution-for-digital-credentials/elocker/user-guide.md) - [Skills & Work Credentials](https://rc.sunbird.org/v1.0.0/reference-solution-for-digital-credentials/skill-and-work-credentials-platform.md) - [Reference links](https://rc.sunbird.org/v1.0.0/links/reference-links.md) - [Design](https://rc.sunbird.org/v1.0.0/links/design.md) - [Discussion Forum](https://rc.sunbird.org/v1.0.0/community/discussions.md): We have multiple channels available for the community to discuss use cases, as for support from fellow community members & discuss existing features as well as brainstorm about new ones. - [Contributors](https://rc.sunbird.org/v1.0.0/community/contributors.md) - [Contributing](https://rc.sunbird.org/v1.0.0/community/contributing.md) - [Contribution Guidebook](https://rc.sunbird.org/v1.0.0/community/contribution-guidebook.md) - [Code of Conduct](https://rc.sunbird.org/v1.0.0/community/code-of-conduct.md) - [Community Events](https://rc.sunbird.org/v1.0.0/community/community-events.md): This page will list the schedule of our community events & also provide recordings of past events. - [Status By Track](https://rc.sunbird.org/v1.0.0/community/status-by-track.md): The intent of this page is to give a high level status on various project tracks & reference implementations that are currently in progress. Complete details can be found on github project boards. - [Roadmap](https://rc.sunbird.org/v1.0.0/help/roadmap.md) - [FAQs](https://rc.sunbird.org/v1.0.0/help/faqs.md) - [Glossary](https://rc.sunbird.org/v1.0.0/help/terminology.md) - [Guide to Electronic Registries and Verifiable Credentials](https://rc.sunbird.org/v1.0.0/help/comprehensive-overview-electronic-registries-and-verifiable-credentials.md) - [Verifiable Credentials](https://rc.sunbird.org/v1.0.0/help/comprehensive-overview-electronic-registries-and-verifiable-credentials/verifiable-credentials.md) - [What issues will Verifiable Credentials address?](https://rc.sunbird.org/v1.0.0/help/comprehensive-overview-electronic-registries-and-verifiable-credentials/verifiable-credentials/what-issues-will-verifiable-credentials-address.md) - [What are the key roles in Verifiable Credentials?](https://rc.sunbird.org/v1.0.0/help/comprehensive-overview-electronic-registries-and-verifiable-credentials/verifiable-credentials/what-are-the-key-roles-in-verifiable-credentials.md) - [What are the components of Verifiable Credentials?](https://rc.sunbird.org/v1.0.0/help/comprehensive-overview-electronic-registries-and-verifiable-credentials/verifiable-credentials/what-are-the-components-of-verifiable-credentials.md) - [What are the benefits of Verifiable Credentials?](https://rc.sunbird.org/v1.0.0/help/comprehensive-overview-electronic-registries-and-verifiable-credentials/verifiable-credentials/what-are-the-benefits-of-verifiable-credentials.md) - [Digital Credentials vs Verifiable Credentials](https://rc.sunbird.org/v1.0.0/help/comprehensive-overview-electronic-registries-and-verifiable-credentials/verifiable-credentials/digital-credentials-vs-verifiable-credentials.md) - [QR code vs Verifiable QR code](https://rc.sunbird.org/v1.0.0/help/comprehensive-overview-electronic-registries-and-verifiable-credentials/verifiable-credentials/qr-code-vs-verifiable-qr-code.md) - [Use Cases](https://rc.sunbird.org/v1.0.0/help/comprehensive-overview-electronic-registries-and-verifiable-credentials/verifiable-credentials/use-cases.md) - [Electronic Registries](https://rc.sunbird.org/v1.0.0/help/comprehensive-overview-electronic-registries-and-verifiable-credentials/electronic-registries.md) - [Evolution of Electronic Registries](https://rc.sunbird.org/v1.0.0/help/comprehensive-overview-electronic-registries-and-verifiable-credentials/electronic-registries/evolution-electronic-registries.md) - [What issues will Electronic Registries address?](https://rc.sunbird.org/v1.0.0/help/comprehensive-overview-electronic-registries-and-verifiable-credentials/electronic-registries/what-issues-will-electronic-registries-address.md) - [Benefits of Electronic Registries](https://rc.sunbird.org/v1.0.0/help/comprehensive-overview-electronic-registries-and-verifiable-credentials/electronic-registries/benefits-of-electronic-registries.md) - [Registry vs Database](https://rc.sunbird.org/v1.0.0/help/comprehensive-overview-electronic-registries-and-verifiable-credentials/electronic-registries/registry-vs-database.md) - [Design Principles](https://rc.sunbird.org/v1.0.0/help/comprehensive-overview-electronic-registries-and-verifiable-credentials/electronic-registries/design-principles.md) - [Use Cases](https://rc.sunbird.org/v1.0.0/help/comprehensive-overview-electronic-registries-and-verifiable-credentials/electronic-registries/use-cases.md) - [Leveraging Existing data stores](https://rc.sunbird.org/v1.0.0/help/comprehensive-overview-electronic-registries-and-verifiable-credentials/leveraging-existing-data-stores-directories.md): leverage existing trustworthy sources of data to accelerate registry implementation - [External Open Source Software Attributions](https://rc.sunbird.org/v1.0.0/help/external-open-source-software-attributions.md) ## v0.0.14 - [Introduction](https://rc.sunbird.org/v0.0.14/learn/readme.md) - [Verifiable Credentials](https://rc.sunbird.org/v0.0.14/learn/verifiable-credentials.md) - [What issues will Verifiable Credentials address?](https://rc.sunbird.org/v0.0.14/learn/verifiable-credentials/what-issues-will-verifiable-credentials-address.md) - [What are the key roles in Verifiable Credentials?](https://rc.sunbird.org/v0.0.14/learn/verifiable-credentials/what-are-the-key-roles-in-verifiable-credentials.md) - [What are the components of Verifiable Credentials?](https://rc.sunbird.org/v0.0.14/learn/verifiable-credentials/what-are-the-components-of-verifiable-credentials.md) - [What are the benefits of Verifiable Credentials?](https://rc.sunbird.org/v0.0.14/learn/verifiable-credentials/what-are-the-benefits-of-verifiable-credentials.md) - [Digital Credentials vs Verifiable Credentials](https://rc.sunbird.org/v0.0.14/learn/verifiable-credentials/digital-credentials-vs-verifiable-credentials.md) - [QR code vs Verifiable QR code](https://rc.sunbird.org/v0.0.14/learn/verifiable-credentials/qr-code-vs-verifiable-qr-code.md) - [Use Cases](https://rc.sunbird.org/v0.0.14/learn/verifiable-credentials/use-cases.md) - [Electronic Registries](https://rc.sunbird.org/v0.0.14/learn/electronic-registries.md) - [Evolution of Electronic Registries](https://rc.sunbird.org/v0.0.14/learn/electronic-registries/evolution-electronic-registries.md) - [What issues will Electronic Registries address?](https://rc.sunbird.org/v0.0.14/learn/electronic-registries/what-issues-will-electronic-registries-address.md) - [Benefits of Electronic Registries](https://rc.sunbird.org/v0.0.14/learn/electronic-registries/benefits-of-electronic-registries.md) - [Registry vs Database](https://rc.sunbird.org/v0.0.14/learn/electronic-registries/registry-vs-database.md) - [Design Principles](https://rc.sunbird.org/v0.0.14/learn/electronic-registries/design-principles.md) - [Use Cases](https://rc.sunbird.org/v0.0.14/learn/electronic-registries/use-cases.md) - [Sunbird RC Overview](https://rc.sunbird.org/v0.0.14/learn/readme-1.md) - [Features](https://rc.sunbird.org/v0.0.14/learn/readme-1/features.md) - [Core Registry Verbs](https://rc.sunbird.org/v0.0.14/learn/readme-1/core-registry-verbs.md) - [Why do we need Sunbird RC?](https://rc.sunbird.org/v0.0.14/learn/readme-1/why-do-we-need-sunbird-rc.md) - [What Sunbird RC is and what it's not? (WIP)](https://rc.sunbird.org/v0.0.14/learn/readme-1/what-sunbird-rc-is-and-what-its-not-wip.md) - [Core Capabilities](https://rc.sunbird.org/v0.0.14/learn/readme-1/core-capabilities.md) - [Technical Specification Draft](https://rc.sunbird.org/v0.0.14/learn/readme-1/technical-specification-draft.md) - [Workflows](https://rc.sunbird.org/v0.0.14/learn/readme-1/workflows.md) - [High level architecture](https://rc.sunbird.org/v0.0.14/learn/readme-1/high-level-architecture.md) - [Sunbird RC in action](https://rc.sunbird.org/v0.0.14/learn/sunbird-rc-in-action.md) - [Implementations (Work in Progress)](https://rc.sunbird.org/v0.0.14/learn/sunbird-rc-in-action/implementations.md) - [Possibilities](https://rc.sunbird.org/v0.0.14/learn/sunbird-rc-in-action/possibilities.md) - [Technical Requirements](https://rc.sunbird.org/v0.0.14/use/infrastructure-requirements.md) - [Releases](https://rc.sunbird.org/v0.0.14/use/releases.md) - [Setup the Backend](https://rc.sunbird.org/v0.0.14/use/setup-the-backend.md) - [Setup the Frontend](https://rc.sunbird.org/v0.0.14/use/setup-the-frontend.md) - [Leveraging Existing data stores](https://rc.sunbird.org/v0.0.14/use/leveraging-existing-data-stores-directories.md): leverage existing trustworthy sources of data to accelerate registry implementation - [SSO with existing systems](https://rc.sunbird.org/v0.0.14/use/sso-with-existing-systems.md) - [Digilocker Meripehchaan SSO](https://rc.sunbird.org/v0.0.14/use/sso-with-existing-systems/digilocker-meripehchaan-sso.md): This document will illustrate on how digilocker meripehchaan can be configured. - [Installation Guide](https://rc.sunbird.org/v0.0.14/developer-documentation/installation-guide.md): The following steps will help you to setup SunbirdRC components for a local/development/production environment. - [Registry CLI](https://rc.sunbird.org/v0.0.14/developer-documentation/installation-guide/installation-guide.md): The following steps will help you to setup SunbirdRC components for a local/development environment. - [Setup A Registry Instance](https://rc.sunbird.org/v0.0.14/developer-documentation/installation-guide/installation-guide/setup-a-registry-instance.md) - [Manual installation through docker-compose](https://rc.sunbird.org/v0.0.14/developer-documentation/installation-guide/manual-installation-through-docker-compose.md): The following steps will install SunbirdRC via docker compose file - [Production setup through Helm](https://rc.sunbird.org/v0.0.14/developer-documentation/installation-guide/production-setup-through-helm.md): The below scripts will help the adopters to deploy SunbirdRC services in the Kubernetes environment. - [Introduction To Schemas](https://rc.sunbird.org/v0.0.14/developer-documentation/introduction-to-schemas.md) - [Creating Your Own Schemas](https://rc.sunbird.org/v0.0.14/developer-documentation/creating-your-own-schemas.md) - [Schema Configuration](https://rc.sunbird.org/v0.0.14/developer-documentation/schema-configuration.md) - [Using The APIs](https://rc.sunbird.org/v0.0.14/developer-documentation/using-the-apis.md) - [Create Schemas With Custom Password](https://rc.sunbird.org/v0.0.14/developer-documentation/create-schemas-with-custom-password.md) - [Admin Portal](https://rc.sunbird.org/v0.0.14/developer-documentation/admin-portal.md) - [Login](https://rc.sunbird.org/v0.0.14/developer-documentation/admin-portal/login.md): Access Administrator/Tenant Portal - [Get Started](https://rc.sunbird.org/v0.0.14/developer-documentation/admin-portal/get-started.md): Access Administrator Portal - [Create Schema](https://rc.sunbird.org/v0.0.14/developer-documentation/admin-portal/get-started/create-schema.md) - [Attestation Workflows (WIP)](https://rc.sunbird.org/v0.0.14/developer-documentation/admin-portal/get-started/attestation-workflows-wip.md) - [VC Template](https://rc.sunbird.org/v0.0.14/developer-documentation/admin-portal/get-started/vc-template.md) - [Custom VC Template (WIP)](https://rc.sunbird.org/v0.0.14/developer-documentation/admin-portal/get-started/vc-template/verifiable-credential-template-wip.md) - [Ownership (WIP)](https://rc.sunbird.org/v0.0.14/developer-documentation/admin-portal/get-started/ownership-wip.md) - [Publish (WIP)](https://rc.sunbird.org/v0.0.14/developer-documentation/admin-portal/get-started/publish-wip.md): Publish Schema one at a time - [Dashboard](https://rc.sunbird.org/v0.0.14/developer-documentation/admin-portal/dashboard.md) - [Configuration](https://rc.sunbird.org/v0.0.14/developer-documentation/configuration.md): Registry provides following configuration properties - [Developer Setup](https://rc.sunbird.org/v0.0.14/developer-documentation/developer-setup.md) - [VC Verification Module](https://rc.sunbird.org/v0.0.14/developer-documentation/vc-verification-module.md): This is a common library created to be used in any Sunbird RC platform for VC verification. - [Audit Configuration](https://rc.sunbird.org/v0.0.14/developer-documentation/audit-configuration.md): The following document describes about how audit on registry schema can be enabled - [Custom Keycloak Build](https://rc.sunbird.org/v0.0.14/developer-documentation/custom-keycloak-build.md) - [Metrics](https://rc.sunbird.org/v0.0.14/developer-documentation/metrics.md): The following document describes how the metrics can be emitted through registry - [Digilocker Integration](https://rc.sunbird.org/v0.0.14/developer-documentation/digilocker-integration.md): This document covers the process of integrating digilocker with SunbirdRC, to pull the credentials from SunbirdRC to digilocker wallet - [Custom QR Code design](https://rc.sunbird.org/v0.0.14/developer-documentation/custom-qr-code-design.md): Sunbird RC support configuring a custom design for the QR code instead of a plain black coloured QR Code - [Notifications Configuration](https://rc.sunbird.org/v0.0.14/developer-documentation/notifications-configuration.md) - [View Templates Configuration](https://rc.sunbird.org/v0.0.14/developer-documentation/view-templates-configuration.md): Sunbird RC provides a functionality to transform the entity response body with different transformation templates - [Generic Identity And Access Management](https://rc.sunbird.org/v0.0.14/developer-documentation/generic-identity-and-access-management.md): SunbirdRC was tightly coupled with keycloak for authentication & authorization of users. Currently, SunbirdRC is updated to support any identity layer (oauth2 compliant) for IAM - [Backup and Restore](https://rc.sunbird.org/v0.0.14/developer-documentation/backup-and-restore.md) - [PostgreSQL](https://rc.sunbird.org/v0.0.14/developer-documentation/backup-and-restore/postgresql.md) - [SQL Dump](https://rc.sunbird.org/v0.0.14/developer-documentation/backup-and-restore/postgresql/sql-dump.md) - [File System Level Backup](https://rc.sunbird.org/v0.0.14/developer-documentation/backup-and-restore/postgresql/file-system-level-backup.md) - [Continuous Archiving and Point-in-Time Recovery (PITR)](https://rc.sunbird.org/v0.0.14/developer-documentation/backup-and-restore/postgresql/continuous-archiving-and-point-in-time-recovery-pitr.md) - [Cassandra](https://rc.sunbird.org/v0.0.14/developer-documentation/backup-and-restore/cassandra.md) - [Snapshot-based backup method](https://rc.sunbird.org/v0.0.14/developer-documentation/backup-and-restore/cassandra/snapshot-based-backup-method.md) - [Incremental backup method](https://rc.sunbird.org/v0.0.14/developer-documentation/backup-and-restore/cassandra/incremental-backup-method.md) - [Data Restore](https://rc.sunbird.org/v0.0.14/developer-documentation/backup-and-restore/cassandra/data-restore.md) - [Frontend Configurations](https://rc.sunbird.org/v0.0.14/developer-documentation/frontend-configurations.md): Registry provides following configuration properties - [Frontend - Proxy configuration](https://rc.sunbird.org/v0.0.14/developer-documentation/frontend-proxy-configuration.md): This setting is required when you want to run an application in a local environment. - [Registry](https://rc.sunbird.org/v0.0.14/api-reference/registry.md) - [Create An Entity](https://rc.sunbird.org/v0.0.14/api-reference/registry/create-an-entity.md): To create an entity, we need to make the following HTTP request - [Invite An Entity](https://rc.sunbird.org/v0.0.14/api-reference/registry/invite-an-entity.md): To invite an entity, we need to make the following HTTP request - [Generate token](https://rc.sunbird.org/v0.0.14/api-reference/registry/authenticating-as-an-entity.md) - [Generate admin token](https://rc.sunbird.org/v0.0.14/api-reference/registry/generate-admin-token.md) - [Get An Entity](https://rc.sunbird.org/v0.0.14/api-reference/registry/get-an-entity.md): To get an entity created by the owner, we need to make the following HTTP request - [Get An Entity By Id](https://rc.sunbird.org/v0.0.14/api-reference/registry/get-an-entity-by-id.md): To get an entity, we need to make the following HTTP request - [Update An Entity](https://rc.sunbird.org/v0.0.14/api-reference/registry/update-an-entity.md): To update an entity, we need to make the following HTTP request - [Create A Property Of An Entity](https://rc.sunbird.org/v0.0.14/api-reference/registry/create-a-property-of-an-entity.md): To add property to an existing entity, we need to make the following HTTP request - [Update A Property Of An Entity](https://rc.sunbird.org/v0.0.14/api-reference/registry/update-a-property-of-an-entity.md): To update the property of an existing entity, we need to make the following HTTP request - [Revoke a Credential](https://rc.sunbird.org/v0.0.14/api-reference/registry/create-a-property-of-an-entity-1.md): To revoke an existing VC (Verifiable Credential) or an entity, we need to make the following HTTP request - [Delete An Entity](https://rc.sunbird.org/v0.0.14/api-reference/registry/delete-an-entity.md): To soft delete an entity, we need to make the following HTTP request - [Schema](https://rc.sunbird.org/v0.0.14/api-reference/schema.md) - [Create Schema](https://rc.sunbird.org/v0.0.14/api-reference/schema/create-schema.md) - [Get Schema](https://rc.sunbird.org/v0.0.14/api-reference/schema/get-schema.md) - [Update Schema](https://rc.sunbird.org/v0.0.14/api-reference/schema/update-schema.md) - [Delete Schema](https://rc.sunbird.org/v0.0.14/api-reference/schema/delete-schema.md) - [Publish A Schema](https://rc.sunbird.org/v0.0.14/api-reference/schema/publish-a-schema.md) - [Attestation API](https://rc.sunbird.org/v0.0.14/api-reference/attestation-api.md) - [Raise An Attestation](https://rc.sunbird.org/v0.0.14/api-reference/attestation-api/raise-an-attestation.md) - [Get Attestation Certificate](https://rc.sunbird.org/v0.0.14/api-reference/attestation-api/get-attestation-certificate.md) - [Claims API](https://rc.sunbird.org/v0.0.14/api-reference/claims-api.md) - [Get All Claims](https://rc.sunbird.org/v0.0.14/api-reference/claims-api/get-all-claims.md) - [Get Claim by ID](https://rc.sunbird.org/v0.0.14/api-reference/claims-api/get-claim-by-id.md) - [Attest A Claim](https://rc.sunbird.org/v0.0.14/api-reference/claims-api/attest-a-claim.md) - [Discovery API](https://rc.sunbird.org/v0.0.14/api-reference/discovery-api.md) - [Search An Entity](https://rc.sunbird.org/v0.0.14/api-reference/discovery-api/search-an-entity.md) - [File Storage API](https://rc.sunbird.org/v0.0.14/api-reference/file-storage-api.md) - [Upload A File](https://rc.sunbird.org/v0.0.14/api-reference/file-storage-api/upload-a-file.md) - [Get Uploaded File](https://rc.sunbird.org/v0.0.14/api-reference/file-storage-api/get-uploaded-file.md) - [Delete A File/ Multiple Files](https://rc.sunbird.org/v0.0.14/api-reference/file-storage-api/delete-a-file-multiple-files.md) - [Bulk Issuance API](https://rc.sunbird.org/v0.0.14/api-reference/bulk-issuance-api.md) - [Get Sample Template](https://rc.sunbird.org/v0.0.14/api-reference/bulk-issuance-api/get-sample-template.md) - [Upload CSV](https://rc.sunbird.org/v0.0.14/api-reference/bulk-issuance-api/upload-csv.md) - [Get all uploaded Files](https://rc.sunbird.org/v0.0.14/api-reference/bulk-issuance-api/get-all-uploaded-files.md) - [Download a Report File](https://rc.sunbird.org/v0.0.14/api-reference/bulk-issuance-api/download-a-report-file.md) - [Metrics APIs](https://rc.sunbird.org/v0.0.14/api-reference/metrics-apis.md) - [Get Count](https://rc.sunbird.org/v0.0.14/api-reference/metrics-apis/get-count.md) - [Get Aggregates](https://rc.sunbird.org/v0.0.14/api-reference/metrics-apis/get-aggregates.md) - [Other APIs](https://rc.sunbird.org/v0.0.14/api-reference/other-apis.md) - [Sign API](https://rc.sunbird.org/v0.0.14/api-reference/other-apis/sign-api.md) - [Verify API](https://rc.sunbird.org/v0.0.14/api-reference/other-apis/verify-api.md) - [Swagger JSON API](https://rc.sunbird.org/v0.0.14/api-reference/other-apis/swagger-json-api.md) - [Health API](https://rc.sunbird.org/v0.0.14/api-reference/other-apis/health-api.md) - [Education](https://rc.sunbird.org/v0.0.14/reference-solutions/education.md) - [Education Ecosystem](https://rc.sunbird.org/v0.0.14/reference-solutions/education/education-ecosystem.md) - [Installation](https://rc.sunbird.org/v0.0.14/reference-solutions/education/education-ecosystem/installation.md) - [Education Registries](https://rc.sunbird.org/v0.0.14/reference-solutions/education/edu-registries.md) - [Installation](https://rc.sunbird.org/v0.0.14/reference-solutions/education/edu-registries/installation.md) - [Certificate Issuance](https://rc.sunbird.org/v0.0.14/reference-solutions/certificate-issuance.md) - [Installation(WIP)](https://rc.sunbird.org/v0.0.14/reference-solutions/certificate-issuance/installation-wip.md) - [User Guide](https://rc.sunbird.org/v0.0.14/reference-solutions/certificate-issuance/portal-user-guide.md) - [eLocker](https://rc.sunbird.org/v0.0.14/reference-solutions/elocker.md) - [High Level Diagram](https://rc.sunbird.org/v0.0.14/reference-solutions/elocker/digital-locker.md) - [Installation (WIP)](https://rc.sunbird.org/v0.0.14/reference-solutions/elocker/installation-wip.md) - [Frontend Setup E-locker](https://rc.sunbird.org/v0.0.14/reference-solutions/elocker/installation-wip/frontend-setup-e-locker.md) - [User Guide](https://rc.sunbird.org/v0.0.14/reference-solutions/elocker/user-guide.md) - [Health Registries](https://rc.sunbird.org/v0.0.14/reference-solutions/health-registries.md) - [Organ Registries](https://rc.sunbird.org/v0.0.14/reference-solutions/health-registries/organ-registries.md) - [Frontend Setup](https://rc.sunbird.org/v0.0.14/reference-solutions/health-registries/organ-registries/frontend-setup.md) - [Backend Setup](https://rc.sunbird.org/v0.0.14/reference-solutions/health-registries/organ-registries/backend-setup.md) - [User Guide](https://rc.sunbird.org/v0.0.14/reference-solutions/health-registries/organ-registries/user-guide.md) - [Vaccination Platform](https://rc.sunbird.org/v0.0.14/reference-solutions/vaccination.md) - [Skills & Work Credentials](https://rc.sunbird.org/v0.0.14/reference-solutions/skill-and-work-credentials-platform.md) - [Govt to Person (G2P)](https://rc.sunbird.org/v0.0.14/reference-solutions/govt-to-person-g2p.md) - [Unified Learners Passport (ULP)](https://rc.sunbird.org/v0.0.14/reference-solutions/unified-learners-passport-ulp.md): Unified Learners Passport (ULP) is a single source of digital credentials for learners across levels, that will help them easily discover and avail opportunities for academic or professional growth - [ULP Capabilities](https://rc.sunbird.org/v0.0.14/reference-solutions/unified-learners-passport-ulp/ulp-capabilities.md): The ULP software system contains capabilities of issuance, receipt and verification of learners’ credentials. - [Example Scenario](https://rc.sunbird.org/v0.0.14/reference-solutions/unified-learners-passport-ulp/example-scenario.md) - [Technical Components (WIP)](https://rc.sunbird.org/v0.0.14/reference-solutions/unified-learners-passport-ulp/technical-components-wip.md) - [Demo/Sandbox Links (WIP)](https://rc.sunbird.org/v0.0.14/reference-solutions/unified-learners-passport-ulp/demo-sandbox-links-wip.md) - [Installation Guide (WIP)](https://rc.sunbird.org/v0.0.14/reference-solutions/unified-learners-passport-ulp/installation-guide-wip.md) - [Frontend Setup](https://rc.sunbird.org/v0.0.14/reference-solutions/unified-learners-passport-ulp/installation-guide-wip/frontend-setup.md): Below is the link - [Installation through docker-compose](https://rc.sunbird.org/v0.0.14/reference-solutions/unified-learners-passport-ulp/installation-guide-wip/installation-through-docker-compose.md) - [Dummy records setup for refrence](https://rc.sunbird.org/v0.0.14/reference-solutions/unified-learners-passport-ulp/installation-guide-wip/dummy-records-setup-for-refrence.md) - [Reference links](https://rc.sunbird.org/v0.0.14/links/reference-links.md) - [Design](https://rc.sunbird.org/v0.0.14/links/design.md) - [Discussion Forum](https://rc.sunbird.org/v0.0.14/community/discussions.md): We have multiple channels available for the community to discuss use cases, as for support from fellow community members & discuss existing features as well as brainstorm about new ones. - [Contributing](https://rc.sunbird.org/v0.0.14/community/contributing.md) - [Contributors](https://rc.sunbird.org/v0.0.14/community/contributors.md) - [Contribution Guidebook](https://rc.sunbird.org/v0.0.14/community/contribution-guidebook.md) - [Code of Conduct](https://rc.sunbird.org/v0.0.14/community/code-of-conduct.md) - [Community Events](https://rc.sunbird.org/v0.0.14/community/community-events.md): This page will list the schedule of our community events & also provide recordings of past events. - [Status By Track](https://rc.sunbird.org/v0.0.14/community/status-by-track.md): The intent of this page is to give a high level status on various project tracks & reference implementations that are currently in progress. Complete details can be found on github project boards. - [Roadmap](https://rc.sunbird.org/v0.0.14/help/roadmap.md) - [FAQs](https://rc.sunbird.org/v0.0.14/help/faqs.md) - [Glossary](https://rc.sunbird.org/v0.0.14/help/terminology.md) ## v2.0.0 - [Introduction](https://rc.sunbird.org/learn/readme.md) - [Sunbird RC Overview](https://rc.sunbird.org/learn/readme-1.md) - [Why do we need Sunbird RC?](https://rc.sunbird.org/learn/readme-1/why-do-we-need-sunbird-rc.md) - [Core Capabilities](https://rc.sunbird.org/learn/readme-1/core-capabilities.md) - [Core Registry Verbs](https://rc.sunbird.org/learn/readme-1/core-registry-verbs.md) - [Workflows](https://rc.sunbird.org/learn/readme-1/workflows.md) - [What Sunbird RC is and what it's not? (WIP)](https://rc.sunbird.org/learn/readme-1/what-sunbird-rc-is-and-what-its-not-wip.md) - [Possibilities](https://rc.sunbird.org/learn/readme-1/possibilities.md) - [Demo Links](https://rc.sunbird.org/learn/readme-1/demo-links.md) - [Technical Overview](https://rc.sunbird.org/learn/technical-overview.md) - [Registry](https://rc.sunbird.org/learn/technical-overview/registry.md) - [High-Level architecture](https://rc.sunbird.org/learn/technical-overview/registry/high-level-architecture.md) - [Technical Specification Draft](https://rc.sunbird.org/learn/technical-overview/registry/technical-specification-draft.md) - [Tech Stack and Requirements](https://rc.sunbird.org/learn/technical-overview/registry/infrastructure-requirements.md) - [Credentialling](https://rc.sunbird.org/learn/technical-overview/credentialling.md) - [High-Level Architecture](https://rc.sunbird.org/learn/technical-overview/credentialling/high-level-architecture.md) - [Technical Specification Draft](https://rc.sunbird.org/learn/technical-overview/credentialling/technical-specification-draft.md) - [Tech Stack and Requirements](https://rc.sunbird.org/learn/technical-overview/credentialling/tech-stack-and-requirements.md) - [Adopters](https://rc.sunbird.org/learn/adopters.md): Sunbird RC has been leveraged to develop the following solutions: - [Roadmap](https://rc.sunbird.org/learn/roadmap.md) - [Getting started](https://rc.sunbird.org/use/getting-started.md) - [Pre-requisites](https://rc.sunbird.org/use/getting-started/developer-setup.md) - [Install Sunbird-RC](https://rc.sunbird.org/use/getting-started/install-sunbird-rc.md) - [Developer's Guide](https://rc.sunbird.org/use/developers-guide.md) - [Functional Registry](https://rc.sunbird.org/use/developers-guide/functional-registry.md) - [Installation Guide](https://rc.sunbird.org/use/developers-guide/functional-registry/installation-guide.md): The following steps will help you to setup SunbirdRC components for a local/development/production environment. - [Registry CLI](https://rc.sunbird.org/use/developers-guide/functional-registry/installation-guide/installation-guide.md): The following steps will help you to setup SunbirdRC components for a local/development environment. - [Setup A Registry Instance](https://rc.sunbird.org/use/developers-guide/functional-registry/installation-guide/installation-guide/setup-a-registry-instance.md) - [Manual installation through docker-compose](https://rc.sunbird.org/use/developers-guide/functional-registry/installation-guide/manual-installation-through-docker-compose.md): The following steps will install SunbirdRC via docker compose file - [Production setup through Helm](https://rc.sunbird.org/use/developers-guide/functional-registry/installation-guide/production-setup-through-helm.md): The below scripts will help the adopters to deploy SunbirdRC services in the Kubernetes environment. - [Working with Source Code](https://rc.sunbird.org/use/developers-guide/functional-registry/working-with-source-code.md) - [Configurations](https://rc.sunbird.org/use/developers-guide/functional-registry/configuration.md): Registry provides following configuration properties - [Frontend Configurations](https://rc.sunbird.org/use/developers-guide/functional-registry/configuration/frontend-configurations.md): Registry provides following configuration properties - [Frontend - Proxy configuration](https://rc.sunbird.org/use/developers-guide/functional-registry/configuration/frontend-proxy-configuration.md): This setting is required when you want to run an application in a local environment. - [Audit Configuration](https://rc.sunbird.org/use/developers-guide/functional-registry/configuration/audit-configuration.md): The following document describes about how audit on registry schema can be enabled - [Notifications Configuration](https://rc.sunbird.org/use/developers-guide/functional-registry/configuration/notifications-configuration.md) - [View Templates Configuration](https://rc.sunbird.org/use/developers-guide/functional-registry/configuration/view-templates-configuration.md): Sunbird RC provides a functionality to transform the entity response body with different transformation templates - [Schema Setup](https://rc.sunbird.org/use/developers-guide/functional-registry/schema-setup.md) - [Introduction To Schemas](https://rc.sunbird.org/use/developers-guide/functional-registry/schema-setup/introduction-to-schemas.md) - [Creating Your Own Schemas](https://rc.sunbird.org/use/developers-guide/functional-registry/schema-setup/creating-your-own-schemas.md) - [Schema Configuration](https://rc.sunbird.org/use/developers-guide/functional-registry/schema-setup/schema-configuration.md) - [Create Schemas With Custom Password](https://rc.sunbird.org/use/developers-guide/functional-registry/schema-setup/create-schemas-with-custom-password.md) - [Setup the Backend](https://rc.sunbird.org/use/developers-guide/functional-registry/setup-the-backend.md) - [Setup the Frontend](https://rc.sunbird.org/use/developers-guide/functional-registry/setup-the-frontend.md) - [Backup and Restore](https://rc.sunbird.org/use/developers-guide/functional-registry/backup-and-restore.md) - [PostgreSQL](https://rc.sunbird.org/use/developers-guide/functional-registry/backup-and-restore/postgresql.md) - [SQL Dump](https://rc.sunbird.org/use/developers-guide/functional-registry/backup-and-restore/postgresql/sql-dump.md) - [File System Level Backup](https://rc.sunbird.org/use/developers-guide/functional-registry/backup-and-restore/postgresql/file-system-level-backup.md) - [Continuous Archiving and Point-in-Time Recovery (PITR)](https://rc.sunbird.org/use/developers-guide/functional-registry/backup-and-restore/postgresql/continuous-archiving-and-point-in-time-recovery-pitr.md) - [Cassandra](https://rc.sunbird.org/use/developers-guide/functional-registry/backup-and-restore/cassandra.md) - [Snapshot-based backup method](https://rc.sunbird.org/use/developers-guide/functional-registry/backup-and-restore/cassandra/snapshot-based-backup-method.md) - [Incremental backup method](https://rc.sunbird.org/use/developers-guide/functional-registry/backup-and-restore/cassandra/incremental-backup-method.md) - [Data Restore](https://rc.sunbird.org/use/developers-guide/functional-registry/backup-and-restore/cassandra/data-restore.md) - [Generic Identity And Access Management](https://rc.sunbird.org/use/developers-guide/functional-registry/generic-identity-and-access-management.md): SunbirdRC was tightly coupled with keycloak for authentication & authorization of users. Currently, SunbirdRC is updated to support any identity layer (oauth2 compliant) for IAM - [Metrics](https://rc.sunbird.org/use/developers-guide/functional-registry/metrics.md): The following document describes how the metrics can be emitted through registry - [Custom Keycloak Build](https://rc.sunbird.org/use/developers-guide/functional-registry/custom-keycloak-build.md) - [Custom QR Code design](https://rc.sunbird.org/use/developers-guide/functional-registry/custom-qr-code-design.md): Sunbird RC support configuring a custom design for the QR code instead of a plain black coloured QR Code - [VC Verification Module](https://rc.sunbird.org/use/developers-guide/functional-registry/vc-verification-module.md): This is a common library created to be used in any Sunbird RC platform for VC verification. - [Credentialling Services](https://rc.sunbird.org/use/developers-guide/credentialling-services.md) - [Installation Guide](https://rc.sunbird.org/use/developers-guide/credentialling-services/installation-guide.md) - [Run for development](https://rc.sunbird.org/use/developers-guide/credentialling-services/installation-guide/run-for-development.md): Run identity, credential-schema and credentials services locally for development - [Docker compose based](https://rc.sunbird.org/use/developers-guide/credentialling-services/installation-guide/docker-compose-based.md) - [Helm based](https://rc.sunbird.org/use/developers-guide/credentialling-services/installation-guide/helm-based.md) - [Configurations](https://rc.sunbird.org/use/developers-guide/credentialling-services/configurations.md) - [Working with the Vault](https://rc.sunbird.org/use/developers-guide/credentialling-services/working-with-the-vault.md): This page is dedicated for the details of how to use hashicorp vault in sunbird rc using docker and what all the things related to it should we remember. - [Integrations](https://rc.sunbird.org/use/integrations.md) - [SSO with existing systems](https://rc.sunbird.org/use/integrations/sso-with-existing-systems.md) - [Digilocker Meripehchaan SSO](https://rc.sunbird.org/use/integrations/digilocker-meripehchaan-sso.md): This document will illustrate on how digilocker meripehchaan can be configured. - [Digilocker Integration](https://rc.sunbird.org/use/integrations/digilocker-integration.md): This document covers the process of integrating digilocker with SunbirdRC, to pull the credentials from SunbirdRC to digilocker wallet - [Connectors](https://rc.sunbird.org/use/connectors.md) - [G2P Connect](https://rc.sunbird.org/use/connectors/g2p-connect.md) - [Open ID for Verifiable Credentials (OID4VCI)](https://rc.sunbird.org/use/connectors/open-id-for-verifiable-credentials-oid4vci.md) - [Release Notes](https://rc.sunbird.org/use/latest-release-v1.0.0.md) - [Registry](https://rc.sunbird.org/use/latest-release-v1.0.0/release-notes.md) - [Credentialling](https://rc.sunbird.org/use/latest-release-v1.0.0/credentialling.md) - [Admin Portal](https://rc.sunbird.org/use/admin-portal.md) - [Login](https://rc.sunbird.org/use/admin-portal/login.md): Access Administrator/Tenant Portal - [Get Started](https://rc.sunbird.org/use/admin-portal/get-started.md): Access Administrator Portal - [Create Schema](https://rc.sunbird.org/use/admin-portal/get-started/create-schema.md) - [Attestation Workflows (WIP)](https://rc.sunbird.org/use/admin-portal/get-started/attestation-workflows-wip.md) - [VC Template](https://rc.sunbird.org/use/admin-portal/get-started/vc-template.md) - [Custom VC Template (WIP)](https://rc.sunbird.org/use/admin-portal/get-started/vc-template/verifiable-credential-template-wip.md) - [Ownership (WIP)](https://rc.sunbird.org/use/admin-portal/get-started/ownership-wip.md) - [Publish (WIP)](https://rc.sunbird.org/use/admin-portal/get-started/publish-wip.md): Publish Schema one at a time - [Dashboard](https://rc.sunbird.org/use/admin-portal/dashboard.md): The dashboard provides users with a comprehensive view of schema-related information, allowing seamless navigation and management of schema creation, exploration of APIs, and handling of VC. - [Registry APIs](https://rc.sunbird.org/api-reference/registry-apis.md) - [Registry](https://rc.sunbird.org/api-reference/registry-apis/registry.md) - [Using The APIs](https://rc.sunbird.org/api-reference/registry-apis/registry/using-the-apis.md) - [Create An Entity](https://rc.sunbird.org/api-reference/registry-apis/registry/create-an-entity.md): To create an entity, we need to make the following HTTP request - [Invite An Entity](https://rc.sunbird.org/api-reference/registry-apis/registry/invite-an-entity.md): To invite an entity, we need to make the following HTTP request - [Generate token](https://rc.sunbird.org/api-reference/registry-apis/registry/authenticating-as-an-entity.md) - [Generate admin token](https://rc.sunbird.org/api-reference/registry-apis/registry/generate-admin-token.md) - [Get An Entity](https://rc.sunbird.org/api-reference/registry-apis/registry/get-an-entity.md): To get an entity created by the owner, we need to make the following HTTP request - [Get An Entity By Id](https://rc.sunbird.org/api-reference/registry-apis/registry/get-an-entity-by-id.md): To get an entity, we need to make the following HTTP request - [Update An Entity](https://rc.sunbird.org/api-reference/registry-apis/registry/update-an-entity.md): To update an entity, we need to make the following HTTP request - [Create A Property Of An Entity](https://rc.sunbird.org/api-reference/registry-apis/registry/create-a-property-of-an-entity.md): To add property to an existing entity, we need to make the following HTTP request - [Update A Property Of An Entity](https://rc.sunbird.org/api-reference/registry-apis/registry/update-a-property-of-an-entity.md): To update the property of an existing entity, we need to make the following HTTP request - [Revoke a Credential](https://rc.sunbird.org/api-reference/registry-apis/registry/create-a-property-of-an-entity-1.md): To revoke an existing VC (Verifiable Credential) or an entity, we need to make the following HTTP request - [Delete An Entity](https://rc.sunbird.org/api-reference/registry-apis/registry/delete-an-entity.md): To soft delete an entity, we need to make the following HTTP request - [Schema](https://rc.sunbird.org/api-reference/registry-apis/schema.md) - [Create Schema](https://rc.sunbird.org/api-reference/registry-apis/schema/create-schema.md) - [Get Schema](https://rc.sunbird.org/api-reference/registry-apis/schema/get-schema.md) - [Update Schema](https://rc.sunbird.org/api-reference/registry-apis/schema/update-schema.md) - [Delete Schema](https://rc.sunbird.org/api-reference/registry-apis/schema/delete-schema.md) - [Publish A Schema](https://rc.sunbird.org/api-reference/registry-apis/schema/publish-a-schema.md) - [Attestation API](https://rc.sunbird.org/api-reference/registry-apis/attestation-api.md) - [Raise An Attestation](https://rc.sunbird.org/api-reference/registry-apis/attestation-api/raise-an-attestation.md) - [Get Attestation Certificate](https://rc.sunbird.org/api-reference/registry-apis/attestation-api/get-attestation-certificate.md) - [Claims API](https://rc.sunbird.org/api-reference/registry-apis/claims-api.md) - [Get All Claims](https://rc.sunbird.org/api-reference/registry-apis/claims-api/get-all-claims.md) - [Get Claim by ID](https://rc.sunbird.org/api-reference/registry-apis/claims-api/get-claim-by-id.md) - [Attest A Claim](https://rc.sunbird.org/api-reference/registry-apis/claims-api/attest-a-claim.md) - [Discovery API](https://rc.sunbird.org/api-reference/registry-apis/discovery-api.md) - [Search An Entity](https://rc.sunbird.org/api-reference/registry-apis/discovery-api/search-an-entity.md) - [File Storage API](https://rc.sunbird.org/api-reference/registry-apis/file-storage-api.md) - [Upload A File](https://rc.sunbird.org/api-reference/registry-apis/file-storage-api/upload-a-file.md) - [Get Uploaded File](https://rc.sunbird.org/api-reference/registry-apis/file-storage-api/get-uploaded-file.md) - [Delete A File/ Multiple Files](https://rc.sunbird.org/api-reference/registry-apis/file-storage-api/delete-a-file-multiple-files.md) - [Metrics APIs](https://rc.sunbird.org/api-reference/registry-apis/metrics-apis.md) - [Get Count](https://rc.sunbird.org/api-reference/registry-apis/metrics-apis/get-count.md) - [Get Aggregates](https://rc.sunbird.org/api-reference/registry-apis/metrics-apis/get-aggregates.md) - [Credentialling APIs](https://rc.sunbird.org/api-reference/credentialling-apis.md) - [Identity Service APIs](https://rc.sunbird.org/api-reference/credentialling-apis/identity-service-apis.md) - [Credential Schema APIs](https://rc.sunbird.org/api-reference/credentialling-apis/credential-schema-apis.md) - [Credential Issuance APIs](https://rc.sunbird.org/api-reference/credentialling-apis/credential-issuance-apis.md) - [Other APIs](https://rc.sunbird.org/api-reference/other-apis.md) - [Sign API](https://rc.sunbird.org/api-reference/other-apis/sign-api.md) - [Verify API](https://rc.sunbird.org/api-reference/other-apis/verify-api.md) - [Swagger JSON API](https://rc.sunbird.org/api-reference/other-apis/swagger-json-api.md) - [Health API](https://rc.sunbird.org/api-reference/other-apis/health-api.md) - [Education](https://rc.sunbird.org/reference-solutions-for-functional-registries/education.md) - [Education Ecosystem](https://rc.sunbird.org/reference-solutions-for-functional-registries/education/education-ecosystem.md) - [Installation](https://rc.sunbird.org/reference-solutions-for-functional-registries/education/education-ecosystem/installation.md) - [Education Registries](https://rc.sunbird.org/reference-solutions-for-functional-registries/education/edu-registries.md) - [Installation](https://rc.sunbird.org/reference-solutions-for-functional-registries/education/edu-registries/installation.md) - [User Guide](https://rc.sunbird.org/reference-solutions-for-functional-registries/education/edu-registries/user-guide.md) - [Health Registries](https://rc.sunbird.org/reference-solutions-for-functional-registries/health-registries.md) - [Organ Registries](https://rc.sunbird.org/reference-solutions-for-functional-registries/health-registries/organ-registries.md) - [Frontend Setup](https://rc.sunbird.org/reference-solutions-for-functional-registries/health-registries/organ-registries/frontend-setup.md) - [Backend Setup](https://rc.sunbird.org/reference-solutions-for-functional-registries/health-registries/organ-registries/backend-setup.md) - [User Guide](https://rc.sunbird.org/reference-solutions-for-functional-registries/health-registries/organ-registries/user-guide.md) - [Health Facility Registry](https://rc.sunbird.org/reference-solutions-for-functional-registries/health-registries/health-facility-registry.md) - [Govt to Person (G2P)](https://rc.sunbird.org/reference-solutions-for-functional-registries/govt-to-person-g2p.md) - [Certificate Issuance](https://rc.sunbird.org/reference-solutions-for-digital-credentials/certificate-issuance.md) - [Installation(WIP)](https://rc.sunbird.org/reference-solutions-for-digital-credentials/certificate-issuance/installation-wip.md) - [User Guide](https://rc.sunbird.org/reference-solutions-for-digital-credentials/certificate-issuance/portal-user-guide.md) - [eLocker](https://rc.sunbird.org/reference-solutions-for-digital-credentials/elocker.md) - [High Level Diagram](https://rc.sunbird.org/reference-solutions-for-digital-credentials/elocker/digital-locker.md) - [Installation (WIP)](https://rc.sunbird.org/reference-solutions-for-digital-credentials/elocker/installation-wip.md) - [Frontend Setup E-locker](https://rc.sunbird.org/reference-solutions-for-digital-credentials/elocker/installation-wip/frontend-setup-e-locker.md) - [User Guide](https://rc.sunbird.org/reference-solutions-for-digital-credentials/elocker/user-guide.md) - [Vaccination Platform](https://rc.sunbird.org/reference-solutions-for-digital-credentials/vaccination.md) - [Skills & Work Credentials](https://rc.sunbird.org/reference-solutions-for-digital-credentials/skill-and-work-credentials-platform.md) - [Unified Learners Passport (ULP)](https://rc.sunbird.org/reference-solutions-for-digital-credentials/unified-learners-passport-ulp.md): Unified Learners Passport (ULP) is a single source of digital credentials for learners across levels, that will help them easily discover and avail opportunities for academic or professional growth - [ULP Capabilities](https://rc.sunbird.org/reference-solutions-for-digital-credentials/unified-learners-passport-ulp/ulp-capabilities.md): The ULP software system contains capabilities of issuance, receipt and verification of learners’ credentials. - [Example Scenario](https://rc.sunbird.org/reference-solutions-for-digital-credentials/unified-learners-passport-ulp/example-scenario.md) - [Technical Components (WIP)](https://rc.sunbird.org/reference-solutions-for-digital-credentials/unified-learners-passport-ulp/technical-components-wip.md) - [Demo/Sandbox Links (WIP)](https://rc.sunbird.org/reference-solutions-for-digital-credentials/unified-learners-passport-ulp/demo-sandbox-links-wip.md) - [Installation Guide (WIP)](https://rc.sunbird.org/reference-solutions-for-digital-credentials/unified-learners-passport-ulp/installation-guide-wip.md) - [Frontend Setup](https://rc.sunbird.org/reference-solutions-for-digital-credentials/unified-learners-passport-ulp/installation-guide-wip/frontend-setup.md): Below is the link - [Installation through docker-compose](https://rc.sunbird.org/reference-solutions-for-digital-credentials/unified-learners-passport-ulp/installation-guide-wip/installation-through-docker-compose.md) - [Dummy records setup for refrence](https://rc.sunbird.org/reference-solutions-for-digital-credentials/unified-learners-passport-ulp/installation-guide-wip/dummy-records-setup-for-refrence.md) - [Reference links](https://rc.sunbird.org/links/reference-links.md) - [Design](https://rc.sunbird.org/links/design.md) - [Discussion Forum](https://rc.sunbird.org/community/discussions.md): We have multiple channels available for the community to discuss use cases, as for support from fellow community members & discuss existing features as well as brainstorm about new ones. - [Contributors](https://rc.sunbird.org/community/contributors.md) - [Contributing](https://rc.sunbird.org/community/contributing.md) - [Contribution Guidebook](https://rc.sunbird.org/community/contribution-guidebook.md) - [Code of Conduct](https://rc.sunbird.org/community/code-of-conduct.md) - [Community Events](https://rc.sunbird.org/community/community-events.md): This page will list the schedule of our community events & also provide recordings of past events. - [Status By Track](https://rc.sunbird.org/community/status-by-track.md): The intent of this page is to give a high level status on various project tracks & reference implementations that are currently in progress. Complete details can be found on github project boards. - [Roadmap](https://rc.sunbird.org/help/roadmap.md) - [FAQs](https://rc.sunbird.org/help/faqs.md) - [Glossary](https://rc.sunbird.org/help/terminology.md) - [Guide to Electronic Registries and Verifiable Credentials](https://rc.sunbird.org/help/comprehensive-overview-electronic-registries-and-verifiable-credentials.md) - [Verifiable Credentials](https://rc.sunbird.org/help/comprehensive-overview-electronic-registries-and-verifiable-credentials/verifiable-credentials.md) - [What issues will Verifiable Credentials address?](https://rc.sunbird.org/help/comprehensive-overview-electronic-registries-and-verifiable-credentials/verifiable-credentials/what-issues-will-verifiable-credentials-address.md) - [What are the key roles in Verifiable Credentials?](https://rc.sunbird.org/help/comprehensive-overview-electronic-registries-and-verifiable-credentials/verifiable-credentials/what-are-the-key-roles-in-verifiable-credentials.md) - [What are the components of Verifiable Credentials?](https://rc.sunbird.org/help/comprehensive-overview-electronic-registries-and-verifiable-credentials/verifiable-credentials/what-are-the-components-of-verifiable-credentials.md) - [What are the benefits of Verifiable Credentials?](https://rc.sunbird.org/help/comprehensive-overview-electronic-registries-and-verifiable-credentials/verifiable-credentials/what-are-the-benefits-of-verifiable-credentials.md) - [Digital Credentials vs Verifiable Credentials](https://rc.sunbird.org/help/comprehensive-overview-electronic-registries-and-verifiable-credentials/verifiable-credentials/digital-credentials-vs-verifiable-credentials.md) - [QR code vs Verifiable QR code](https://rc.sunbird.org/help/comprehensive-overview-electronic-registries-and-verifiable-credentials/verifiable-credentials/qr-code-vs-verifiable-qr-code.md) - [Use Cases](https://rc.sunbird.org/help/comprehensive-overview-electronic-registries-and-verifiable-credentials/verifiable-credentials/use-cases.md) - [Electronic Registries](https://rc.sunbird.org/help/comprehensive-overview-electronic-registries-and-verifiable-credentials/electronic-registries.md) - [Evolution of Electronic Registries](https://rc.sunbird.org/help/comprehensive-overview-electronic-registries-and-verifiable-credentials/electronic-registries/evolution-electronic-registries.md) - [What issues will Electronic Registries address?](https://rc.sunbird.org/help/comprehensive-overview-electronic-registries-and-verifiable-credentials/electronic-registries/what-issues-will-electronic-registries-address.md) - [Benefits of Electronic Registries](https://rc.sunbird.org/help/comprehensive-overview-electronic-registries-and-verifiable-credentials/electronic-registries/benefits-of-electronic-registries.md) - [Registry vs Database](https://rc.sunbird.org/help/comprehensive-overview-electronic-registries-and-verifiable-credentials/electronic-registries/registry-vs-database.md) - [Design Principles](https://rc.sunbird.org/help/comprehensive-overview-electronic-registries-and-verifiable-credentials/electronic-registries/design-principles.md) - [Use Cases](https://rc.sunbird.org/help/comprehensive-overview-electronic-registries-and-verifiable-credentials/electronic-registries/use-cases.md) - [Leveraging Existing data stores](https://rc.sunbird.org/help/comprehensive-overview-electronic-registries-and-verifiable-credentials/leveraging-existing-data-stores-directories.md): leverage existing trustworthy sources of data to accelerate registry implementation - [External Open Source Software Attributions](https://rc.sunbird.org/help/external-open-source-software-attributions.md) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on a page URL with the `ask` query parameter: ``` GET https://rc.sunbird.org/learn/readme.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.