Skip to main content

Quick start

Pre-requisites​

  • Install pre-requisite software for running Data2Evidence. Refer to the installation guide

The following document outlines the Quick Start setup with demo data & pulls all images from the GitHub container registry.

note

Getting started​

  • Create a directory to store Data2Evidence configuration files. Note that subsequent commands need to be executed in the directory:

    mkdir d2e
    cd d2e

  • Download the appropriate binary for your operating system and architecture from the GitHub Releases page.

Linux​

x64

VERSION="0.16.0"
curl -L https://github.com/OHDSI/Data2Evidence/releases/download/v${VERSION}/data2evidence-cli-linux-x64 -o d2e
chmod +x d2e

arm64

VERSION="0.16.0"
curl -L https://github.com/OHDSI/Data2Evidence/releases/download/v${VERSION}/data2evidence-cli-linux-arm64 -o d2e
chmod +x d2e

macOS​

x64

VERSION="0.16.0"
curl -L https://github.com/OHDSI/Data2Evidence/releases/download/v${VERSION}/data2evidence-cli-darwin-x64 -o d2e
chmod +x d2e

arm64

VERSION="0.16.0"
curl -L https://github.com/OHDSI/Data2Evidence/releases/download/v${VERSION}/data2evidence-cli-darwin-arm64 -o d2e
chmod +x d2e

Windows​

x64

$VERSION = "0.16.0"
curl.exe -L --progress-bar -o d2e.exe "https://github.com/OHDSI/Data2Evidence/releases/download/v$VERSION/data2evidence-cli-windows-x64.exe"

  • Verify if the executable works by running ./d2e to display the help section for a list of commands. Ensure that ./ is included when running the executable.

  • Check version using

    ./d2e version
    d2e CLI version:    0.12.0
    Docker image tag:   0.12.2-beta
    Plugins API version: ~0.12.0

    For more info and troubleshooting: System setup cli guide

  • Check d2e cli client version using

    d2e version
    d2e CLI version:    0.12.0
    Docker image tag:   0.12.2-beta
    npm server version: ~0.12.0

    For more info and troubleshooting: System setup cli guide

Environment variables and credentials setup​

Custom environment variables (mandatory for a remote virtual machine)​

Export additional shell variables as relevant (go to admin guide).

  • export CADDY__ALP__PUBLIC_FQDN=<FQDN> - Remote Virtual Machine Server scenario (otherwise unset). Ensure that the FQDN url is in lowercase.
  • export TLS__CADDY_DIRECTIVE=' ' (blank) - Publicly Resolvable FQDN scenario (otherwise unset)

Environment variables & secrets​

Generate .env file with random generated secrets and certificates:

./d2e init

See Environment variables for further details.

Start Data2Evidence​

Start Data2Evidence services:

./d2e -e pull
./d2e -e start

Note: If you are running behind a proxy

  • Add the following in the noProxy configuration
  • If env PROJECT_NAME is different from the default d2e, do a search and replace from d2e- with ${PROJECT_NAME}- in the below config
.alp.local,registry-1.docker.io,localhost,::1,d2e-demodb,d2e-caddy,d2e-enterprise-gateway,d2e-minerva-redis-1,d2e-minerva-postgres-1,d2e-minerva-pg-mgmt-init-1,d2e-logto-1,d2e-logto-post-init-1,d2e-trex,d2e-supabase-storage-1,d2e-minerva-fhir-server-1,d2e-supabase-storage-post-init-1,d2e-dataflow-gen-1,d2e-dataflow-gen-worker

Data2Evidence guide​

Researcher Portal​

Accessing Admin Portal​

The Admin Portal allows authorized personnel to login and perform the management of users, datasets and job plugins.

  • Login as admin with following credentials:

    • username - admin
    • password - Updatepassword12345

  • Click Account on the top right > switch to Admin Portal

The expected display is: AdminPortal

Additional info:

tip

For quick access to the Admin Portal, input the following URL in the search bar:

Configure Data2Evidence with a custom dataset​

Find information on how to add a custom dataset and configure Data2Evidence in the data load section.

Configure Data2Evidence using the demo dataset​

These are the two methods to load the demo dataset:

Upon completion, switch to the Researcher Portal by navigating to Account > switch to Researcher Portal. The demo dataset will be shown.

Stop the application​

Stop the application:

./d2e -e stop

Remove the resources​

warning

Removes all Data2Evidence data.
For a fresh startup, re-run from environment variables and credentials setup section

./d2e clean