> For the complete documentation index, see [llms.txt](https://rc.sunbird.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://rc.sunbird.org/v0.0.14/developer-documentation.md). # Developer Documentation - [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. --- # 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 that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://rc.sunbird.org/v0.0.14/developer-documentation.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. 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.