LMS Service Environment Variables

Edit | Report

The following is a list of environment variables and their default values, as required to run the Sunbird LMS service. The list also gives you an indication of the purpose of the variable. Modifying the variable value, allows you to change default behavior based on your need or purpose.

S No. Variable Name Description Purpose Default Value Path
1 sunbird_mail_server_from_email Represents the default communication email address Used to send notifications to the users no default Sunbird-LMS
2 sunbird_env_logo_url Represents the public access image url Used to display logo no default Sunbird-LMS
3 sunbird_web_url Represents the URL of the home page Used to share in an email, such that the users can login no default Sunbird-LMS
4 sunbird_app_url Represents the URL of the Sunbird app in the Play store Used to share in an email, such that users are able to download the app no default Sunbird-LMS
5 sunbird_msg_sender Represents the name of the SMS sender Used to display the name that appears on the user’s screen when an SMS is sent from the system no default Sunbird-LMS
6 sunbird_installation_email Represents the email address used to send badger system notifications Used to notify users when they install the badger system no default Sunbird-LMS
7 sunbird_installation Represents the name of your instance Used to send telemetry and email. The name must be specified without spaces. For example, “SunbirdDev” no default Sunbird-LMS
8 sunbird_encryption_key Represents the key to encrypt and decrypt the attribute. The key should be set only once. Once set, it cannot be changed Used to encrypt and decrypt the attribute no default Sunbird-LMS
9 sunbird_default_channel Represents the default root org or channel. All users of an org are associated through the rootOrg/channel Used to associate users with the rootOrg Each installer needs to add this value after a successful installation Sunbird-LMS
10 sunbird_sso_publickey Represents the validated JWT token generated by Keycloak Used to authenticate a user Used for authentication
You can get the token from Keycloak by navigating to: (realm->keys->public keys)
Sunbird-LMS
11 telemetry_pdata_id The ID for the telemetry pdata. The ID is provided in the format …service. For example, dev.sunbird.learning.service Used to specify the identifier for the telemetry event data   Sunbird-LMS
12 telemetry_pdata_pid Represents the producer ID of the telemetry event.For example, actor-service Used to identify the producer for the telemetry event data   Sunbird-LMS
13 telemetry_pdata_ver Represents the producer version or build version that generates telemetry data. For example, 1.5 Used to identify the producer or build version that generates the telemetry   Sunbird-LMS
14 telemetry_local_storage_type Represents the location to store the telemetry data. Currently all telemetry data is stored on Kafka Used to specify the location to store telemetry data Kafka Sunbird-telemetry-service
15 telemetry_kafka_broker_list Represents the IP address and ports of Kafka. The list is provided in the following format - :,: Used to provide Kafka connection details The installer needs to provide appropriate details of the IP address and port Sunbird-telemetry-service
16 telemetry_kafka_topic Represents the name of the Kafka topic. Recommended topic name format is .telemetry.ingestion Used to provide Kafka topic details   Sunbird-telemetry-service
17 sunbird_user_bulk_upload_size Represents the limit for bulk upload of user details. For example, setting up a value to 1001 restricts the number of users that can be created at a time to 1001. The recommended limit is 1000 users per bulk user upload request. It is also recommended not to configure this value above 2001. Used to specify the limit on the number of lines (including header lines) in a CSV file used for bulk upload. 1001 Sunbird-LMS
18 sunbird_installation_display_name Represents the display name of the installation Used to display the instance name sunbird Sunbird-LMS
19 telemetry_proxy_enabled Denotes if transferring telemetry data to the configured proxy is enabled or disabled.
Note: If the telemetry proxy is enabled then telemetry proxy URL and authentication key configuration is mandatory to transfer telemetry events.
Used to allow transfer of telemetry data to another telemetry proxy, i.e. to the existing data analytics platform telemetry API false Telemetry-Service
20 telemetry_proxy_url Represents the URL of telemetry proxy API Used to store telemetry data in configured telemetry proxy   Telemetry-Service
21 telemetry_proxy_auth_key Represents the telemetry proxy API key Used to store telemetry data in configured telemetry proxy   Telemetry-Service
22 sunbird_app_name Represents app name of the adopter Used for sending welcome message to the user Sample welcome message: If name is set, welcome to . You can login using your mobile number. Use to login using browser, or download the app from playstore. When the name is not set , welcome to . You can login using your mobile number. Login at value shown on email Learner-Service
23 sunbird_open_saber_bridge_enable Enable or disable open saber bridge which is used to store custom information (e.g. user or organisation profile fields) in open saber registry Used to store Sunbird adopter specific profile information in open saber registry as per pre-defined configuration false Learner-Service
24 sunbird_registry_service_baseurl Base URL of open saber registry. This configuration is required if sunbird_open_saber_bridge_enable is set to true Used to store Sunbird adopter specific profile information in open saber registry as per pre-defined configuration   Learner-Service
25 sunbird_analytics_api_base_url Configuration to choose data analytics pipeline (Local vs Global) e.g. /data/v3 Track and analyse usage   Learner-Service
26 sunbird_search_service_api_base_url Configuration to limit the maximum number of recipients in an email notification (e.g. notification to reviewers) sent by Sunbird platform Discovery of content   Learner-Service
27 sunbird_email_max_recipients_limit Configuration to limit the maximum number of recipients in an email notification (e.g. notification to reviewers) sent by Sunbird platform Configuration to restrict mass mailers from platform beyond configured limit 100 Learner-Service
28 sunbird_cassandra_consistency_level Configuration to set default consistency level for Cassandra read and write operations. For more information about consistency level, please refer Cassandra documentation. Configuration to set Cassandra consistency level, this is required when using a multi-node Cassandra cluster for Sunbird   Cassandra DB

Edit | Report