> 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/getting-started/installation/docker-compose-setup.md).

# Docker Compose Setup

{% hint style="info" %}
**System requirements**: 4 cores · 8 GB RAM · 100 GB disk minimum — same as the Registry CLI path.
{% endhint %}

{% stepper %}
{% step %}

### Get the compose file and environment template

Download the latest [docker-compose.yml](https://github.com/Sunbird-RC/sunbird-rc-core/blob/main/docker-compose.yml) and modify values as needed. Then download or create a `.env` file from the [`.env.example`](https://github.com/Sunbird-RC/sunbird-rc-core/blob/main/.env.example) template.
{% endstep %}

{% step %}

### Set the required environment variables

| ENV               | Value     | Description                                                                                     |
| ----------------- | --------- | ----------------------------------------------------------------------------------------------- |
| `RELEASE_VERSION` | `v2.1.0`  | Use the latest [release](https://github.com/Sunbird-RC/sunbird-rc-core/releases) of Sunbird RC. |
| `SCHEMA_DIR`      | `schemas` | Relative path to the directory where schemas are created.                                       |
| {% endstep %}     |           |                                                                                                 |

{% step %}

### Add schemas and imports

Create the schema files in the `schemas` directory. Then create an `imports` directory and download the Keycloak realm file and the sample signing key file into it.

{% hint style="warning" %}
The sample signing keys are for local use only — replace them before going to production.
{% endhint %}
{% endstep %}

{% step %}

### Set up Keycloak

```bash
docker-compose up -d db
docker-compose up -d keycloak
```

Open the Keycloak admin console at `http://localhost:8080/auth/`, go to **Clients** → `admin-api` → **Credentials** → **Regenerate Secret**, copy the value, and set `KEYCLOAK_SECRET` in `.env` with it.
{% endstep %}

{% step %}

### Start everything and verify

```bash
docker-compose up -d
docker-compose ps
```

The registry swagger JSON is then available at `http://localhost:8081/api/docs/swagger.json`.
{% endstep %}
{% endstepper %}


---

# 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/getting-started/installation/docker-compose-setup.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.