medAL-data Environment Variables

This page offers an exhaustive list of all environment variables available for medAL-data; their name, default values and description.

• JSON_LANGUAGE
  • Defines the language for language-dependent variables in JSON files.
• LANGUAGE
  • Defines the language.
  • If not specified: en.
• LOCAL_HEALTH_FACILITY_MANAGEMENT
  • Defines whether you are managing health facilities from medAL-data, or if you rely to medAL-creator.
  • If not specified true.
  • Set it to true if you locally manage health facilities, false otherwise.
• STUDY_ID
  • Defines the study id.
  • If not specified: Dynamic Tanzania.
  • Should be set to your given study id. Is one of Dynamic Rwanda, Dynamic Tanzania, TIMCI Kenya, TIMCI India, TIMCI Senegal or TIMCI Tanzania.

• APP_DEBUG
  • Defines the amount of error detail your application displays through the browser.
  • If not specified: false.
  • Should be set to true.
• APP_ENV
  • Defines the application's environment.
  • If not specified: production.
  • If you are developing without https set it to local otherwise set it to production.
• APP_KEY
  • Defines the application's secret key.
  • You should generate it by running the command php artisan key:generate.
• APP_NAME
  • Defines the application's name.
  • If not specified: Laravel.
  • For medAL-data, it should be defined as medal-data.
• APP_TIMEZONE
  • Defines the application's timezone.
• APP_URL
  • Defines the application's URL.
  • If not specified: http://localhost.
  • Should be set to your medAL-data server's URL.

• LOG_CHANNEL
  • Defines the logging messages' channel.
  • If not specified: stack.
  • Should be set to stack.

• DB_CONNECTION
  • Defines your database management system.
  • If not specified: pgsql.
  • medAL-data generally uses postgres.
• DB_DATABASE
  • Defines your database's name.
  • If not specified: liwi-local-data.
  • Should be defined as medal-data.
• DB_HOST
  • Defines your database's host.
  • If not specified: 127.0.0.1.
• DB_PASSWORD
  • Defines your database's password.
  • If not specified root.
• DB_PORT
  • Defines your database's port number.
  • If not specified: 3306.
• DB_URL
  • Defines your database's URL.
  • Should be defined as postgres://<user>:<password>@<hostname>:<port>/<database-name>.
• DB_USERNAME
  • Defines your database's username.
  • If not specified: root

• MAIL_ENCRYPTION
  • Defines the email's encryption protocol.
  • If not specified: ssl.
  • Should be set to ssl.
• MAIL_FROM_ADDRESS
  • Defines the email address' sender.
  • If not specified: hello@example.com.
  • Should be set to admin@dynamic.com.
• MAIL_FROM_NAME
  • Defines the name's sender.
  • If not specified: DYNAMIC MedAL-DATA.
  • Should be set to ${APP_NAME}
• MAIL_HOST
  • Defines the email host.
  • If not specified: smtp.gmail.com.
  • Should be set to smtp.gmail.com.
• MAIL_MAILER
  • Defines the email communication protocol.
  • Should be set to smtp.
• MAIL_PASSWORD
  • Defines the password's sender.
• MAIL_PORT
  • Defines the email port number.
  • If not specified: 465.
  • Should be set to 587.
• MAIL_USERNAME
  • Defines the username's sender.

• CREATOR_ALGORITHM_ENDPOINT
  • Defines the endpoint to retrieve algorithms on medAL-creator.
  • If not specified: /api/v1/algorithms.
  • Should be set to /api/v1/algorithms.
• CREATOR_HEALTH_FACILITY_ENDPOINT
  • Defines the endpoint to retrieve health facilities on medAL-creator.
  • If not specified: /api/v1/health_facilities.
  • Should be set to /api/v1/health_facilities.
• CREATOR_MEDAL_DATA_CONFIG_ENDPOINT
  • Defines the endpoint to retrieve the medAL-creator config.
  • If not specified: /api/v1/versions/medal_data_config?version_id=.
  • Should be set to /api/v1/versions/medal_data_config?version_id=.
• CREATOR_VERSIONS_ENDPOINT
  • Defines the endpoint to retrieve versions on medAL-creator.
  • If not specified: /api/v1/versions.
  • Should be set to /api/v1/versions.

• CREATOR_ALGORITHM_URL
  • Defines the medAL-creator URL to retrieve algorithms.
  • Should be <medal-c-url>/api/v1/versions/.
• CREATOR_HEALTH_FACILITY_URL
  • Define the medAL-creator URL to retrieve a given health facility.
  • Should be <medal-c-url>/api/v1/health_facilities/.
• CREATOR_PATIENT_URL
  • Define the medAL-creator URL to retrieve a given patient.
  • Should be <medal-c-url>/api/v1/versions/medal_data_config.
• CREATOR_URL
  • Defines the medAL-creator's site URL.
  • Should be set to your medAL-creator URL.

• CASES_ZIP_DIR
  • Defines the directory where zip archives will be stored.
  • Should be set to cases_zip.
• CONSENT_IMG_DIR
  • Defines the directory for medical cases' consent images.
  • Should be set to consent_img.
• JSON_EXTRACT_DIR
  • Defines the directory where medical cases will be extracted to.
  • Should be set to json_extract.
• JSON_FAILURE_DIR
  • Defines the directory for medical cases that failed to process.
  • Should be set to json_failure.
• JSON_SUCCESS_DIR
  • Defines the directory for medical cases that successfully processed.
  • Should be set to json_success.

• HUB_CALLBACK_URL
  • Defines the default hub callback URL.
  • If not specified: http://127.0.0.1:5555.
  • Should be defined as http://127.0.0.1:5555.
• OAUTH_REFRESH_TOKEN_LIFETIME_DAYS
  • Defines the number of days between OAuth refresh token expiration.
  • If not specified: 30
  • Should be set to 30.
• OAUTH_TOKEN_LIFETIME_DAYS
  • Defines the number of days between OAuth token expiration.
  • If not specified: 1
  • Should be set to 1.
• READER_CALLBACK_URL
  • Defines the default reader callback URL.
  • If not specified: aaa://callback.
  • Should be defined as aaa://callback.

• OTP_ENABLED
  • If set to false, disables the two-factor authentication flow.
  • If not specified: true.
  • Should be set to true in production!

• REDCAP_IDENTIFIERS_API_URL_FOLLOWUP
  • Defines the Redcap's followup URL.
  • Should be defined to https://redcap-val.unisante.ch/api/“.
• REDCAP_IDENTIFIERS_API_URL_MEDICAL_CASE
  • Defines the Redcap's medical case URL.
  • Should be defined to https://redcap-val.unisante.ch/api/.

• NOCAPTCHA_SECRET
  • Use this secret key for communication between your site and the reCAPTCHA service.
• NOCAPTCHA_SITEKEY
  • Use this site key in order to validate your communications.