docs(faq, migrations, orthanc): Add FAQ for dynamic measurements, migration guides, and fix orthanc docker (#4217)

2024-06-08 08:52:03 -04:00
1 parent f044587b73
commit 4a3b37c6bb
@@ -0,0 +1,2 @@
+logs/*
+volumes/*
@@ -0,0 +1,86 @@
+worker_processes 2;
+error_log /var/logs/nginx/mydomain.error.log;
+pid /var/run/nginx.pid;
+include /usr/share/nginx/modules/*.conf; # See /usr/share/doc/nginx/README.dynamic.
+
+events {
+  worker_connections 1024; ## Default: 1024
+  use epoll; # http://nginx.org/en/docs/events.html
+  multi_accept on; # http://nginx.org/en/docs/ngx_core_module.html#multi_accept
+}
+
+# Core Modules Docs:
+# http://nginx.org/en/docs/http/ngx_http_core_module.html
+http {
+  include '/etc/nginx/mime.types';
+  default_type application/octet-stream;
+
+  keepalive_timeout 65;
+  keepalive_requests 100000;
+  tcp_nopush on;
+  tcp_nodelay on;
+
+
+
+  # Nginx `listener` block
+  server {
+    listen [::]:80 default_server;
+    listen 80;
+
+    gzip on;
+    gzip_types text/css application/javascript application/json image/svg+xml;
+    gzip_comp_level 9;
+    etag on;
+
+
+    # Reverse Proxy for `orthanc` APIs (including DICOMWeb)
+    #
+    location /pacs/ {
+
+      proxy_http_version 1.1;
+
+      proxy_set_header Host $host;
+      proxy_set_header X-Real-IP $remote_addr;
+      proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+      proxy_set_header X-Forwarded-Proto $scheme;
+
+      expires 0;
+      add_header Cache-Control private;
+
+      # Add CORS headers
+      # Note: uncomment the following line to allow all domains to access the Orthanc APIs
+      # You should actually only allow the domains you trust to access the APIs
+      # add_header 'Access-Control-Allow-Origin' '*' always;
+
+      proxy_pass http://orthanc:8042/;
+
+      # By default, this endpoint is protected by CORS (cross-origin-resource-sharing)
+      # You can add headers to allow other domains to request this resource.
+      # See the "Updating CORS Settings" example below
+    }
+
+
+    # Do not cache sw.js, required for offline-first updates.
+    location /sw.js {
+      add_header Cache-Control "no-cache";
+      proxy_cache_bypass $http_pragma;
+      proxy_cache_revalidate on;
+      expires off;
+      access_log off;
+    }
+
+
+    # Single Page App
+    # Try files, fallback to index.html
+    #
+    location / {
+      root /var/www/html;
+      index index.html;
+      try_files $uri $uri/ /index.html;
+      add_header Cache-Control "no-store, no-cache, must-revalidate";
+      add_header 'Cross-Origin-Opener-Policy' 'same-origin' always;
+      add_header 'Cross-Origin-Embedder-Policy' 'require-corp' always;
+    }
+
+  }
+}
@@ -0,0 +1,89 @@
+{
+  "Name": "Orthanc inside Docker",
+  "StorageDirectory": "/var/lib/orthanc/db",
+  "IndexDirectory": "/var/lib/orthanc/db",
+  "StorageCompression": false,
+  "MaximumStorageSize": 0,
+  "MaximumPatientCount": 0,
+  "LuaScripts": [],
+  "Plugins": ["/usr/share/orthanc/plugins", "/usr/local/share/orthanc/plugins"],
+  "ConcurrentJobs": 2,
+  "HttpServerEnabled": true,
+  "HttpPort": 8042,
+  "HttpDescribeErrors": true,
+  "HttpCompressionEnabled": true,
+  "DicomServerEnabled": true,
+  "DicomAet": "ORTHANC",
+  "DicomCheckCalledAet": false,
+  "DicomPort": 4242,
+  "DefaultEncoding": "Latin1",
+  "DeflatedTransferSyntaxAccepted": true,
+  "JpegTransferSyntaxAccepted": true,
+  "Jpeg2000TransferSyntaxAccepted": true,
+  "JpegLosslessTransferSyntaxAccepted": true,
+  "JpipTransferSyntaxAccepted": true,
+  "Mpeg2TransferSyntaxAccepted": true,
+  "RleTransferSyntaxAccepted": true,
+  "UnknownSopClassAccepted": false,
+  "DicomScpTimeout": 30,
+
+  "RemoteAccessAllowed": true,
+  "SslEnabled": false,
+  "SslCertificate": "certificate.pem",
+  "AuthenticationEnabled": false,
+  "RegisteredUsers": {
+    "test": "test"
+  },
+  "DicomModalities": {},
+  "DicomModalitiesInDatabase": false,
+  "DicomAlwaysAllowEcho": true,
+  "DicomAlwaysAllowStore": true,
+  "DicomCheckModalityHost": false,
+  "DicomScuTimeout": 10,
+  "OrthancPeers": {},
+  "OrthancPeersInDatabase": false,
+  "HttpProxy": "",
+
+  "HttpVerbose": true,
+
+  "HttpTimeout": 10,
+  "HttpsVerifyPeers": true,
+  "HttpsCACertificates": "",
+  "UserMetadata": {},
+  "UserContentType": {},
+  "StableAge": 60,
+  "StrictAetComparison": false,
+  "StoreMD5ForAttachments": true,
+  "LimitFindResults": 0,
+  "LimitFindInstances": 0,
+  "LimitJobs": 10,
+  "LogExportedResources": false,
+  "KeepAlive": true,
+  "TcpNoDelay": true,
+  "HttpThreadsCount": 50,
+  "StoreDicom": true,
+  "DicomAssociationCloseDelay": 5,
+  "QueryRetrieveSize": 10,
+  "CaseSensitivePN": false,
+  "LoadPrivateDictionary": true,
+  "Dictionary": {},
+  "SynchronousCMove": true,
+  "JobsHistorySize": 10,
+  "SaveJobs": true,
+  "OverwriteInstances": false,
+  "MediaArchiveSize": 1,
+  "StorageAccessOnFind": "Always",
+  "MetricsEnabled": true,
+
+  "DicomWeb": {
+    "Enable": true,
+    "Root": "/dicom-web/",
+    "EnableWado": true,
+    "WadoRoot": "/wado",
+    "Host": "127.0.0.1",
+    "Ssl": false,
+    "StowMaxInstances": 10,
+    "StowMaxSize": 10,
+    "QidoCaseSensitive": false
+  }
+}
@@ -0,0 +1,46 @@
+# Reference:
+# - https://docs.docker.com/compose/compose-file
+# - https://eclipsesource.com/blogs/2018/01/11/authenticating-reverse-proxy-with-keycloak/
+
+services:
+  # Exposed server that's handling incoming web requests
+  ohif_viewer:
+    build:
+      # Project root
+      context: ./../../../../
+      # Relative to context
+      dockerfile: ./platform/app/.recipes/Nginx-Orthanc/dockerfile
+    image: webapp:latest
+    container_name: ohif_orthanc
+    volumes:
+      # Nginx config
+      - ./config/nginx.conf:/etc/nginx/nginx.conf
+      # Logs
+      - ./logs/nginx:/var/logs/nginx
+      # Let's Encrypt
+      # - letsencrypt_certificates:/etc/letsencrypt
+      # - letsencrypt_challenges:/var/www/letsencrypt
+    ports:
+      - '443:443' # SSL
+      - '80:80' # Web
+    depends_on:
+      #   - keycloak
+      - orthanc
+    restart: on-failure
+
+  # LINK: https://hub.docker.com/r/jodogne/orthanc-plugins/
+  # TODO: Update to use Postgres
+  # https://github.com/mrts/docker-postgresql-multiple-databases
+  orthanc:
+    image: jodogne/orthanc-plugins
+    hostname: orthanc
+    container_name: orthancPACS
+    volumes:
+      # Config
+      - ./config/orthanc.json:/etc/orthanc/orthanc.json:ro
+      # Persist data
+      - ./volumes/orthanc-db/:/var/lib/orthanc/db/
+    restart: unless-stopped
+    ports:
+      - '4242:4242' # Orthanc REST API
+      - '8042:8042' # Orthanc HTTP
@@ -0,0 +1,44 @@
+# Stage 1: Build the application
+FROM node:18.16.1-slim as builder
+
+# Setup the working directory
+RUN mkdir /usr/src/app
+WORKDIR /usr/src/app
+
+# Install dependencies
+# apt-get update is combined with apt-get install to avoid using outdated packages
+RUN apt-get update && apt-get install -y build-essential python3
+
+# Copy package.json and other dependency-related files first
+# Assuming your package.json and yarn.lock or similar are located in the project root
+
+COPY . .
+
+# Install node dependencies
+# RUN yarn config set workspaces-experimental true
+# RUN yarn install
+
+# Copy the rest of the application code
+
+# set QUICK_BUILD to true to make the build faster for dev
+
+ENV APP_CONFIG=config/docker_nginx-orthanc-keycloak.js
+
+# Build the application
+# RUN yarn run build
+
+# # Stage 2: Bundle the built application into a Docker container which runs NGINX using Alpine Linux
+FROM nginx:alpine
+
+# # Create directories for logs and html content if they don't already exist
+RUN mkdir -p /var/log/nginx /var/www/html
+
+
+# # Copy build output to serve static files
+# COPY --from=builder /usr/src/app/platform/app/dist /var/www/html
+
+# # Expose HTTP and HTTPS ports
+EXPOSE 80 443
+
+# # Start NGINX
+CMD ["nginx", "-g", "daemon off;"]
@@ -2,6 +2,10 @@
 window.config = {
  routerBasename: '/',
  showStudyList: true,
+  customizationService: {
+    dicomUploadComponent:
+      '@ohif/extension-cornerstone.customizationModule.cornerstoneDicomUploadComponent',
+  },
  extensions: [],
  modes: [],
  // below flag is for performance reasons, but it might not work for all servers
@@ -23,6 +27,7 @@ window.config = {
        qidoSupportsIncludeField: false,
        imageRendering: 'wadors',
        thumbnailRendering: 'wadors',
+        dicomUploadEnabled: true,
        omitQuotationForMultipartRequest: true,
      },
    },
@@ -27,7 +27,8 @@ const areLocationsTheSame = (location0, location1) => {
 * @param {object} props
 * @param {function} props.children - Layout Template React Component
 */
-function DataSourceWrapper(props) {
+function DataSourceWrapper(props: withAppTypes) {
+  const { servicesManager } = props;
  const navigate = useNavigate();
  const { children: LayoutTemplate, ...rest } = props;
  const params = useParams();
@@ -188,14 +189,29 @@ function DataSourceWrapper(props) {
      if (isDataInvalid) {
        getData().catch(e => {
          console.error(e);
+
+          const { configurationAPI, friendlyName } = dataSource.getConfig();
          // If there is a data source configuration API, then the Worklist will popup the dialog to attempt to configure it
          // and attempt to resolve this issue.
-          if (dataSource.getConfig().configurationAPI) {
+          if (configurationAPI) {
            return;
          }

-          // No data source configuration API, so navigate to the not found server page.
-          navigate('/notfoundserver', '_self');
+          servicesManager.services.uiModalService.show({
+            title: 'Data Source Connection Error',
+            containerDimensions: 'w-1/2',
+            content: () => {
+              return (
+                <div>
+                  <p className="text-red-600">Error: {e.message}</p>
+                  <p>
+                    Please ensure the following data source is configured correctly or is running:
+                  </p>
+                  <div className="mt-2 font-bold">{friendlyName}</div>
+                </div>
+              );
+            },
+          });
        });
      }
    } catch (ex) {