|
boolean value which determines whether notification is to be sent or not |
|
url which will be used to send notification url |
| registry_perRequest_indexCreation_enabled |
boolean value which determines if index needs to be created at database level |
| external_entities |
comma separated strings of external entities |
| workflow.enable |
boolean value to enable or disable the workflow i.e attestation policy |
| async_enabled |
create entities asynchronously |
| kafka_create_entity_topic |
if async_enabled, then this property defines the topic name to which new async requests are pushed |
| kafka_post_create_entity_topic |
if async is enabled, then this property defines the topic name to which the response of create-entity is pushed |
| search_offset |
this is the default offset that will be used while searching, |
| search_limit |
this is the default limit that will be used or the max value that can be used to as a limit in the search |
| search_expandInternal |
boolean value, if set true, all the search results will be expanded to include internal objects. |
| database_provider |
this property states which database is to be used. Providers available are NEO4J, SQLG, CASSANDRA, ORIENTDB, TINKERGRAPH (in-memory) |
| connectionInfo_uri |
url to connect to database. eg Postgres - jdbc:postgresql://localhost:5432/yourdb |
| connectionInfo_username |
username to be used to connect to database |
| connectionInfo_password |
password to be used to connect to database |
| connectionInfo_maxPoolSize |
Database connection pool size |
| verify_url |
this url will be used to verify the issued VC. point it to {certification_signer}/verify |
| certificate_health_check_url |
certificate api service's health check url |
| template_folder_path |
path from which default template will be loaded if no external template is provided. File name should be the name_of_schema.appropriate_extention The location should be in resources folder |
| audit_enabled |
This audit configuration will enable audit logging in the system |
| audit_frame_store |
FILE : Store the audit log in files.
DATABASE : Store the audit log in the primary database configured and in elastic search if it's enabled |
| audit_suffix |
suffix which is used for schema name to store audit information for a particular entity type |
| audit_suffixSeparator |
separator between entity name and audit_suffix |
| keycloack_user_email_actions |
email actions which will be trigger by keycloak example email actions: VERIFY_EMAIL, UPDATE_PROFILE, UPDATE_PASSWORD,TERMS_AND_CONDITIONS etc. email details should be configured in keycloak realm settings |
| validation_enabled |
boolean property to check for request body to be validated in specific format |
| validation_type |
type in which request body needs to be validated. eg JSON |
| service_connection_timeout |
Set the connection timeout in milliseconds for the underlying request configuration |
| service_connection_request_timeout |
Set the timeout in milliseconds used when requesting a connection from the connection manager using the underlying request Configuration |
| service_read_timeout |
Set the socket read timeout in milliseconds for the underlying request configuration |
| http_max_connections |
maximum http connections |
| taskExecutor_index_threadPoolName |
Specify the prefix to use for the names of newly created threads. |
| taskExecutor_index_corePoolSize |
Set the ThreadPoolExecutor's core pool size. |
| taskExecutor_index_maxPoolSize |
Set the ThreadPoolExecutor's maximum pool size. |
| taskExecutor_index_queueCapacity |
Set the capacity for the ThreadPoolExecutor's BlockingQueue. |
| auditTaskExecutor_threadPoolName |
Specify the prefix to use for the names of newly created threads. |
| auditTaskExecutor_corePoolSize |
Set the ThreadPoolExecutor's core pool size. |
| auditTaskExecutor_maxPoolSize |
Set the ThreadPoolExecutor's maximum pool size. |
| auditTaskExecutor_queueCapacity |
Set the capacity for the ThreadPoolExecutor's BlockingQueue. |
| elastic_search_connection_url |
url for elastic search connection if elastic search is enabled. Elastic search is enabled using search_providerName |
| search_providerName |
The search mechanism to use. Values could be either NativeSearchService or ElasticSearchService. If NativeSearchService, then every search API uses the same database as the writes. May not offer high speed reads. This is the default search service, if this config is not provided. If ElasticSearchService, then Elastic search is used. |
| sunbird_sso_realm |
keycloak realm name to be used for authentication and authorization |
| sunbird_sso_url |
keycloak connection url |
| sunbird_sso_admin_client_id |
client id to be used as admin |
| sunbird_sso_admin_client_secret |
secret key of keycloak admin client set by using sunbird_sso_admin_client_id |
| claims_url |
url in order to connect to claims service |
| sign_url |
url in order to connect to certificate signer to sign the document |
| sign_health_check_url |
certificate signer health check url |
| signature_enabled |
boolean value which determines whether signature is to be created for a document |
| pdf_url |
url to fetch certificate from certificate api service |
| certificate_health_check_url |
certificate api health check url |
| template_base_url |
api endpoint to get default templates stored in sunbird-rc |
| sunbird_keycloak_user_set_password |
boolean value to default password for user/owner of entity in keycloak |
| filestorage_connection_url |
minio connection url to store files |
| filestorage_access_key |
access key of minio |
| filestorage_secret_key |
secret key of minio |
| filestorage_bucket_key |
bucket name where to store the files in minio |
| registry_base_apis_enable |
if enabled the exisitng /add /update apis will be enabled. This is to enable backward compatibility |
| sunbird_keycloak_user_password |
if sunbird_keycloak_user_set_password is set to true, provide this value to set this as default user password |
| logging.level.root |
The log level that will be used for logging. Default logging is INFO.
Values supported:
INFO
DEBUG
WARN
ERROR |
| enable_external_templates |
boolean value which when set to true, one can retrieve the certificate pdf using external templates |
| authentication_enabled |
boolean value to enable authentication in the system |
| kafka_bootstrap_address |
url for kafka connection |
| webhook_enabled |
boolean value to enable webhook if async_enabled is true |
| webhook_url |
if async_enabled and webhook_enabled is set to true, the caller can retrieve information of the created entity once it is generated via this webhook url |
| redis_host |
redis connection url |
| redis_port |
port on which redis is running |
| manager_type |
if using a single instance of registry, set this value to DefinitionsManager else set to DistributedDefinitionsManager |
| service_retry_maxAttempts |
The number of times an attempt must be made to reach to the service |
| service_retry_backoff_delay |
The fixed time interval, in milliseconds, between each such attempt. |
| metrics_enabled |
boolean value that indicates whether metrics should be enabled or not. if enabled, registry will start emitting events |
| metrics_topic |
kafka topic name to which events will be emitted |
| event_providerName |
name of provider to be used for emitting events. For eg: if Kafka is used, the value should be dev.sunbirdrc.registry.service.impl.KafkaEventService. If file is to be used to store events the value should be `dev.sunbirdrc.registry.service.impl.FileEventService.java` |