Pre-requisites
Last updated
Was this helpful?
Last updated
Was this helpful?
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 Git can be found .
Run git --version
in the terminal to check if git
has been installed correctly:
Installation instructions for Java 8 can be found .
Run java
in the terminal to check if java
has been installed correctly:
Run node -v
in the terminal to check if node
has been installed correctly:
Run docker -v
in terminal to check if docker
has been installed correctly:
Run docker-compose -v
in terminal to check if docker-compose
has been installed correctly:
Run the following in terminal to download the registry's source code:
Move into the folder by typing:
Run the configure-dependencies.sh
script in the root of the repo as follows:
Then compile the registry (this will take some time when you are running it for the first time):
This should create a JAR file in the java/registry/target
folder.
Create _schemas/
folder in java/registry/src/main/resources/public/
Place all your schema files in the java/registry/src/main/resources/public/_schemas/
folder.
To download a minimal keycloak configuration, run the following:
Then start Keycloak (kc
), Postgres (db
), Elastic Search (es
) and the Claims Service (cs
) by running the following command:
Before we can start the registry, we need to regenerate and retrieve the client secret for the admin-api
client in Keycloak. To do that, follow these steps:
Go to http://localhost:8080/auth/admin/master/console/#/realms.
Login using the username admin
and password admin
.
Click Sunbird RC
.
Click Clients
in the panel on the left.
Click admin-api
.
Click the Credentials
tab.
Under Client Secret
, click Regenerate Secret
. Copy the secret that you see in the box and paste it in the docker-compose.yml
file in place of INSERT_SECRET_HERE
on line 42.
Once you have completed all the above steps, run the registry using the following command:
Installation instructions for NodeJS can be found .
Installation instructions for Docker can be found .
Installation instructions can be found .
A sample set of schemas for a simple student-teacher registry can be found . You can learn how to write your own schemas by following .
Run the following in terminal to download Docker Compose file: