> 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/use/developer-guide.md).

# Developer Guide

Building on, configuring, and operating Sunbird RC.

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Working with Source Code</strong></td><td>Compile and run the registry from <code>sunbird-rc-core</code>, and switch feature services on.</td><td><a href="/use/developer-guide/working-with-source-code.md">Working with Source Code</a></td></tr><tr><td><strong>Environment Variable Reference</strong></td><td>Every registry-core and service environment variable, by service.</td><td><a href="/use/developer-guide/environment-variable-reference.md">Environment Variable Reference</a></td></tr><tr><td><strong>Configuration Reference</strong></td><td>Frontend, proxy, audit, notification and view-template config files.</td><td><a href="/use/developer-guide/configuration-reference.md">Configuration Reference</a></td></tr><tr><td><strong>Schema Setup</strong></td><td>Define entities, write schemas, and configure <code>_osConfig</code>.</td><td><a href="/use/developer-guide/schema-setup.md">Schema Setup</a></td></tr><tr><td><strong>Setup Backend</strong></td><td>Where the repos, deployment files and schema directory live.</td><td><a href="/use/developer-guide/setup-backend.md">Setup Backend</a></td></tr><tr><td><strong>Setup Frontend</strong></td><td>Run and configure the Angular registry UI.</td><td><a href="/use/developer-guide/setup-frontend.md">Setup Frontend</a></td></tr><tr><td><strong>Backup and Restore</strong></td><td>PostgreSQL and Cassandra backup methods and restore paths.</td><td><a href="/use/developer-guide/backup-and-restore.md">Backup and Restore</a></td></tr><tr><td><strong>Generic IAM</strong></td><td>Use any OAuth2-compliant identity layer, not just Keycloak.</td><td><a href="/use/developer-guide/generic-iam.md">Generic IAM</a></td></tr><tr><td><strong>Metrics</strong></td><td>Emit and aggregate registry events via Kafka or file.</td><td><a href="/use/developer-guide/metrics.md">Metrics</a></td></tr><tr><td><strong>Custom Keycloak Build</strong></td><td>Build the Sunbird RC Keycloak image with toggleable NONCE validation.</td><td><a href="/use/developer-guide/custom-keycloak-build.md">Custom Keycloak Build</a></td></tr><tr><td><strong>VC Verification Module</strong></td><td>Drop-in QR scanning and VC verification for Angular frontends.</td><td><a href="/use/developer-guide/vc-verification-module.md">VC Verification Module</a></td></tr></tbody></table>


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://rc.sunbird.org/use/developer-guide.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
