changeset 30:79b6d3ea92aa

dicomweb
author Sebastien Jodogne <s.jodogne@gmail.com>
date Wed, 20 Jul 2016 11:13:46 +0200
parents 1a6c863cf364
children 93bbfaf0e62c
files Sphinx/source/plugins/dicomweb.rst Sphinx/source/plugins/postgresql.rst
diffstat 2 files changed, 69 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/Sphinx/source/plugins/dicomweb.rst	Wed Jul 20 11:04:15 2016 +0200
+++ b/Sphinx/source/plugins/dicomweb.rst	Wed Jul 20 11:13:46 2016 +0200
@@ -4,6 +4,8 @@
 DICOMweb plugin
 ===============
 
+.. contents::
+
 This **official** plugin extends Orthanc with support of the `DICOMweb
 protocols <https://en.wikipedia.org/wiki/DICOMweb>`__. More precisely,
 the plugin introduces a basic, reference implementation of WADO-URI,
@@ -18,3 +20,69 @@
 <https://bitbucket.org/sjodogne/orthanc-dicomweb/src/default/Status.txt>`__. Some
 integration tests are `available separately
 <https://bitbucket.org/sjodogne/orthanc-tests/src/default/Plugins/DicomWeb/Run.py>`__.
+
+
+Compilation
+-----------
+
+.. highlight:: text
+
+The procedure to compile these plugins is similar of that for the
+:ref:`core of Orthanc <compiling>`. The following commands should work
+for every UNIX-like distribution (including GNU/Linux)::
+
+  $ mkdir Build
+  $ cd Build
+  $ cmake .. -DSTATIC_BUILD=ON
+  $ make
+
+The compilation will produce a shared library ``OrthancDicomWeb`` that
+contains the DICOMweb plugin.  Pre-compiled binaries for Microsoft
+Windows `are also available
+<http://www.orthanc-server.com/browse.php?path=/plugin-dicom-web>`__.
+A package for `Apple's Mac OS X
+<http://localhost/~jodogne/orthanc/static.php?page=download-mac>`__ is
+available courtesy of `Osimis <http://osimis.io/>`__.
+
+
+Usage
+-----
+
+.. highlight:: json
+
+You of course first have to :ref:`install Orthanc <compiling>`. Once
+Orthanc is installed, you must change the :ref:`configuration file
+<configuration>` to tell Orthanc where it can find the plugin: This is
+done by properly modifying the ``Plugins`` option. You could for
+instance use the following configuration file::
+
+  {
+    "Name" : "MyOrthanc",
+    [...]
+    "Plugins" : [
+      "/home/user/OrthancDicomWeb/Build/libOrthancDicomWeb.so"
+    ]
+  }
+
+The root of the DICOMweb REST API is then accessible at ``http://localhost:8042/dicom-web/``.
+
+
+Options
+-------
+
+.. highlight:: json
+
+Several configuration options are also available, and are listed in
+the example below::
+
+  {
+    "DicomWeb" : {
+      "Enable" : true,         // Whether DICOMweb support is enabled
+      "Root" : "/dicom-web/",  // Root URI of the DICOMweb API (for QIDO-RS, STOW-RS and WADO-RS)
+      "EnableWado" : true,     // Whether WADO-URI (aka. WADO) support is enabled
+      "WadoRoot" : "/wado",    // Root URI of the WADO-URI (aka. WADO) API
+      "Host" : "localhost",    // Hard-codes the name of the host for subsequent WADO-RS requests
+      "Ssl" : false            // Whether HTTPS should be used for subsequent WADO-RS requests
+    }
+  }
+
--- a/Sphinx/source/plugins/postgresql.rst	Wed Jul 20 11:04:15 2016 +0200
+++ b/Sphinx/source/plugins/postgresql.rst	Wed Jul 20 11:13:46 2016 +0200
@@ -36,7 +36,7 @@
 
 Pre-compiled binaries for Microsoft Windows `are also available
 <http://www.orthanc-server.com/browse.php?path=/plugin-postgresql>`__.
-Package for `Apple's Mac OS X
+A package for `Apple's Mac OS X
 <http://localhost/~jodogne/orthanc/static.php?page=download-mac>`__
 are available courtesy of `Osimis <http://osimis.io/>`__.