Config options
Application
Main settings
| Setting |
Default value |
Description |
| APP_ENV |
local |
This option should be set to production if your application in on a production server. |
| APP_DEBUG |
true |
This option should be set to false if your application in on a production server. |
| APP_URL |
http://trax3.test |
Public URL of your LRS. It should start by https if your application in on a production server. |
| APP_KEY |
|
Key used for encryption and security purposes in Laravel. Should be generated with php artisan key:generate. |
| APP_SERVICE |
|
Only relevant for Docker and Sail. Name of the container the sail shell gives access to. |
Default admin user
| Setting |
Default value |
Description |
| ADMIN_EMAIL |
admin@traxlrs.com |
Email of the admin account created during the install. |
| ADMIN_PASSWORD |
aaaaaaaa |
Password of the admin account created during the install. |
Default client
| Setting |
Default value |
Description |
| DEFAULT_ENDPOINT_USERNAME |
traxlrs |
Username of the default client created during the install. |
| DEFAULT_ENDPOINT_PASSWORD |
aaaaaaaa |
Password of the default client created during the install. |
Features
| Setting |
Default value |
Description |
| EXTENDED_EDITION |
true |
Features of the Extended Edition enabled. It must stay true with the Extended Edition. |
xAPI
Main settings
| Setting |
Default value |
Description |
| XAPI_STATEMENTS_LIMIT |
100 |
Maximum number of statements returned by the LRS during a GET request. |
| XAPI_STATEMENTS_AUTHORITY_NAME |
api |
name of the authority assigned to the incoming statements. |
| XAPI_STATEMENTS_AUTHORITY_HOMEPAGE |
http://traxlrs.com |
homePage of the authority assigned to the incoming statements. |
| XAPI_PSEUDO_HOMEPAGE |
http://pseudo.traxlrs.com |
homePage of pseudonymized agents. |
| XAPI_PSEUDO_HASH_KEY |
Oh4JYEcohtoaZmS3oBb4d |
Secret key used to pseudonymize the agents. |
xAPI pipeline settings
The following configuration options define the default values of the xAPI pipeline options.
| Setting |
Default value |
| PIPELINE_DEFAULT_VALIDATE_STATEMENTS |
true |
| PIPELINE_DEFAULT_CHECK_CONFLICTS |
true |
| PIPELINE_DEFAULT_RECORD_ATTACHMENTS |
true |
| PIPELINE_DEFAULT_VOID_STATEMENTS |
true |
| PIPELINE_DEFAULT_UPDATE_ACTIVITIES |
true |
| PIPELINE_DEFAULT_UPDATE_AGENTS |
true |
| PIPELINE_DEFAULT_UPDATE_VOCAB |
true |
| PIPELINE_DEFAULT_UPDATE_ACTIVITY_IDS |
true |
| PIPELINE_DEFAULT_UPDATE_AGENT_IDS |
true |
| PIPELINE_DEFAULT_PSEUDONYMIZE_STATEMENTS |
false |
| PIPELINE_DEFAULT_QUERY_TARGETING |
true |
xAPI pipeline forced settings
The following configuration options can be used to force to the xAPI pipeline options to their default values.
| Setting |
Default value |
| PIPELINE_FORCED_VALIDATE_STATEMENTS |
false |
| PIPELINE_FORCED_CHECK_CONFLICTS |
false |
| PIPELINE_FORCED_RECORD_ATTACHMENTS |
false |
| PIPELINE_FORCED_VOID_STATEMENTS |
false |
| PIPELINE_FORCED_UPDATE_ACTIVITIES |
false |
| PIPELINE_FORCED_UPDATE_AGENTS |
false |
| PIPELINE_FORCED_UPDATE_VOCAB |
false |
| PIPELINE_FORCED_UPDATE_ACTIVITY_IDS |
false |
| PIPELINE_FORCED_UPDATE_AGENT_IDS |
false |
| PIPELINE_FORCED_PSEUDONYMIZE_STATEMENTS |
false |
| PIPELINE_FORCED_QUERY_TARGETING |
false |
ADL LRS Conformance Testsuite
| Setting |
Default value |
Description |
| TESTSUITE_PATH |
/opt/adl-lrs-testsuite |
Path of the folder where the ADL LRS conformance test suite is installed. |
Database
Main database
| Setting |
Default value |
Description |
| DB_CONNECTION |
mysql |
Database driver: mysql or mysql. |
| DB_HOST |
127.0.0.1 |
Host of the database server. |
| DB_PORT |
3306 |
Port of the database server. |
| DB_DATABASE |
trax3 |
Name of the database. |
| DB_SCHEMA |
public |
Database schema: only relevant for PostgreSQL. |
| DB_USERNAME |
root |
Username for the database connection. |
| DB_PASSWORD |
|
Password for the database connection. |
Auth service database
The following settings are optional. When not defined, the main database settings apply.
| Setting |
Description |
| AUTH_DB_DRIVER |
Database driver: mysql or pgsql. |
| AUTH_DB_HOST |
Host of the database server. |
| AUTH_DB_PORT |
Port of the database server. |
| AUTH_DB_DATABASE |
Name of the database. |
| AUTH_DB_SCHEMA |
Database schema: only relevant for PostgreSQL. |
| AUTH_DB_USERNAME |
Username for the database connection. |
| AUTH_DB_PASSWORD |
Password for the database connection. |
Logging service database
The following settings are optional. When not defined, the main database settings apply.
| Setting |
Description |
| LOGGING_DB_DRIVER |
Database driver: mysql or pgsql. |
| LOGGING_DB_HOST |
Host of the database server. |
| LOGGING_DB_PORT |
Port of the database server. |
| LOGGING_DB_DATABASE |
Name of the database. |
| LOGGING_DB_SCHEMA |
Database schema: only relevant for PostgreSQL. |
| LOGGING_DB_USERNAME |
Username for the database connection. |
| LOGGING_DB_PASSWORD |
Password for the database connection. |
Vocab service database
The following settings are optional. When not defined, the main database settings apply.
| Setting |
Description |
| VOCAB_DB_DRIVER |
Database driver: mysql or pgsql. |
| VOCAB_DB_HOST |
Host of the database server. |
| VOCAB_DB_PORT |
Port of the database server. |
| VOCAB_DB_DATABASE |
Name of the database. |
| VOCAB_DB_SCHEMA |
Database schema: only relevant for PostgreSQL. |
| VOCAB_DB_USERNAME |
Username for the database connection. |
| VOCAB_DB_PASSWORD |
Password for the database connection. |
xAPI database
The following settings are optional. When not defined, the main database settings apply.
| Setting |
Default value |
Description |
| XAPI_DB_DRIVER |
|
Database driver: mysql, pgsql, mongodb, elasticsearch or opensearch. |
| XAPI_DB_HOST |
|
Host of the database server. |
| XAPI_DB_PORT |
|
Port of the database server. |
| XAPI_DB_DATABASE |
|
Name of the database. |
| XAPI_DB_SCHEMA |
|
Database schema: only relevant for PostgreSQL. |
| XAPI_DB_USERNAME |
|
Username for the database connection. |
| XAPI_DB_PASSWORD |
|
Password for the database connection. |
| XAPI_DB_ASYNC |
false |
Only relevant for Elasticsearch and OpenSearch. Enable the async recording mode. |
| XAPI_DB_TIMESERIES |
false |
Only relevant for TimescaleDB. |
Statements service database
The following settings are optional. When not defined, the xAPI database settings apply.
| Setting |
Description |
| STATEMENTS_DB_DRIVER |
Database driver: mysql, pgsql, mongodb, elasticsearch or opensearch. |
| STATEMENTS_DB_HOST |
Host of the database server. |
| STATEMENTS_DB_PORT |
Port of the database server. |
| STATEMENTS_DB_DATABASE |
Name of the database. |
| STATEMENTS_DB_SCHEMA |
Database schema: only relevant for PostgreSQL. |
| STATEMENTS_DB_USERNAME |
Username for the database connection. |
| STATEMENTS_DB_PASSWORD |
Password for the database connection. |
| STATEMENTS_DB_ASYNC |
Only relevant for Elasticsearch and OpenSearch. Enable the async recording mode. |
| STATEMENTS_DB_TIMESERIES |
Only relevant for TimescaleDB. |
Activities service database
The following settings are optional. When not defined, the xAPI database settings apply.
| Setting |
Description |
| ACTIVITIES_DB_DRIVER |
Database driver: mysql, pgsql, mongodb, elasticsearch or opensearch. |
| ACTIVITIES_DB_HOST |
Host of the database server. |
| ACTIVITIES_DB_PORT |
Port of the database server. |
| ACTIVITIES_DB_DATABASE |
Name of the database. |
| ACTIVITIES_DB_SCHEMA |
Database schema: only relevant for PostgreSQL. |
| ACTIVITIES_DB_USERNAME |
Username for the database connection. |
| ACTIVITIES_DB_PASSWORD |
Password for the database connection. |
| ACTIVITIES_DB_ASYNC |
Only relevant for Elasticsearch and OpenSearch. Enable the async recording mode. |
Activity profiles service database
The following settings are optional. When not defined, the xAPI database settings apply.
| Setting |
Description |
| ACTIVITY_PROFILES_DB_DRIVER |
Database driver: mysql, pgsql, mongodb, elasticsearch or opensearch. |
| ACTIVITY_PROFILES_DB_HOST |
Host of the database server. |
| ACTIVITY_PROFILES_DB_PORT |
Port of the database server. |
| ACTIVITY_PROFILES_DB_DATABASE |
Name of the database. |
| ACTIVITY_PROFILES_DB_SCHEMA |
Database schema: only relevant for PostgreSQL. |
| ACTIVITY_PROFILES_DB_USERNAME |
Username for the database connection. |
| ACTIVITY_PROFILES_DB_PASSWORD |
Password for the database connection. |
| ACTIVITY_PROFILES_DB_ASYNC |
Only relevant for Elasticsearch and OpenSearch. Enable the async recording mode. |
Agents service database
The following settings are optional. When not defined, the xAPI database settings apply.
| Setting |
Description |
| AGENTS_DB_DRIVER |
Database driver: mysql, pgsql, mongodb, elasticsearch or opensearch. |
| AGENTS_DB_HOST |
Host of the database server. |
| AGENTS_DB_PORT |
Port of the database server. |
| AGENTS_DB_DATABASE |
Name of the database. |
| AGENTS_DB_SCHEMA |
Database schema: only relevant for PostgreSQL. |
| AGENTS_DB_USERNAME |
Username for the database connection. |
| AGENTS_DB_PASSWORD |
Password for the database connection. |
| AGENTS_DB_ASYNC |
Only relevant for Elasticsearch and OpenSearch. Enable the async recording mode. |
Agent profiles service database
The following settings are optional. When not defined, the xAPI database settings apply.
| Setting |
Description |
| AGENT_PROFILES_DB_DRIVER |
Database driver: mysql, pgsql, mongodb, elasticsearch or opensearch. |
| AGENT_PROFILES_DB_HOST |
Host of the database server. |
| AGENT_PROFILES_DB_PORT |
Port of the database server. |
| AGENT_PROFILES_DB_DATABASE |
Name of the database. |
| AGENT_PROFILES_DB_SCHEMA |
Database schema: only relevant for PostgreSQL. |
| AGENT_PROFILES_DB_USERNAME |
Username for the database connection. |
| AGENT_PROFILES_DB_PASSWORD |
Password for the database connection. |
| AGENT_PROFILES_DB_ASYNC |
Only relevant for Elasticsearch and OpenSearch. Enable the async recording mode. |
States service database
The following settings are optional. When not defined, the xAPI database settings apply.
| Setting |
Description |
| STATES_DB_DRIVER |
Database driver: mysql, pgsql, mongodb, elasticsearch or opensearch. |
| STATES_DB_HOST |
Host of the database server. |
| STATES_DB_PORT |
Port of the database server. |
| STATES_DB_DATABASE |
Name of the database. |
| STATES_DB_SCHEMA |
Database schema: only relevant for PostgreSQL. |
| STATES_DB_USERNAME |
Username for the database connection. |
| STATES_DB_PASSWORD |
Password for the database connection. |
| STATES_DB_ASYNC |
Only relevant for Elasticsearch and OpenSearch. Enable the async recording mode. |
Dev service database
The following settings are optional. When not defined, the xAPI database settings apply.
| Setting |
Description |
| DEV_DB_DRIVER |
Database driver: mysql, pgsql, mongodb, elasticsearch or opensearch. |
| DEV_DB_HOST |
Host of the database server. |
| DEV_DB_PORT |
Port of the database server. |
| DEV_DB_DATABASE |
Name of the database. |
| DEV_DB_SCHEMA |
Database schema: only relevant for PostgreSQL. |
| DEV_DB_USERNAME |
Username for the database connection. |
| DEV_DB_PASSWORD |
Password for the database connection. |
| DEV_DB_ASYNC |
Only relevant for Elasticsearch and OpenSearch. Enable the async recording mode. |
APIs
| Setting |
Default value |
Description |
| DATA_API |
true |
When set to true, the Data API is open to external applications. You may disable it for security reasons. |
| JOBS_API |
true |
When set to true, the Jobs API is open to external applications. You may disable it for security reasons. |
| LOGGING_API |
true |
When set to true, the Logging API is open to external applications. You may disable it for security reasons. |
| ACCESS_API |
true |
When set to true, the Access API is open to external applications. You may disable it for security reasons. |
Micro-services
Local and remote services
| Setting |
Default value |
Description |
| LOCAL_SERVICES |
all |
List of the services enabled on the current instance: all or ['service1','service2',...]. |
| REMOTE_SERVICES |
[] |
List of the remote services which may be call by the gateway: ['service1','service2',...]. |
| SERVICE_ACTIVITIES_HOST |
|
Host of the container running the activities service. |
| SERVICE_ACTIVITY_PROFILES_HOST |
|
Host of the container running the activity profiles service. |
| SERVICE_AGENTS_HOST |
|
Host of the container running the agents service. |
| SERVICE_AGENT_PROFILES_HOST |
|
Host of the container running the agent profiles service. |
| SERVICE_DEV_HOST |
|
Host of the container running the dev service. |
| SERVICE_LOGGING_HOST |
|
Host of the container running the logging service. |
| SERVICE_STATEMENTS_HOST |
|
Host of the container running the statements service. |
| SERVICE_STATES_HOST |
|
Host of the container running the states service. |
| SERVICE_VOCAB_HOST |
|
Host of the container running the vocab service. |
Redis Stream
| Setting |
Default value |
Description |
| REDIS_HOST |
127.0.0.1 |
When set to true, the application events are sent to the Redis Stream. |
| REDIS_PASSWORD |
|
When set to true, the application events are sent to the Redis Stream. |
| REDIS_PORT |
|
When set to true, the application events are sent to the Redis Stream. |
| EVENT_STREAM_ENABLED |
false |
When set to true, the application events are sent to the Redis Stream. |