Skip to content

Installation Option C: Build from Source

Jump to bottom
Edgar edited this page Mar 22, 2023 · 4 revisions

The Dockerfile may optionally use the various proteinpaint-* packages as packed from source code.

Installation

# clone this repo
git clone https://github.com/stjude/proteinpaint.git
cd proteinpaint/container

# OPTIONAL: pack workspaces and replace each package.json's 
# dependency versions with the tarball location as copied into the Docker build
# if this script is not used, then published packages will be used in the Docker build
./pack.sh

# will run docker build
./build.sh

Usage

To test, make sure that your current working directory has

  • a serverconfig.json which has
    • a tpmasterdir entry, for the absolute path to the data directory
    • a "URL": "http://localhost:[PORT]" entry (default PORT=3456, can be set to any valid, non-conflicting numeric port value)
  • an optional dataset folder, containing js files of any serverconfig.genomes.datasets[] entry that is not already included in proteinpaint/server/dataset
TAG=latest # can change to a version number like 2.11.2
IMAGE_NAME=ppfull:$TAG # may use server:$TAG for server-only image

./run.sh $IMAGE_NAME [CONTAINER_NAME='pp'] # start a container process

# open the browser to your serverconfig.URL entry
# example routes to check, assuming serverconfig.URL=http://localhost:3456
# http://localhost:3456/healthcheck
# http://localhost:3456/genomes
# http://localhost:3456 should open the Proteinpaint landing page

# Hints:
# - inspect logs with 'docker logs pp'
# - ssh into the container with 'docker exec -it pp'
# - stop the container with 'docker stop pp'
Clone this wiki locally