Merge pull request #24 from salimkanoun/dev

1.1 release

src/Orthanc_Standalone/Orthanc.json

@@ -1,4 +1,5 @@
-{  /**
+{
+  /**
    * General configuration of Orthanc
    **/
 
@@ -39,7 +40,7 @@
   // folders, in which case they will be scanned non-recursively to
   // find shared libraries. Backslashes must be either escaped by
   // doubling them, or replaced by forward slashes "/".
-  "Plugins" : ["./"
+  "Plugins" : [
   ],
 
   // Maximum number of processing jobs that are simultaneously running
@@ -126,7 +127,7 @@
    **/
 
   // Whether remote hosts can connect to the HTTP server
-  "RemoteAccessAllowed" : false,
+  "RemoteAccessAllowed" : true,
 
   // Whether or not SSL is enabled
   "SslEnabled" : false,
@@ -165,16 +166,42 @@
      * specific PACS manufacturers. The allowed values are currently:
      * - "Generic" (default value),
      * - "GenericNoWildcardInDates" (to replace "*" by "" in date fields 
-     *   in outgoing C-Find requests originating from Orthanc)
+     *   in outgoing C-Find requests originating from Orthanc),
      * - "GenericNoUniversalWildcard" (to replace "*" by "" in all fields
-     *   in outgoing C-Find SCU requests originating from Orthanc)
+     *   in outgoing C-Find SCU requests originating from Orthanc),
      * - "StoreScp" (storescp tool from DCMTK),
-     * - "ClearCanvas", "Dcm4Chee" and "Vitrea".
+     * - "ClearCanvas",
+     * - "Dcm4Chee",
+     * - "Vitrea",
+     * - "GE" (Enterprise Archive, MRI consoles and Advantage Workstation
+     *   from GE Healthcare).
+     *
      * This parameter is case-sensitive.
      **/
     // "clearcanvas" : [ "CLEARCANVAS", "192.168.1.1", 104, "ClearCanvas" ]
+
+    /**
+     * By default, the Orthanc SCP accepts all DICOM commands (C-GET,
+     * C-STORE, C-FIND, C-MOVE) issued by the remote SCU
+     * modalities. Starting with Orthanc 1.5.0, it is possible to
+     * specify which DICOM commands are allowed, separately for each
+     * remote modality, using the syntax below.
+     **/
+    //"untrusted" : {
+    //  "AET" : "ORTHANC",
+    //  "Port" : 104,
+    //  "Host" : "127.0.0.1",
+    //  "AllowEcho" : false,
+    //  "AllowFind" : false,
+    //  "AllowMove" : false,
+    //  "AllowStore" : true
+    //}
   },
 
+  // Whether to store the DICOM modalities in the Orthanc database
+  // instead of in this configuration file (new in Orthanc 1.5.0)
+  "DicomModalitiesInDatabase" : false,
+
   // Whether the Orthanc SCP allows incoming C-Echo requests, even
   // from SCU modalities it does not know about (i.e. that are not
   // listed in the "DicomModalities" option above). Orthanc 1.3.0
@@ -209,27 +236,37 @@
 
     /**
      * This is another, more advanced format to define Orthanc
-     * peers. It notably allows to specify a HTTPS client certificate
-     * in the PEM format (as in the "--cert" option of curl), or to
-     * enable PKCS#11 authentication for smart cards.
+     * peers. It notably allows to specify HTTP headers, a HTTPS
+     * client certificate in the PEM format (as in the "--cert" option
+     * of curl), or to enable PKCS#11 authentication for smart cards.
      **/
     // "peer" : {
     //   "Url" : "http://127.0.0.1:8043/",
     //   "Username" : "alice",
     //   "Password" : "alicePassword",
+    //   "HttpHeaders" : { "Token" : "Hello world" },
     //   "CertificateFile" : "client.crt",
     //   "CertificateKeyFile" : "client.key",
     //   "CertificateKeyPassword" : "certpass",
     //   "Pkcs11" : false
     // }
   },
 
+  // Whether to store the Orthanc peers in the Orthanc database
+  // instead of in this configuration file (new in Orthanc 1.5.0)
+  "OrthancPeersInDatabase" : false,
+
   // Parameters of the HTTP proxy to be used by Orthanc. If set to the
   // empty string, no HTTP proxy is used. For instance:
   //   "HttpProxy" : "192.168.0.1:3128"
   //   "HttpProxy" : "proxyUser:[email protected]:3128"
   "HttpProxy" : "",
 
+  // If set to "true", debug messages from libcurl will be issued
+  // whenever Orthanc makes an outgoing HTTP request. This is notably
+  // useful to debug HTTPS-related problems.
+  "HttpVerbose" : false,
+
   // Set the timeout for HTTP requests issued by Orthanc (in seconds).
   "HttpTimeout" : 10,
 
@@ -244,7 +281,9 @@
   // peers in HTTPS requests. From curl documentation ("--cacert"
   // option): "Tells curl to use the specified certificate file to
   // verify the peers. The file may contain multiple CA
-  // certificates. The certificate(s) must be in PEM format."
+  // certificates. The certificate(s) must be in PEM format." On
+  // Debian-based systems, this option can be set to
+  // "/etc/ssl/certs/ca-certificates.crt"
   "HttpsCACertificates" : "",
 
 
@@ -345,14 +384,6 @@
      }
    **/
 
-  // If set to "true", Orthanc will still handle "SOP Classes in
-  // Study" (0008,0062) in C-FIND requests, even if the "SOP Class
-  // UID" metadata is not available in the database (which is the case
-  // if the DB was previously used by Orthanc <= 1.1.0). This option
-  // is turned off by default, as it requires intensive accesses to
-  // the hard drive.
-  "AllowFindSopClassesInStudy" : false,
-
   // If set to "false", Orthanc will not load its default dictionary
   // of private tags. This might be necessary if you cannot import a
   // DICOM file encoded using the Implicit VR Endian transfer syntax,
@@ -381,13 +412,45 @@
   },
 
   // Whether to run DICOM C-Move operations synchronously. If set to
-  // "false" (the default), each incoming C-Move request results in
-  // creating a new background job. Until Orthanc 1.3.2, the default
-  // behavior was to use synchronous C-Move.
-  "SynchronousCMove" : false,
+  // "false" (asynchronous mode), each incoming C-Move request results
+  // in the creation of a new background job. Up to Orthanc 1.3.2, the
+  // implicit behavior was to use synchronous C-Move ("true"). Between
+  // Orthanc 1.4.0 and 1.4.2, the default behavior was set to
+  // asynchronous C-Move ("false"). Since Orthanc 1.5.0, the default
+  // behavior is back to synchronous C-Move ("true", which ensures
+  // backward compatibility with Orthanc <= 1.3.2).
+  "SynchronousCMove" : true,
 
   // Maximum number of completed jobs that are kept in memory. A
   // processing job is considered as complete once it is tagged as
-  // "Success" or "Failure".
-  "JobsHistorySize" : 10
+  // "Success" or "Failure". Since Orthanc 1.5.0, a value of "0"
+  // indicates to keep no job in memory (i.e. jobs are removed from
+  // the history as soon as they are completed).
+  "JobsHistorySize" : 10,
+
+  // Specifies how Orthanc reacts when it receives a DICOM instance
+  // whose SOPInstanceUID is already stored. If set to "true", the new
+  // instance replaces the old one. If set to "false", the new
+  // instance is discarded and the old one is kept. Up to Orthanc
+  // 1.4.1, the implicit behavior corresponded to "false".
+  "OverwriteInstances" : false,
+
+  // Maximum number of ZIP/media archives that are maintained by
+  // Orthanc, as a response to the asynchronous creation of archives.
+  // The least recently used archives get deleted as new archives are
+  // generated. This option was introduced in Orthanc 1.5.0, and has
+  // no effect on the synchronous generation of archives.
+  "MediaArchiveSize" : 1,
+
+  // Performance setting to specify how Orthanc accesses the storage
+  // area during C-FIND. Three modes are available: (1) "Always"
+  // allows Orthanc to read the storage area as soon as it needs an
+  // information that is not present in its database (slowest mode),
+  // (2) "Never" prevents Orthanc from accessing the storage area, and
+  // makes it uses exclusively its database (fastest mode), and (3)
+  // "Answers" allows Orthanc to read the storage area to generate its
+  // answers, but not to filter the DICOM resources (balance between
+  // the two modes). By default, the mode is "Always", which
+  // corresponds to the behavior of Orthanc <= 1.5.0.
+  "StorageAccessOnFind" : "Always"
 }

src/Orthanc_Standalone/OrthancCTP.json

@@ -1,4 +1,5 @@
-{  /**
+{
+  /**
    * General configuration of Orthanc
    **/
 
@@ -165,16 +166,42 @@
      * specific PACS manufacturers. The allowed values are currently:
      * - "Generic" (default value),
      * - "GenericNoWildcardInDates" (to replace "*" by "" in date fields 
-     *   in outgoing C-Find requests originating from Orthanc)
+     *   in outgoing C-Find requests originating from Orthanc),
      * - "GenericNoUniversalWildcard" (to replace "*" by "" in all fields
-     *   in outgoing C-Find SCU requests originating from Orthanc)
+     *   in outgoing C-Find SCU requests originating from Orthanc),
      * - "StoreScp" (storescp tool from DCMTK),
-     * - "ClearCanvas", "Dcm4Chee" and "Vitrea".
+     * - "ClearCanvas",
+     * - "Dcm4Chee",
+     * - "Vitrea",
+     * - "GE" (Enterprise Archive, MRI consoles and Advantage Workstation
+     *   from GE Healthcare).
+     *
      * This parameter is case-sensitive.
      **/
     // "clearcanvas" : [ "CLEARCANVAS", "192.168.1.1", 104, "ClearCanvas" ]
+
+    /**
+     * By default, the Orthanc SCP accepts all DICOM commands (C-GET,
+     * C-STORE, C-FIND, C-MOVE) issued by the remote SCU
+     * modalities. Starting with Orthanc 1.5.0, it is possible to
+     * specify which DICOM commands are allowed, separately for each
+     * remote modality, using the syntax below.
+     **/
+    //"untrusted" : {
+    //  "AET" : "ORTHANC",
+    //  "Port" : 104,
+    //  "Host" : "127.0.0.1",
+    //  "AllowEcho" : false,
+    //  "AllowFind" : false,
+    //  "AllowMove" : false,
+    //  "AllowStore" : true
+    //}
   },
 
+  // Whether to store the DICOM modalities in the Orthanc database
+  // instead of in this configuration file (new in Orthanc 1.5.0)
+  "DicomModalitiesInDatabase" : false,
+
   // Whether the Orthanc SCP allows incoming C-Echo requests, even
   // from SCU modalities it does not know about (i.e. that are not
   // listed in the "DicomModalities" option above). Orthanc 1.3.0
@@ -199,38 +226,49 @@
 
   // The list of the known Orthanc peers
   "OrthancPeers" : {
+
+  "Lysarc"  : [ "http://orthanc.kanoun.fr:80/", "salim", "salim" ]
     /**
      * Each line gives the base URL of an Orthanc peer, possibly
      * followed by the username/password pair (if the password
      * protection is enabled on the peer).
      **/
     // "peer"  : [ "http://127.0.0.1:8043/", "alice", "alicePassword" ]
     // "peer2" : [ "http://127.0.0.1:8044/" ]
-    "Lysarc"  : [ "http://orthanc.kanoun.fr:80/", "salim", "salim" ]
 
     /**
      * This is another, more advanced format to define Orthanc
-     * peers. It notably allows to specify a HTTPS client certificate
-     * in the PEM format (as in the "--cert" option of curl), or to
-     * enable PKCS#11 authentication for smart cards.
+     * peers. It notably allows to specify HTTP headers, a HTTPS
+     * client certificate in the PEM format (as in the "--cert" option
+     * of curl), or to enable PKCS#11 authentication for smart cards.
      **/
     // "peer" : {
     //   "Url" : "http://127.0.0.1:8043/",
     //   "Username" : "alice",
     //   "Password" : "alicePassword",
+    //   "HttpHeaders" : { "Token" : "Hello world" },
     //   "CertificateFile" : "client.crt",
     //   "CertificateKeyFile" : "client.key",
     //   "CertificateKeyPassword" : "certpass",
     //   "Pkcs11" : false
     // }
   },
 
+  // Whether to store the Orthanc peers in the Orthanc database
+  // instead of in this configuration file (new in Orthanc 1.5.0)
+  "OrthancPeersInDatabase" : false,
+
   // Parameters of the HTTP proxy to be used by Orthanc. If set to the
   // empty string, no HTTP proxy is used. For instance:
   //   "HttpProxy" : "192.168.0.1:3128"
   //   "HttpProxy" : "proxyUser:[email protected]:3128"
   "HttpProxy" : "",
 
+  // If set to "true", debug messages from libcurl will be issued
+  // whenever Orthanc makes an outgoing HTTP request. This is notably
+  // useful to debug HTTPS-related problems.
+  "HttpVerbose" : false,
+
   // Set the timeout for HTTP requests issued by Orthanc (in seconds).
   "HttpTimeout" : 10,
 
@@ -245,7 +283,9 @@
   // peers in HTTPS requests. From curl documentation ("--cacert"
   // option): "Tells curl to use the specified certificate file to
   // verify the peers. The file may contain multiple CA
-  // certificates. The certificate(s) must be in PEM format."
+  // certificates. The certificate(s) must be in PEM format." On
+  // Debian-based systems, this option can be set to
+  // "/etc/ssl/certs/ca-certificates.crt"
   "HttpsCACertificates" : "",
 
 
@@ -346,14 +386,6 @@
      }
    **/
 
-  // If set to "true", Orthanc will still handle "SOP Classes in
-  // Study" (0008,0062) in C-FIND requests, even if the "SOP Class
-  // UID" metadata is not available in the database (which is the case
-  // if the DB was previously used by Orthanc <= 1.1.0). This option
-  // is turned off by default, as it requires intensive accesses to
-  // the hard drive.
-  "AllowFindSopClassesInStudy" : false,
-
   // If set to "false", Orthanc will not load its default dictionary
   // of private tags. This might be necessary if you cannot import a
   // DICOM file encoded using the Implicit VR Endian transfer syntax,
@@ -382,13 +414,45 @@
   },
 
   // Whether to run DICOM C-Move operations synchronously. If set to
-  // "false" (the default), each incoming C-Move request results in
-  // creating a new background job. Until Orthanc 1.3.2, the default
-  // behavior was to use synchronous C-Move.
-  "SynchronousCMove" : false,
+  // "false" (asynchronous mode), each incoming C-Move request results
+  // in the creation of a new background job. Up to Orthanc 1.3.2, the
+  // implicit behavior was to use synchronous C-Move ("true"). Between
+  // Orthanc 1.4.0 and 1.4.2, the default behavior was set to
+  // asynchronous C-Move ("false"). Since Orthanc 1.5.0, the default
+  // behavior is back to synchronous C-Move ("true", which ensures
+  // backward compatibility with Orthanc <= 1.3.2).
+  "SynchronousCMove" : true,
 
   // Maximum number of completed jobs that are kept in memory. A
   // processing job is considered as complete once it is tagged as
-  // "Success" or "Failure".
-  "JobsHistorySize" : 10
+  // "Success" or "Failure". Since Orthanc 1.5.0, a value of "0"
+  // indicates to keep no job in memory (i.e. jobs are removed from
+  // the history as soon as they are completed).
+  "JobsHistorySize" : 10,
+
+  // Specifies how Orthanc reacts when it receives a DICOM instance
+  // whose SOPInstanceUID is already stored. If set to "true", the new
+  // instance replaces the old one. If set to "false", the new
+  // instance is discarded and the old one is kept. Up to Orthanc
+  // 1.4.1, the implicit behavior corresponded to "false".
+  "OverwriteInstances" : false,
+
+  // Maximum number of ZIP/media archives that are maintained by
+  // Orthanc, as a response to the asynchronous creation of archives.
+  // The least recently used archives get deleted as new archives are
+  // generated. This option was introduced in Orthanc 1.5.0, and has
+  // no effect on the synchronous generation of archives.
+  "MediaArchiveSize" : 1,
+
+  // Performance setting to specify how Orthanc accesses the storage
+  // area during C-FIND. Three modes are available: (1) "Always"
+  // allows Orthanc to read the storage area as soon as it needs an
+  // information that is not present in its database (slowest mode),
+  // (2) "Never" prevents Orthanc from accessing the storage area, and
+  // makes it uses exclusively its database (fastest mode), and (3)
+  // "Answers" allows Orthanc to read the storage area to generate its
+  // answers, but not to filter the DICOM resources (balance between
+  // the two modes). By default, the mode is "Always", which
+  // corresponds to the behavior of Orthanc <= 1.5.0.
+  "StorageAccessOnFind" : "Always"
 }