From 2be2e3fb5f52ae4a5ae6c4d64034a5cfe1c0157b Mon Sep 17 00:00:00 2001 From: Ryan Birmingham Date: Wed, 13 Feb 2019 13:44:28 -0500 Subject: [PATCH] format readme --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2fc2635..82520df 100644 --- a/README.md +++ b/README.md @@ -5,17 +5,26 @@ run with docker-compose -f caMicroscope.yml up ## Component Services mongo - vanilla mongo container + idxMongo - ephemeral container to index mongo + bindaas - api service for mongo (see https://github.com/sharmalab/bindaas) + iip - slide tile server (see https://github.com/camicroscope/iipImage) -viewer - hosts the viewer files and builds packages ( see https://github.com/camicroscope/caMicroscope.git) -loader - extracts metadata needed for image loading (see https://github.com/camicroscope/SlideLoader.git) + +viewer - hosts the viewer files and builds packages ( see https://github.com/camicroscope/caMicroscope) + +loader - extracts metadata needed for image loading (see https://github.com/camicroscope/SlideLoader) + elevate - security proxy (see https://github.com/camicroscope/Security) ## Configuration Logging - Container Logging is, for HIPAA reasons, disabled. Feel free to use a different logging engine if desired, especially for development. + Security and Routes - This is handled by the elevate service/ca-security container. By default routes go the viewer, unless a specific pattern in routes.json is matched. If security is enabled, supply the SECRET (pub key or secret of JWT) for verification, otherwise set DISABLE_SEC to true. + Image Volume - This is, by default, the images directory in this directory. If this is changed, please make the same change across all impacted services. + Packages - Packages are built in the viewer service using parcel, mount a different directory with packages.js to the package directory to overwrite or add functionality. ## Support