User Tools

Site Tools


medal-data-variables

This is an old revision of the document!


medAL-data Environment Variables

Purpose and Scope

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

Environment Variables

Application

  • APP_NAME:
    • Defines the application's name.
    • If not specified: Laravel.
    • For medAL-data, it should be defined as medal-data.
  • 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_DEBUG:
    • If not specified: false.
    • Defines the amount of error detail your application displays through the browser.
    • Should be set to true.
  • APP_URL
    • If not specified: http://localhost.
    • Defines your application's URL.
    • Should be set to your medAL-data server's URL.

Logs

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

Database

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

Creator

  • CREATOR_ALGORITHM_ENDPOINT
    • If not specified: /api/v1/algorithms.
    • Defines the endpoint to retrieve algorithms on medAL-creator.
    • Should be set to /api/v1/algorithms.
  • CREATOR_HEALTH_FACILITY_ENDPOINT
    • If not specified: /api/v1/health_facilities.
    • Defines the endpoint to retrieve health facilities on medAL-creator.
    • Should be set to /api/v1/health_facilities.
  • CREATOR_MEDAL_DATA_CONFIG_ENDPOINT
    • If not specified: /api/v1/versions/medal_data_config?version_id=.
    • Defines the endpoint to retrieve the medAL-creator config.
    • Should be set to /api/v1/versions/medal_data_config?version_id=.
  • CREATOR_VERSIONS_ENDPOINT
    • If not specified: /api/v1/versions.
    • Defines the endpoint to retrieve versions on medAL-creator.
    • Should be set to /api/v1/versions.
  • CREATOR_ALGORITHM_URL
    • Should be <medal-c-url>/api/v1/versions/.
  • CREATOR_HEALTH_FACILITY_URL
    • Should be <medal-c-url>/api/v1/health_facilities/.
  • CREATOR_PATIENT_URL
    • 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.

Passport

  • OAUTH_TOKEN_LIFETIME_DAYS:
    • If not specified: 1
    • Defines the number of days between OAuth token expiration.
    • Should be set to 1.
  • OAUTH_REFRESH_TOKEN_LIFETIME_DAYS:
    • If not specified: 30
    • Defines the number of days between OAuth refresh token expiration.
    • Should be set to 30.

Two-Factor Authentication

  • OTP_ENABLED: Default true. If set to false, disables the two-factor authentication flow. This variable should not be set to false in production!

Global

  • LANGUAGE
    • If not specified: en.
    • Defines the language.
  • LOCAL_HEALTH_FACILITY_MANAGEMENT
    • If not specified true.
    • Defines whether you are managing health facilities from medAL-data, or if you rely to medAL-creator.
    • Set it to true if you locally manage health facilities, false otherwise.
  • STUDY_ID
    • If not specified: Dynamic Tanzania.
    • Defines the study id.
    • Should be set to your given study id. Is one of Dynamic Rwanda, Dynamic Tanzania, TIMCI Kenya, TIMCI India, TIMCI Senegal or TIMCI Tanzania.
medal-data-variables.1640010277.txt.gz ยท Last modified: 2021/12/20 15:24 by arnaud_poletto