-
Notifications
You must be signed in to change notification settings - Fork 44
Installation
- Java - 8+
- Git
git clone https://github.com/project-sunbird/open-saber.git
cd open-saber
sh configure-dependencies.shCAUTION: This installs the default configuration. Please create your own definitions in separate files (not in the default files) to prevent inadvertent over-writes.
cd java
mvn clean installAuthentication can be enabled/disabled in the application.yml configuration file mentioned in understanding configuration files section below. The default implementation uses Sunbird's authentication mechanism which is using keycloak for authentication. Keycloak installation details can be found here. Authentication requires the below mentioned environment variables to be configured. Instructions to set up the SSO key can be found here.
sunbird_sso_publickey = ******
sunbird_sso_realm=sunbird
sunbird_sso_url=https://dev.open-sunbird.org/auth/
The default configuration files provided will be sufficient to start a registry instance. The default registry schema provided is for a Teacher registry.
Edit the configuration files or create your own custom configuration files and configure the path. Read understanding configuration files in the section below. If you just want to try it out, then skip this section and come back to it later.
-
Configuring custom configuration files
-
Read understanding configuration files in the section below to create your own configuration files
-
Add environment variables pointing to the configuration files.
-
registry_config_dir=file://...
config_schema_file=${registry_config_dir}schema-configuration.jsonld
validations_create_file=${registry_config_dir}validations_create.shex
validations_update_file=${registry_config_dir}validations_update.shex
frame_file=${registry_config_dir}frame.json
audit_frame_file=${registry_config_dir}audit_frame.json
All dependencies are now installed. All required sample configuration files are also created and if you don't want to change anything, you may simply follow the following steps to start up an OpenSABER instance as a Teacher Registry.
In order to run using docker you need to install docker in your system. In the case of Linux systems, docker compose also needs to be installed.
cd registry
docker-compose upcd registry/target
java -jar registry.jarBelow mentioned configuration files should be created in src/main/resources. The script ./configure-dependencies.sh will create the files to startup a full fledged Teacher Registry, but you can edit these files to suit your domain. The sample files contain comments which further explain each property.
-
application.yml - Create a YAML configuration file which contains various environment specific configurations for the application. The default profile will be development environment. The spring.profiles.active configuration needs to be changed to the environment where the application is deployed. Sample configuration details can be found in application.yml.sample.
-
[Person|Teacher|Vehicle]*.json - These files contain static and declarative validations. For further details on syntax, you can refer to the JSON Schema. Link to these samples is here.
-
schema-configuration.json - This file contain schema level configurations. We like to make this at one place, along with the definition itself in future. Further details can be found in schema-configuration.jsonld.sample.
-
frame.json - This file is useful to frame the JSONLD output so that all the facts are nested instead of being flatly presented. This helps in readability. You may ignore if you're not interested in Linked Data. frame.json.sample contains short-hand names, their namespaces and the the primary type used throughout the JSON-LD document that is issued into the registry. We expect to make subtle changes to help adopters embrace this technology conveniently. There is some work pending to simplify this.
-
audit_frame.json - If audit is enabled in application.yml, this file is useful to frame the audit records so that all the facts are nested instead of being flatly presented. audit_frame.json.sample contains short-hand names, and their namespaces used throughout the audit record that is issued into the registry.
The following is a list of configuration options which can be tailored for a specific instance of OpenSABER. All these properties are environment variables and hence can be configured either in .bashrc or in Windows environment properties. Most of the properties have sensible defaults.
-
perf_monitoring_enabled - This property is used to enable/disable performance instrumentation to performance tune various APIs.
-
registry_context_base - The primary namespace IRI of the registry instance. It will default to
http://localhost:8080/. -
registry_system_base - The namespace IRI for audit records. This will default to
http://localhost:8080/opensaber. -
config_schema_file - The fully qualified filename with the
file://protocol prefix for configuring fields that need to be encrypted. The default filename will beschema-configuration.jsonldand will be loaded from the classpath. This file will be in JSON-LD format. -
database - The storage database provider for the OpenSABER instance. The default database will be
NEO4J. Refer to application.yml for more details. -
frame_file - The Full qualified filename with the
file://protocol prefix for framing a record read from the database. The default value will beframe.jsonand will be loaded from the classpath. For further details, you can refer to understanding configuration files above. -
connection_timeout - Encryption service connection timeout in milliseconds.
-
connection_request_timeout - Encryption service connection request timeout in milliseconds.
-
read_timeout - Encryption service socket read timeout in milliseconds.
-
encryption_enabled - Toggle for enabling/disabling encryption.
-
encryption_base - The base URL for encryption/decryption service.
-
encryption_uri - The fully qualified URI for encrypting data.
-
encryption_batch_uri - The fully qualified URL to encrypt data in batch mode.
-
decryption_uri - The fully qualified URI for decrypting data.
-
decryption_batch_uri - The fully qualified URL to decrypt data in batch mode.
-
audit_enabled - Toggle to enable/disable internal audit. The audit records will be stored as part of the primary database.
-
audit_frame_file - The fully qualified filename with the
file://protocol prefix for framing an audit record read from the database. The default value will beaudit_frame.jsonand will be loaded from the classpath. For further details, you can refer to understanding configuration files above. -
authentication_enabled - Toggle to enable/disable authentication. The authentication is disabled by default. The default authentication provider is the Sunbird Keycloak service.
-
sunbird_sso_publickey - The public key of the Sunbird Keycloak authentication service.
-
sunbird_sso_realm - The SSO realm of the Sunbird Keycloak authentication service.
-
sunbird_sso_url - The fully qualified URL of the authentication service.
Create a domain specific vocabulary file for the application. Sample vocabulary file can be found vocabulary.owl.sample. This file should be placed in src/main/resources/vocabulary, so that it can be served as a static resource. This is useful for machine readability of your registry and also helps in understanding various terms being used in the vocabulary. This file needs to be hand-created by an adopter. We are looking to simplify this in future. You may ignore this if you're not looking for machine readable or Linked Data presently. We will help you get there with our next few releases.
OpenSABER API specs and OpenSABER API Examples give detailed descriptions on how to use the APIs in Registry.