For the complete documentation index, see llms.txt. This page is also available as Markdown.

Docker Compose Setup

System requirements: 4 cores · 8 GB RAM · 100 GB disk minimum — same as the Registry CLI path.

1

Get the compose file and environment template

Download the latest docker-compose.yml and modify values as needed. Then download or create a .env file from the .env.example template.

2

Set the required environment variables

ENV
Value
Description

RELEASE_VERSION

v2.1.0

Use the latest release of Sunbird RC.

SCHEMA_DIR

schemas

Relative path to the directory where schemas are created.

3

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.

4

Set up Keycloak

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.

5

Start everything and verify

docker-compose up -d
docker-compose ps

The registry swagger JSON is then available at http://localhost:8081/api/docs/swagger.json.

Last updated