changeset 6693:6e137b01f124

review default configuration file
author Sebastien Jodogne <s.jodogne@gmail.com>
date Mon, 13 Apr 2026 12:16:07 +0200
parents 9b87df967968
children 1fff016b86e8
files NEWS OrthancServer/Resources/Configuration.json
diffstat 2 files changed, 55 insertions(+), 61 deletions(-) [+]
line wrap: on
line diff
--- a/NEWS	Mon Apr 13 11:47:29 2026 +0200
+++ b/NEWS	Mon Apr 13 12:16:07 2026 +0200
@@ -6,7 +6,7 @@
 
 * New configuration option "LoaderThreads", shared by actions that require loading multiple files,
   enabling the parallel loading of multiple DICOM instances, including:
-  - downloading zip archive/media,
+  - downloading ZIP archive/media,
   - performing a C-Store to a remote modality,
   - performing a peer transfer to a remote Orthanc,
   - responding to a C-Get request from a remote modality.
--- a/OrthancServer/Resources/Configuration.json	Mon Apr 13 11:47:29 2026 +0200
+++ b/OrthancServer/Resources/Configuration.json	Mon Apr 13 12:16:07 2026 +0200
@@ -2,7 +2,7 @@
   /**
    * General configuration of Orthanc
    *
-   * As a general recommendation, you should always favour absolute 
+   * As a general recommendation, you should always favor absoluteq
    * paths when you need to provide a path to a file or a directory.  
    * This is not done in this configuration file since we don't know 
    * where Orthanc is going to be installed.
@@ -51,7 +51,7 @@
   // In "Reject" mode, the sender will receive a 0xA700 DIMSE status code
   // if the instance was sent through C-Store, a 507 HTTP status code
   // if using the REST API and a 0xA700 Failure reason when using
-  // DicomWeb Stow-RS.
+  // DICOMweb Stow-RS.
   // Note: this value is taken into account only if you have set 
   // a MaximumStorageSize != 0 or a MaximumPatientCount != 0
   // Allowed values: "Recycle", "Reject"
@@ -117,17 +117,17 @@
   // HTTP port for the REST services and for the GUI
   "HttpPort" : 8042,
 
-  // IP addresses the HTTP server listens on.  
-  // This is usefull when, e.g. your computer has multiple network
+  // IP addresses the HTTP server listens on.
+  // This is notably useful if your computer has multiple network
   // interfaces and you want Orthanc to be accessible on a single
   // sub-network.
   // By default, the HTTP server listens on all IP addresses.
-  // Note that, setting "HttpBindAddresses" to ["127.0.0.1"] is
-  // almost equivalent to settting "RemoteAccessAllowed".  In the
-  // first case, external HTTP clients won't be able to connect at 
-  // all to Orthanc while, in the second case, external HTTP clients 
+  // Note that setting "HttpBindAddresses" to ["127.0.0.1"] is
+  // almost equivalent to setting "RemoteAccessAllowed". In the
+  // first case, external HTTP clients will not be able to connect at
+  // all to Orthanc while, in the second case, external HTTP clients
   // will be able to connect but will receive a 401 Unauthorized
-  // HTTP status code. 
+  // HTTP status code.
   //"HttpBindAddresses": ["1.2.3.4", "127.0.0.1"]
 
   // When the following option is "true", if an error is encountered
@@ -215,21 +215,18 @@
   "UnknownSopClassAccepted" : false,
 
   // The list of accepted Storage SOP classes.
-  // If empty or not defined, this list defaults
-  // to all storage classes defined in DCMTK in case of 
-  // C-STORE SCP and to a reduced list of 120 common storage
-  // classes in case of C-GET SCU.
+  // If empty or not defined, this list defaults to all storage classes
+  // defined in DCMTK in case of C-STORE SCP and to a reduced list of 120
+  // common storage classes in case of C-GET SCU.
   // List of DCMTK default Storage SOP Classes:
-  // https://github.com/DCMTK/dcmtk/blob/410ffe2019b9db6a8f4036daac742a6f5e4d36c2/dcmdata/libsrc/dcuid.cc#L664
+  // https://github.com/DCMTK/dcmtk/blob/master/dcmdata/libsrc/dcuid.cc#L664
   // Each entry can contain wildcards ("?" or "*") to add
-  // subsets of SOP classes that are defined in DCMTK defaults.
-  // "?" accepts any single character at that position.
-  // "*" accepts any string value at that position.
+  // subsets of SOP classes that are defined in DCMTK defaults:
+  // - "?" accepts any single character at that position.
+  // - "*" accepts any string value at that position.
   // If you want to add a a SOP class that is not defined in
-  // DCMTK defaults, you must add it explicitly.
-  // (new in Orthanc 1.12.6)
-  // Example to add a non standard class
-  // and keep the default ones:
+  // DCMTK defaults, you must add it explicitly. (new in Orthanc 1.12.6)
+  // Example to add a non standard class and keep the default ones:
   // "AcceptedSopClasses" : [
   //   "1.3.12.2.1107.5.9.1",
   //   "1.2.840.*"
@@ -241,11 +238,9 @@
   // ]
 
   // The list of rejected Storage SOP classes.
-  // This configuration is only meaningful if
-  // "AcceptedSopClasses" is using regular expressions
-  // or if it is not defined.
-  // Each entry can contain wildcards ("?" or "*").
-  // (new in Orthanc 1.12.6)
+  // This configuration is only meaningful if "AcceptedSopClasses" is using
+  // regular expressions or if it is not defined.
+  // Each entry can contain wildcards ("?" or "*"). (new in Orthanc 1.12.6)
   // "RejectedSopClasses" : [
   //   "1.2.840.10008.5.1.4.1.1.2",
   //   "1.2.840.10008.5.1.4.1.1.4"
@@ -545,7 +540,7 @@
   "DicomEchoChecksFind" : false,
 
   // Whether Orthanc uses C-MOVE or C-GET to retrieve a resource after
-  // a C-Find (when calling /queries/.../retrieve).
+  // a C-FIND (when calling "/queries/.../retrieve").
   // This configuration can be overridden for each modality by providing
   // "RetrieveMethod" in the "DicomModalities" entry.
   // (new in Orthanc 1.12.6)
@@ -574,12 +569,11 @@
   // be run when Orthanc is acting as SCP. 
   // Note: This is not limiting the number of concurrent connections
   // but the number of concurrent DICOM operations.
-  // E.g, with a single thread, if a C-Find is received during
-  // e.g the transcoding of an incoming C-Store, the C-Find will 
+  // For instance, with a single thread, if a C-Find request is received during
+  // e.g. the transcoding of an incoming C-Store, the C-Find will
   // be processed only at the end of the C-Store operation but both
-  // DICOM assocations will remain active. 
-  // (new in Orthanc 1.10.0, before this version, the value was 
-  // fixed to 4)
+  // DICOM associations will remain active.
+  // (new in Orthanc 1.10.0, before this version, the value was fixed to 4)
   "DicomThreadsCount" : 4,
 
   // The list of the known Orthanc peers. This option is ignored if
@@ -634,9 +628,9 @@
   // Set the timeout for HTTP requests issued by Orthanc (in seconds).
   "HttpTimeout" : 60,
 
-  // Enable the verification of the peers certificates during HTTPS 
-  // requests. Setting this option to false is equivalent to the 
-  // "--insecure" curl option. Pay attention that setting this option 
+  // Enable the verification of the peers certificates during HTTPS
+  // requests. Setting this option to "false" is equivalent to the
+  // "--insecure" curl option. Pay attention that setting this option
   // to "false" results in security risks!
   // Reference: http://curl.haxx.se/docs/sslcerts.html
   "HttpsVerifyPeers" : true,
@@ -695,12 +689,12 @@
   // The maximum number of results for a single C-FIND request at the
   // Patient, Study or Series level. Setting this option to "0" means
   // no limit.
-  // Note: this limit is also used in the /tools/find API route.
+  // Note: This limit is also used in the "/tools/find" API route.
   "LimitFindResults" : 0,
 
   // The maximum number of results for a single C-FIND request at the
   // Instance level. Setting this option to "0" means no limit.
-  // Note: this limit is also used in the /tools/find API route.
+  // Note: This limit is also used in the "/tools/find" API route.
   "LimitFindInstances" : 0,
 
   // If this option is set to "true" (default behavior until Orthanc
@@ -857,8 +851,8 @@
   "MediaArchiveSize" : 1,
 
   // Performance setting to specify how Orthanc accesses the storage
-  // area during find operations (C-FIND, /tools/find API route and
-  // QIDO-RS in dicom-web). Three modes are available: (1) "Always"
+  // area during find operations (C-FIND, "/tools/find", API route, and
+  // QIDO-RS in the DICOMweb plugin). 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
@@ -871,7 +865,7 @@
 
   // Whether Orthanc monitors its metrics (new in Orthanc 1.5.4). If
   // set to "true", the metrics can be retrieved at
-  // "/tools/metrics-prometheus" formetted using the Prometheus
+  // "/tools/metrics-prometheus" formatted using the Prometheus
   // text-based exposition format.
   "MetricsEnabled" : true,
 
@@ -946,7 +940,7 @@
   // will run more slowly, but the DICOM are guaranteed to be
   // immediately written to the disk. This option only makes sense if
   // the builtin filesystem storage area is used or the advanced
-  // storage plugin. It defaults to "false" in Orthanc <= 1.7.3, 
+  // storage plugin. It defaults to "false" in Orthanc <= 1.7.3,
   // and to "true" in Orthanc >= 1.7.4.
   "SyncStorageArea" : true,
 
@@ -964,7 +958,7 @@
   // Deidentify/anonymize the contents of the logs (notably C-FIND,
   // C-GET, and C-MOVE queries submitted to Orthanc) according to
   // Table E.1-1 of the DICOM standard (new in Orthanc 1.8.2).
-  // Note that, the DICOM logs at TRACE level are not deidentified !
+  // Note that the DICOM logs at TRACE level are not deidentified!
   "DeidentifyLogs" : true,
 
   // If "DeidentifyLogs" is true, this sets the DICOM standard to
@@ -1010,19 +1004,19 @@
   // as soon as one DICOM file gets compressed (new in Orthanc 1.9.4)
   "SynchronousZipStream" : true,
 
-  // Default number of loader threads when reading files from disk when
-  // executing some tasks:
-  // - generating archive/media, 
-  // - executing a C-Store 
+  // Default number of loader threads to use in jobs that read multiple files
+  // from the storage area when executing some tasks, including:
+  // - generating archive/media,
+  // - executing a C-Store,
   // - transmitting resources through Orthanc peering.
   // A value of 0 and 1 are equivalent: a single thread is used.
-  // A value > 1 is meaningful only if the storage
-  // is a distributed network storage (e.g object storage plugin).
+  // A value > 1 is meaningful only if the storage is a distributed network storage
+  // (e.g., object storage plugin).
   // (new in Orthanc 1.12.11)
-  // Note, from 1.10.0 to 1.12.10, a "ZipLoaderThreads" configuration
-  // was available only for the zip archive/media.  It is still valid
+  // Note, from 1.10.0 to 1.12.10, a "ZipLoaderThreads" configuration option
+  // was available only for the ZIP archive/media. It is still available
   // for backward compatibility.
-  "LoaderThreads": 1,
+  "LoaderThreads" : 1,
 
   // Extra Main Dicom tags that are stored in DB together with all default
   // Main Dicom tags that are already stored.
@@ -1104,7 +1098,7 @@
 
   // Maximum number of DCMTK transcoders that are simultaneously running
   // at any given time. A value of "0" indicates to use all the
-  // available CPU logical cores. Prior to Orthanc 1.12.6, there were not limit.
+  // available CPU logical cores. Prior to Orthanc 1.12.6, there was not limit.
   // (new in Orthanc 1.12.6)
   "MaximumConcurrentDcmtkTranscoders" : 0,
 
@@ -1121,18 +1115,18 @@
   // limit (default in Orthanc <= 1.12.10). (new in Orthanc 1.12.11)
   "MaximumRequestBodySizeMB" : 8192,
 
-  // Maximum allowed size (in MB) of a single file after decompression 
+  // Maximum allowed size (in MB) of a single file after decompression
   // when it is contained in a ZIP or gzip archive, to prevent resource
   // exhaustion by ZIP/gzip bombs. A value of "0" means no limit (this
   // was the default in Orthanc <= 1.12.10). (new in Orthanc 1.12.11)
   "MaximumFileSizeInArchiveMB" : 4096,
 
-  // When set to false, this option disables all /patients routes and
-  // disables patients related sanity checks when performing resource
-  // modification.  This is required e.g when your Orthanc stores
-  // resources from multiple sources in which the same PatientID might
-  // be attached to different patients because there is no centralized
-  // patient id management. (new in Orthanc 1.12.11)
-  // As of 1.12.11, this is an experimental configuration.
+  // When set to "false", this option disables all "/patients" routes
+  // and disables patient-level sanity checks when performing resource
+  // modification. This is notably useful if your Orthanc stores DICOM
+  // resources from multiple sources, in which the same PatientID
+  // might be assigned to different patients because there is no
+  // centralized patient ID management. (new in Orthanc 1.12.11)
+  // Warning: As of 1.12.11, this is an experimental configuration.
   "PatientLevelEnabled": true
 }