Skip to main content

Quick Start

Pre-requisites​

  • Install pre-requisite softwares for running D2E. Refer to the installation guide here

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 d2e configuration files. Please note that subsequent commands need to be executed in the directory:
mkdir d2e
cd d2e
  • Install the d2e cli client by run the command in your terminal:
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. See: here

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

Generates .env file with random generated secrets and certificates.

d2e init

See here for a description of the environment variables generated

Start D2E​

Start D2E services by running:

d2e -e start

D2E Guide​

Authentication 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 on 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 D2E with a custom dataset​

Please find information on how to add a custom dataset and configure Data2Evidence here.

Configure D2E using the demo dataset​

Below are alternative methods to load the demo dataset:

  • Run the command: d2e setupdemo
  • Via Admin Portal: Refer to docs here

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

Researcher Portal​

You can find more information about the usage of the researchers portal in the User Guide

Cohort Creation​

Navigate to Researcher Portal and select Cohort tab at URL:

Refer to the documentation here for more details.

Stopping the Application​

Stop the application by running:

d2e -e stop

Removing the Resources​

Removes the containers, volumes & networks

d2e clean
warning

Removes all D2E data