Navigator

Installation

Prerequisites, installing the navigator command, and authenticating to pull the container image.

Suggest an edit

Prerequisites

  • A Linux x86_64 / amd64 host. The published image is currently linux/amd64 only; arm64 is not a supported production target.
  • Docker Engine 24+ with the docker compose plugin.
  • AWS CLI with the customer source access key supplied by Deep-MedChem. The source identity cannot pull from ECR directly; navigator login assumes the short-lived pull role automatically.
  • A license file — issued by Deep-MedChem for your machine (see Activate your license).

1. Install

git clone https://github.com/Deep-MedChem/dmc-navigator-on-prem.git
cd dmc-navigator-on-prem
./install_navigator.sh

This installs the navigator command at ~/.local/bin/dmc-navigator/navigator and seeds .env with the production image reference. Open a new shell (or export PATH="$PATH:$HOME/.local/bin/dmc-navigator") so navigator is on your PATH.

2. Authenticate and pull the image

The checked-in configuration uses this exact shared image:

815935788477.dkr.ecr.us-east-1.amazonaws.com/on-prem/dmc-navigator:stable

Configure the source access key supplied by Deep-MedChem under any AWS profile name you choose:

aws configure --profile dmc-navigator-source

Then authenticate and pull:

AWS_PROFILE=dmc-navigator-source navigator login
navigator pull
navigator roster      # public strategy metadata; no license required
navigator self-test   # packaged-runtime health; no license required

How login works

navigator login checks the active identity. Unless it is already an arn:aws:sts::815935788477:assumed-role/navigator-onprem-pull/... session, the script assumes arn:aws:iam::815935788477:role/navigator-onprem-pull, uses those temporary credentials only for the ECR password request, and discards them. It does not need jq and does not write assumed-role credentials to disk.

Updating the image

Run navigator update. It fetches the configured tag in .env (DMC_NAV_IMAGE_TAG) and reports whether the local image changed. Existing runs, inputs, and the installed license remain in place.

Existing `latest` installs

Change DMC_NAV_IMAGE_TAG=latest to DMC_NAV_IMAGE_TAG=stable in .env once, then run navigator update.

On this page