Manual installation through docker-compose
The following steps will install SunbirdRC via docker compose file
Last updated
The following steps will install SunbirdRC via docker compose file
Last updated
4 Cores
8 GB RAM
Min 100 GB disk
This guide assumes a some familiarity with basic linux commands. If not, is a great place to start.
Don't copy-paste the
$signs, they indicate that what follows is a terminal command
Linux and MacOS will have a terminal installed already. For Windows, it is recommended that you use git-bash, which you can install from .
Type echo Hi in the terminal once it is installed. If installed correctly, you should see Hi appear when you hit enter.
Installation instructions for Docker can be found .
Run docker -v in terminal to check if docker has been installed correctly:
Run docker compose version in the terminal to check if docker compose has been installed correctly:
Add the below environment variables to .env file
RELEASE_VERSION
v0.0.14
SCHEMA_DIR
schemas
Relative path to the directory where schemas are created
Create a directory imports
Steps to setup keycloak:
Start the database container
docker-compose up -d db
Start the keycloak container
docker-compose up -d keycloak
Goto Clients -> admin-api -> Credentials
Click on Regenerate Secret and copy the new value
Set KEYCLOAK_SECRET with the copied value in .env file
Start all the services, docker-compose up -d
Check if all the services are started using docker-compose ps
Installation instructions can be found .
Download the latest docker-compose file . Modify the values inside the compose file based on the requirements. More details on the configurations can be found .
Download or create a .env file.
Use the latest release version of SunbirdRC.
Create the files in the schemas directory
Download the file in imports directory
Download the file in imports directory. Please note to update the signing keys before going to production.
Open the keycloak admin console ``
Access the registry swagger json ``\