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

Registry CLI

System requirements: 4 cores · 8 GB RAM · 100 GB disk minimum.

This guide assumes some familiarity with basic Linux commands. Don't copy-paste the $ signs — they indicate that what follows is a terminal command.

1

Install the Registry CLI

$ npm install --global @sunbird-rc/registry-cli

If you hit a permission-denied error, prefix the command with sudo:

$ sudo npm install --global @sunbird-rc/registry-cli

Check the install:

$ registry help
2

Set up a registry instance

Run the following in a directory where you wish to set up the registry (~/Registries/example/ in this example):

$ mkdir -p ~/Registries/example
$ cd ~/Registries/example
$ registry init

This presents a set of questions to configure the registry — registry version, auxiliary services (toggle with SPACE BAR), and the QR code type to generate on certificates when signing is enabled. You can accept the defaults for a first run.

3

Check the registry status

$ registry status

Confirm every service shows as running. If a service shows exited, restart just that service:

$ docker-compose restart <service-name>

To force-recreate the registry service after a config or schema change:

$ SCHEMA_DIR=config/schemas docker-compose up -d --force-recreate --no-deps registry
4

Stop the registry

$ registry down

Last updated