othmane/ohif-viewer
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
33d06dba4e
ohif-viewer/docs/latest/deployment/index.md
dannyrb 33d06dba4e how it works
2019-04-30 11:56:13 -04:00

4.2 KiB
Raw Blame History

Deployment

The OHIF Viewer can be embedded in other web applications via it's packaged script source, or served up as a stand-alone PWA (progressive web application) by building and hosting a collection of static assets. In either case, you will need to configure your instance of the Viewer so that it can connect to your data source (the database or PACS that provides the data your Viewer will display).

Overview

Our goal is to make deployment as simple and painless as possible; however, there is an inherent amount of complexity in customizing, optimizing, and deploying web applications. If you find yourself a little lost, please don't hesitate to reach out for help

Deployment Scenarios

Embedded Viewer

The quickest and easiest way to get the OHIF Viewer up and running is to embed it into an existing web application. It allows us to forego a "build step", and add a powerful medical imaging viewer to an existing web page using only a few include tags.

{% include "./_embedded-viewer-diagram.md" %}

Stand-alone Viewer

Deploying the OHIF Viewer as a stand-alone web application provides many benefits, but comes at the cost of time and complexity. Some benefits include:

Today:

  • Leverage extensions to drop-in powerful new features
  • Add routes and customize the viewer's workflow
  • Finer control over styling and whitelabeling

In the future:

  • The ability to package the viewer for App Store distribution
  • Leverage service-workers for offline support and speed benefits from caching

Hosted Static Assets

At the end of the day, a production OHIF Viewer instance is a collection of HTML, CSS, JS, Font Files, and Images. We "build" those files from our source code with configuration specific to our project. We then make those files publicly accessible by hosting them on a Web Server.

If you have not deployed a web application before, this may be a good time to reach out for help, as these steps assume prior web development and deployment experience.

Part 1 - Build Production Assets

"Building", or creating, the files you will need is the same regardless of the web host you choose. You can find detailed instructions on how to configure and build the OHIF Viewer in our "Build for Production" guide.

Part 2 - Host Your App

There are a lot of benefits to hosting static assets

  • AWS S3 + Cloudfront
  • GCP + Cloudflare
  • Azure
  • Netlify (can use private repo)
  • Github pages

Note: Include SSL instructions.

...

Docker

  • Why Docker?
    • Ship your environment
    • "It works on my machine"

Ship Archive w/ Client: todo

...

Data

The OHIF Viewer is able to connect to any data source that implements the DICOM Web Standard. DICOM Web refers to RESTful DICOM Services -- a recently standardized set of guidelines for exchanging medical images and imaging metadata over the internet. Not all archives fully support it yet, but it is gaining wider adoption.

Configure Connection

...

What if I don't have an imaging archive?

...

Making sure your archive is accessible

  • CORS
  • Proxy (dangers)
  • Note: PACS not meant to be directly accesible from Web

Securing your data

  • Reach out to experts
  • Recipes

What if my archive doesn't support DICOM Web?

  • Mapping layer
  • GraphQL?