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

• If you are starting the application for first time, start from the Environment Variables and Credentials Setup section
• If you have setup the application before, start from the Start Data2Evidence section

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

• Install the d2e cli client:

  npm i -g d2e

• Verify if the executable works by running d2e to display help section for a list of commands

note

The warning npm warn tarball tarball data for @alp/alp-dbcli@file:cache/drivers/alp-dbcli-v1.0.0.tgz (null) seems to be corrupted. Trying again. can be ignored

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)
• 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

• Input the Researcher Portal URL into a Chrome web browser:

  • https://localhost:443/portal - local workstation
  • https://<FQDN>/portal - remote server

• A "Proceed to localhost" display is expected.

• Select Advanced > Proceed to localhost (unsafe)

• You will see the Data2Evidence login screen

• You can find more information about the usage of the Researcher Portal in the user guide

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:

Additional info:

• Performing password change
• Performing user management

tip

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

• https://localhost:443/portal/systemadmin/user-overview - local workstation
• https://<FQDN>/portal/systemadmin/user-overview - remote server

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:

• Run the command: d2e setupdemo
• Via Admin Portal

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