docker-images.md

Building Docker images

ZAViewer Docker images are available for download from dedicated Docker Hub repository.

We describe below the procedure to build the images from the sources.

Prerequisite:

• Docker Engine ^20.10 must be installed and running on your machine.

• Clone this git repo to get the latest sources

  git clone https://github.com/cau-riken/zaviewer.git
  
  cd zaviewer

Light web-server for the User Interface Docker image

The provided Docker script will:

• download dependencies and build ZAViewer UI from the source within a temporary image (so you don't have to setup the build environement on your machine)

• create an image containing a light memory footprint web server to serve the generated ZAViewer Web App.

1. Go to working directory containing ZAViewer sources :

   cd zaviewer

2. Build the image

   docker build --no-cache --network=host \
     -f docker_scripts/Dockerfile.ui \
     -t rikencau/zaviewer:latest-ui .

Note: As explained there, a personal github token is required to build the project.

If you've already created a local .npmrc in the project folder, it will be reused to build the Docker image.

Alternatively, if you don't want to store your token in the .npmrc, you may provide it to the Docker build via a build argument added to the docker build command line, as follow : --build-arg PACKAGEREAD_TOKEN='<REPLACE_BY_YOUR_TOKEN>'

Brain slice images import utility Docker image

1. Go to working directory containing ZAViewer sources :

   cd zaviewer

2. Build the image

   docker build --no-cache --network=host \
     -f docker_scripts/Dockerfile.prepDZIImages \
     -t rikencau/zaviewer:latest-prepimg scripts/

Region delineation editing UI Docker image

In order to save edited regions as SVG files, a minimal backend component needs to be used, thus it is necessary to create a new Docker image based on the ZAViewer Docker UI image.

1. Go to working directory containing ZAViewer sources :

   cd zaviewer

2. Build the image

   docker build --no-cache --network=host \
     -f docker_scripts/Dockerfile.ed \
     -t rikencau/zaviewer:latest-ed .