Run locally

git clone https://github.com/Garvan-Data-Science-Platform/ctrl.git && cd ctrl

Populate config:

cp application/backend/.env.example application/backend/.env

cp application/backend/config/config.json5.template application/backend/config.json5

Spin up db:

make db && make seed

Install dependencies and run application:

yarn && yarn dev

Access the user portal at localhost:5173 and admin portal at localhost:5174

Deploy in Production

Option 1: Helm Standalone

This option installs CTRL, it is up to the user to set up their own ingress, ssl certs etc.

helm install <release-name> oci://australia-southeast1-docker.pkg.dev/dsp-registry-410602/garvan-public/ctrl

It is recommended to install with a values.yaml file, based on: this template

At a minimum, you must set adminClient.hostname and userClient.hostname to the urls you are using to host the site.

Option 2: Helm + Extras

We have also created a helm chart intended to get a fully production-ready, cloud/on-prem VM deployment running (e.g. on K3S). It includes CTRL, nginx-ingress for ingress, letsencrypt for https and optionally other complementary apps (e.g. Elsa).

Refer to this link for instructions

Configuration:

Refer to this page for configuration instructions