
--flag=value, --flag2=value2 format. Each listed parameter can also be set as an environment variable. The same parameters (minus the "--") can also be placed in a file called ".env" alongside this executable. In the .env file, omit the "--" characters from the flag names, and separate the options with a new line. The order of precedence is:

$ ./lrs2 [--port 8080] --disableAccountCreation
$ ./lrs2 --help
inProcessJobs=true
selfServiceAccounts=false
mongoServer=mongodb://localhost
adminDBName=VTCLRS
elasticSearchServer=
host=local.veracity.it
port=80
displayPort=80
protocol=http
domainRouting=false
SERVER_SECRET=9bcf20cc-b326-4d6f-9691-8c384e5dfbf8
demo.lrs.io, or lrs.example.com. If the LRS is contacted using some other address (for instance the bare server IP), the LRS will respond with an error. This address should not be a URL — it's just the DNS name. It's possible to use the server's bare IPV4 address in this field. This value is read from the host header of incoming HTTP requests, so you should be careful when running the server behind a proxy. If it's impossible to make your clients provide the correct http header, then you can disable the server's check of the value. To disable the host header check, set disableHostCheck to true. Note that when the LRS constructs links to itself, it will use the provided host value from its configuration. If you disable the host header check, it's possible that the links the LRS constructs to itself (embeddable chart and dashboard links, the more link in an xAPI statement response, and others) may be incorrect.lrs.mycompany.orgveracity.mycompany.commyveracitylrs.iohttps://testlrs.comFE80:CD00:0000:0CDE:1257:0000:211E:729Cmyhostnamehttps or http. http, the server will serve normal http on the selected port. Any config values for sslCert or sslKey will be ignored. Links printed into the UI will use the scheme http://.https, the server serves https only if there is a valid sslCert and sslKey setting. If these settings are blank, then the server will serve http but will print links to the client with https://. This has some ramifications for running the server behind a proxy.
localhost may need to be updated. If the LRS does not connect to your local database, please change localhost to 127.0.0.1.mongodb://localhostmongodb://dbUserName:password@local.veracity.it:27017mongodb+srv://root:xxxxxxx@test.xxxxx.mongodb.nethttp://localhost:9200, you must explicitly set the value to nothing to disable the Elasticsearch connection.http://elastic:w3FKZHaoREVf4EA8S6yf@localhost:9200http://localhost:9200
system_email_from address be from a validated address. Check with your SMTP provider.|
|
|
|
Setting Name
|
Discussion
|
system_email_from |
This is the email address that will appear in the "From" field.
|
email_pass |
This is the password for the given SMTP server.
|
email_server |
This is the URL of the SMTP server. For example:
smtp.sendgrid.net. |
email_to |
This address is used to send notifications to the system administrator.
|
email_user |
The username used to access the SMTP server.
|

|
Setting Name
|
Discussion
|
protocol |
should be
https. |
port |
This is the port that the LRS actually listens on. Generally, this would be
443 for SSL. |
displayPort |
When not behind a proxy, the displayPort should match the port value.
|
sslCert |
This is the path (relative to the working directory) to the SSL certificate file. This file should be in the PEM format and may contain additional chained certificates. For example:
testcerts/certificate.crt. |
sslKey |
This is the private key associated with the certificate in the .crt file. This file should be in the PEM format. For example:
testcerts/privatekey.key. |

protocol setting to https but leave sslCert and sslKey blank.enableWebsockets is set to true, then the proxy must be configured to forward WebSocket connections to the LRS. If this is not possible, be sure to set enableWebsockets to false.secureCookie to true, you'll need to inform the system that the upstream proxy is trusted. To do so, set a header on the HTTP request called X-Forwarded-Proto and make the value https. This will inform the LRS server that the incoming connection was secure, and thus the server will obey the secureCookie setting.X-Forwarded-For to the actual client IP address.webRoot to be a path on your server and configure your proxy to forward only those paths to the LRS application. location /
{
proxy_pass http://localhost:3005/;
proxy_set_header Host $host;
proxy_set_header X-Forwarded-For $remote_addr;
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "Upgrade";
proxy_set_header X-Forwarded-Proto $scheme;
proxy_buffering off;
proxy_request_buffering off;
proxy_read_timeout 18000s;
proxy_send_timeout 18000s;
}
|
Setting Name
|
Discussion
|
logLevel |
This is the logging verbosity. Either
debug, info, warning, or error. |
logFormat |
Either
human or lines. Some log management tools generate separate events for each newline in the output stream. In human mode, some data from single events is formatted to display on multiple lines, which can break such tools. Set the logFormat to lines to strip newlines from log events. |
logSources |
This is a comma separated list of log subsystem sources to display. This is useful when trying to isolate or debug specific components of the system
|
no-color |
The LRS will normally use ANSI terminal colors to display information. Set this to true to disable all color output. Some systems are not capable of displaying this color and will show many Unicode escape characters instead of the coloring, making it difficult to view the logs. |
logSource and logLevel settings. The remainder of the line is the raw string of the message. This may or may not include formatted text or JSON data.[M] info plugins Found Plugin Dashboard C:\Development\vtc2\lrs2\plugins\netc-dashboards\dashboards\instructor\navyInstructorActivities.js
[M] info plugins Found Plugin Dashboard C:\Development\vtc2\lrs2\plugins\netc-dashboards\dashboards\student\netcStudentActivities.js
[M] info websock Starting socket server
[M] info system Listening on 3005
[M] info system Startup Complete
[M] info audit System System Start
[M] info audit EXTERNAL_CONNECTION 54.209.2.187:443
[M] info audit UI GET /lrs/test-buck/content/create/ admin@example.com
[M] info audit ACCESS lrs.content.create 640741e6240cc64d0857566f lrs.js admin@example.com true

audit log source. The audit logger is a built-in, system-level plugin. It can be configured to log the following event categories.|
Event Type
|
Discussion
|
UI requests |
This setting will cause the audit logger to save all HTTP requests to the UI, including the method, path, and any logged in user. |
xAPI requests |
This setting will cause the audit logger to save all HTTP requests to the xAPI, including the method, path, and query. |
LRS API requests |
This setting will cause the audit logger to save all HTTP requests to the LRS management APIs.
|
System API |
This setting will cause the audit logger to save all HTTP requests to the System management API.
|
System ODM events |
Log all system level data model changes. All DB entities will report created, modify, and delete events for the specific entity type and ID. |
LRS ODM events |
Log all LRS level data model changes. All DB entities will report created, modify, and delete events for the specific entity type, ID, and LRS.
|
User events |
Users account events such as created, deleted, locked, unlocked, password reset, login, and logout.
|
Permissions |
This system will record all access control checks including what permission was requested, by who, on what entity, and what was the outcome.
|
Permissions Set |
The system will record all modifications to permissions, including what permissions were granted and revoked, by whom, to whom, and on what entity.
|
External Connections |
The system reached out to another server for some purpose. The log will contain the purpose, host/URL, protocol, and remote IP.
|

|
Setting Name
|
Recommended Value
|
selfServiceAccounts |
true |
disableAccountCreation |
true |
defaultUserPermissions |
(empty string)
|
| Setting Name | Recommended Value |
selfServiceAccounts |
true |
disableAccountCreation |
false |
defaultUserPermissions |
system.lrs.create |
|
Setting Name
|
Category
|
Default
|
Data Type |
Discussion
|
INSTALL_NAME |
Server Setup | String | A name for this installation. Used for reporting functions in a multi-server installation. | |
SERVER_NAME |
Server Setup | String |
A name for this server. This will render in the footer. Useful for understanding multi-server environments.
|
|
SERVER_SECRET |
Basics | You must change this |
String |
A value used for various encryption functions. Should be the same between all servers in an installation.
|
adminDBName |
Basics | VTCLRS |
String |
The database name to the system level tenant info database.
|
adminNotifyUpdates |
Server Setup | false |
StringBool |
Notify the admin when updates are available.
|
admin_email |
Basics | String |
The email address that identifies the admin user. This value is informational only. To change the actual address, use
--setAdminUser=true. |
|
admin_pass |
Basics | String |
The password for the admin user. Do not place this in the .env file. Use the command line with
--setAdminUser=true. |
|
analyticsRetryTimeout |
Analytics | 5000 |
Number |
The time in milliseconds before the client is signaled that the processor is working, and to try back later.
|
autoIndexRebuildLimit |
Limits and Rates | 30000 |
Number |
When indexes are stale, LRSs with less than this many statements will be automatically upgraded.
|
backupEncryptKey |
fa299d32-96e2-43bf-aad7-2e61a96a8ddb |
String |
This key is used to encrypt LRS backups.
|
|
bootstrap |
Server Setup | String | A path to a file used to set up LRSs, users and API keys on system start. | |
bruteFreeRetries |
Limits and Rates | 25 |
Number |
The number of free retries before the brute force prevention logic starts limiting the client.
|
clientRequestQueueSize |
Server Setup | 10 |
Number |
How many concurrent commands can each LRS execute per worker.
|
config |
Basics | .env |
String |
The name of the environment file to use.
|
continue |
Server Setup | false |
String-Bool | Should the server continue starting up after the automated action. Relevant to --setAdminUser and --bootstrap. |
debug |
Logging | false |
StringBool |
Debugging console output. This is overcome by
logLevel. |
defaultUserPermissions |
Server Setup | admin.lrs.create |
String |
The default global permissions for users. This is overridden by any specific permissions configuration on a user.
|
disableAccountCreation |
Features | false |
StringBool |
Prevent account creation.
|
disableAnalyticsCache |
Debugging | false |
StringBool |
Disable caching of the results for the Analytics dashboards.
|
disableHostCheck |
Server Setup | false |
StringBool |
Disable checking the host header against the configured host setting.
|
disablePlugins |
debugging | false |
StringBool |
Prevent the execution of plugins.
|
disableResetPasswordFeedback |
Server Setup | false |
StringBool |
Prevent the reset password function from displaying any feedback about account status.
|
disableSSRFprotection |
Server Setup | false |
StringBool |
Allow the server to form connections to internal IP addresses.
|
displayPort |
Basics | 3005 |
Number |
The user facing port. This can differ from the
port setting if there is a proxy server. |
domainRouting |
Basics | true |
StringBool |
Whether or not your server will use domain-based routing. This means that the xAPI address will be
yourlrs.lrs.io/xapi, or lrs.io/yourlrs/xapi. |
elasticMissingRatioError |
Analytics | 0.99 |
Number |
When determining if an Elasticsearch index is "healthy", it must have this ratio of statements to the MongoDB count.
|
elasticReconnectTimeout |
Analytics | 30 seconds |
Human Interval |
A when a connection to Elasticsearch fails, how long should the server wait before trying again? (as a human interval, i.e.,
1 minute). |
elasticSearchServer |
Analytics | String |
The full URL to the Elasticsearch server. Please be sure to use version 7.x of Elasticsearch.
|
|
elasticTimeout |
Analytics | 20s |
String |
A timeout for Elasticsearch queries.
|
email_pass |
String |
Password on the outgoing email server.
|
||
email_server |
String |
The address of the SMTP server that the system will use to send emails.
|
||
email_to |
String |
The email address at which the system can reach the system administrator.
|
||
email_user |
String |
Username on the outgoing email server.
|
||
enableWebsockets |
Server Setup | false |
StringBool |
Enable the WebSocket system for dynamic front end features. You must either use a MongoDB replica set or set the
workers setting to 1. |
enforceLimitsCacheTime |
30000 |
Number |
|
|
enforcePasswordComplexity |
Server Setup | false |
StringBool |
Require complex passwords.
|
esDynamicExtensions |
Analytics | true |
String |
How are dynamic extensions treated? Set to
true for regular Elasticsearch dynamic mapping or runtime to use runtime mapping. |
esIndexExtensions |
Analytics | true |
StringBool |
Should xAPI extensions be included in the Elasticsearch mapping? This can cause document rejection if you have many different extensions in a dataset.
|
esKeywordMaxLength |
Analytics | 256 |
Number |
The maximum length beyond which similar strings will be assumed the same in the Elasticsearch mapping.
|
expireMoreLinksAfter |
Server Setup | 86400000 |
Number |
When to purge the More links from the xAPI.
|
fetchLRSRoutingCacheTime |
5000 |
Number |
|
|
fileUploadSizeLimit |
Limits and Rates | 100000000 |
Number |
The maximum size in bytes for a content package upload.
|
forcePortalLaunchCookie |
Server Setup | false |
StringBool |
Require the portal cookie, even for cross domain content.
|
fullTextQueryLimit |
Limits and Rates | 100 |
Number |
The limit of results for full text searches in the statement viewer.
|
generateStatementsIterations |
Limits and Rates | 30 |
Number |
The number of iterations for the statement generation function.
|
globalMongoTimeout |
Limits and Rates | 10000 |
Number |
A global timeout for MongoDB transactions.
|
host |
Basics
|
local.veracity.it |
String
|
The public facing DNS or IP of the server.
|
inProcessJobs |
Features | true |
StringBool |
Should this server process the async job queue?
|
inactiveAccountDisable |
Limits and Rates | Human Interval |
A human interval, like
30 years or eight weeks. The amount of time where a user account will be locked if the user does not log in. |
|
jobFrequency |
Server Setup | 30 seconds |
Human Interval |
How frequently should the server check for new async jobs in the job pool. Uses a human interval like
30 seconds or 5 minutes. |
jsonPostLimit |
Limits and Rates | 100kb |
String |
the max size allowed in typical JSON post calls, excluding statement import. example:
100kb, 1mb, or 10gb. |
license |
Server Setup | String |
The license key string provided to you by your sales POC.
|
|
lockAfterFailedLoginAttempts |
Server Setup | 0 |
Number |
Lock accounts after X failed login attempts. Use
0 to disable. |
logFormat |
Logging | lines |
String |
A log formatter.
human or lines. |
logLevel |
Logging | info |
String |
Set the log level, either
trace, debug, info, warn, error, or fatal. |
logSources |
Logging | String |
A list of log sources to display. Blank for all.
|
|
maxVQLWindowSize |
Limits and Rates | 10000 |
Number |
The maximum number of results returned from any VQL query.
|
maximumPasswordLifetime |
Server Setup | Human Interval |
Force the password from being changed after this period has elapsed.
|
|
minimumPasswordLifetime |
Server Setup | Human Interval |
Prevent the password from being changed again before this period has elapsed.
|
|
mongoServer |
Basics | mongodb://localhost |
String |
The full connection string to the Mongo DB server.
|
no-color |
Server Setup | StringBool |
Disable console colors.
|
|
passwordDictionary |
Server Setup | String | New in 1.14, a path (either absolute or relative to the CWD) to a file of newline delimited passwords that should be blacklisted (user cannot choose these passwords). | |
passwordHashIterations |
Server Setup | 10000 |
Number |
How many times are passwords hashed. Don't change this after install!
|
passwordRetentionCount |
Limits and Rates | 5 |
Number |
Users may not reuse a password for this many generations.
|
port |
Basics | 3005 |
Number |
The actual port that the system will listen on.
|
protocol |
Basics | http |
String |
The user facing protocol. Note that server will serve with HTTP if this is
http, and HTTPS only if this is https and the sslKey and sslCert are set. |
rateLimitWindow |
Limits and Rates | 86400 |
Number |
The time in seconds that the transaction limit is enforced over.
|
rebuildStatementsUILimit |
Limits and Rates | 50000 |
Number |
|
recaptcha_site_key |
Server Setup | String |
The site key for Google's reCAPTCHA system. Leave this blank to disable reCAPTCHA.
|
|
secureCookie |
Server Setup | false |
StringBool |
Set the secure flag on the cookies.
|
selfServiceAccounts |
Features | true |
StringBool |
Can users sign up for an account on their own?
|
sessionTimeout |
Server Setup | 0 |
Number |
A timeout for the session cookie. Use a number, in milliseconds.
|
setAdminUser |
Basics | StringBool |
Update the database to reflect the values stored in
--admin_email and --admin_pass. Do not place the password in the .env file. Use the command line to pass it. |
|
simLatency |
test | 0 |
Number |
Simulate additional latency for all non-static routes.
|
sslCert |
Server Setup | String |
The path (relative to CWD) to the SSL certificate file. Only used when
protocol is https. |
|
sslKey |
Server Setup | String |
The path (relative to CWD) to the SSL key file. Only used when
protocol is https. |
|
statementDefaultLimit |
Limits and Rates | 300 |
Number |
The default number of statements when
limit is not set in the xAPI. |
statementMaxLimit |
Limits and Rates | 10000 |
Number |
The max
limit that the server will support in the xAPI. |
statsCacheTime |
180000 |
Number |
|
|
systemMongoConnectionPoolSize |
Server Setup | 100 |
Number |
How many connections to the DB can the system have.
|
system_email_from |
String |
The address that will appear in the "From" field when the server sends an email.
|
||
testTimeout |
Tests | 30000 |
Number |
Test timeout.
|
webRoot |
Basics | String |
A root path that all LRS functions will use.
|
|
workers |
Limits and Rates | 0 |
Number | The number of processors to use. If unset (or set to 0), will use the number of logical cores on the server. "Lite" mode limits to 1. |
xapiAttachmentSizeLimit |
Limits and Rates | 1000000 |
Number | The maximum size in bytes for an xAPI attachment. |