Skip to main content
Version: Version 3.3 - Segmentation Support 🚧

Docker

The OHIF source code provides a Dockerfile to create and run a Docker image that containerizes an nginx web server serving the OHIF Viewer.

Good to Know

The OHIF Viewer Docker image for the v3-stable branch is not yet published. The available image in Docker Hub is based on the master branch.

Prequisites

The machine on which to build and run the Docker container must have:

  1. All of the requirements for building a production version of OHIF.
  2. A checked out branch of the OHIF Viewer.
  3. Docker installed.

Building the Docker Image

The docker image can be built from a terminal window as such:

  1. Switch to the OHIF Viewer code root directory.

  2. Issue the following docker command. Note that what follows -t flag is the {name}:{tag} for the Docker image and is arbitrary when creating a local Docker image.

    docker build . -t ohif-viewer-image

Running the Docker Container

Once the Docker image has been built, it can be run as a container from the command line as in the block below. Note that the last argument to the command is the name of the Docker image and the table below describes the other arguments.

FlagDescription
-dRun the container in the background and print the container ID
-p {host-port}:{nginx-port}/tcpPublish the nginx listen port on the given host port
--nameAn arbitrary name for the container.
docker run -d -p 3000:80/tcp --name ohif-viewer-container ohif-viewer-image

Configuring the nginx Listen Port

The Dockerfile and entry point use the ${PORT} environment variable as the port that the nginx server uses to serve the web server. The default value for ${PORT} is 80. One way to set this environment variable is to use the -e switch when running the container with docker run. The block below gives an example where the listen port is set to 8080 and publised on the host as 3000.

docker run -d -e PORT=8080 -p 3000:8080/tcp --name ohif-viewer-container ohif-viewer-image