Setup A Registry Instance

Initialize registry

Now that you have the Registry CLI installed, we can create a new instance of a registry!

Run the following command in a directory where you wish to setup the registry. For this example, we will use ~/Registries/example/. (~ is short form for the user's home directory).

# Create and move into the ~/Registries/example directory
mkdir -p ~/Registries/example
cd ~/Registries/example
# Create a registry instance
registry init

This will present you with a set of questions to setup the registry. For the purpose of this getting started guide, you can hit enter and use the default values for the registry. Please follow the references below

  • Registry Version

registry version
  • Auxiliary Services

The registry provides a set of auxiliary services that you can use in addition to the core registry. To select or deselect any of these services, use the SPACE BAR.

Reference solutions for digital credentialing, including administration or issuance portals, are available in Auxiliary services.

  • Type of QR

When VC Issuance is enabled, you'll be prompted to choose the type of QR code to generate on your certificates.

registry init - v1.0.0

Registry Status

Once the registry init is successfully initialized, the status of all the services can be checked using

registry status

The above command should return the status of all the services, like below

Make sure that the status of all the services is in the running state. If any of the services are in exited status you can restart only that particular service.

docker-compose restart <service-name>

To restart the registry use the below command

SCHEMA_DIR=config/schemas docker-compos up -d --force-recreate --no-deps registry

Registry Down

To stop the running services, you can use the below command

registry down

Last updated