orthanc: OrthancServer/Resources/Configuration.json annotate

annotate OrthancServer/Resources/Configuration.json @ 5611:1a995c6f9dae default

deprecating the "requestedTags" GET argument in favor of "requested-tags"

author	Sebastien Jodogne <s.jodogne@gmail.com>
date	Thu, 09 May 2024 10:43:10 +0200
parents	68e9f7815fb8
children

rev	line source
683 7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	1 {
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	2 /**
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	3 * General configuration of Orthanc
5174 d75af1cde602 absolute path recommandation Alain Mazy <am@osimis.io> parents: 5130 diff changeset	4 *
d75af1cde602 absolute path recommandation Alain Mazy <am@osimis.io> parents: 5130 diff changeset	5 * As a general recommendation, you should always favour absolute
d75af1cde602 absolute path recommandation Alain Mazy <am@osimis.io> parents: 5130 diff changeset	6 * paths when you need to provide a path to a file or a directory.
d75af1cde602 absolute path recommandation Alain Mazy <am@osimis.io> parents: 5130 diff changeset	7 * This is not done in this configuration file since we don't know
d75af1cde602 absolute path recommandation Alain Mazy <am@osimis.io> parents: 5130 diff changeset	8 * where Orthanc is going to be installed.
683 7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	9 **/
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	10
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	11 // The logical name of this instance of Orthanc. This one is
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	12 // displayed in Orthanc Explorer and at the URI "/system".
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	13 "Name" : "MyOrthanc",
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	14
2229 0f09c1d18584 note about backslashes Sebastien Jodogne <s.jodogne@gmail.com> parents: 2208 diff changeset	15 // Path to the directory that holds the heavyweight files (i.e. the
0f09c1d18584 note about backslashes Sebastien Jodogne <s.jodogne@gmail.com> parents: 2208 diff changeset	16 // raw DICOM instances). Backslashes must be either escaped by
0f09c1d18584 note about backslashes Sebastien Jodogne <s.jodogne@gmail.com> parents: 2208 diff changeset	17 // doubling them, or replaced by forward slashes "/".
683 7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	18 "StorageDirectory" : "OrthancStorage",
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	19
2229 0f09c1d18584 note about backslashes Sebastien Jodogne <s.jodogne@gmail.com> parents: 2208 diff changeset	20 // Path to the directory that holds the SQLite index (if unset, the
0f09c1d18584 note about backslashes Sebastien Jodogne <s.jodogne@gmail.com> parents: 2208 diff changeset	21 // value of StorageDirectory is used). This index could be stored on
0f09c1d18584 note about backslashes Sebastien Jodogne <s.jodogne@gmail.com> parents: 2208 diff changeset	22 // a RAM-drive or a SSD device for performance reasons.
683 7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	23 "IndexDirectory" : "OrthancStorage",
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	24
3181 6fd38327e777 Fix issue #130 (Orthanc failed to start when /tmp partition was full) Sebastien Jodogne <s.jodogne@gmail.com> parents: 3180 diff changeset	25 // Path to the directory where Orthanc stores its large temporary
4315 e62bd014ae5c removed EMSCRIPTEN_SET_LLVM_WASM_BACKEND option for CMake Sebastien Jodogne <s.jodogne@gmail.com> parents: 4243 diff changeset	26 // files. The content of this folder can be safely deleted once
e62bd014ae5c removed EMSCRIPTEN_SET_LLVM_WASM_BACKEND option for CMake Sebastien Jodogne <s.jodogne@gmail.com> parents: 4243 diff changeset	27 // Orthanc is stopped. The folder must exist. The corresponding
3183 98187ab5a4c9 config Sebastien Jodogne <s.jodogne@gmail.com> parents: 3181 diff changeset	28 // filesystem must be properly sized, given that for instance a ZIP
98187ab5a4c9 config Sebastien Jodogne <s.jodogne@gmail.com> parents: 3181 diff changeset	29 // archive of DICOM images created by a job can weight several GBs,
98187ab5a4c9 config Sebastien Jodogne <s.jodogne@gmail.com> parents: 3181 diff changeset	30 // and that there might be up to "min(JobsHistorySize,
98187ab5a4c9 config Sebastien Jodogne <s.jodogne@gmail.com> parents: 3181 diff changeset	31 // MediaArchiveSize)" archives to be stored simultaneously. If not
3181 6fd38327e777 Fix issue #130 (Orthanc failed to start when /tmp partition was full) Sebastien Jodogne <s.jodogne@gmail.com> parents: 3180 diff changeset	32 // set, Orthanc will use the default temporary folder of the
6fd38327e777 Fix issue #130 (Orthanc failed to start when /tmp partition was full) Sebastien Jodogne <s.jodogne@gmail.com> parents: 3180 diff changeset	33 // operating system (such as "/tmp/" on UNIX-like systems, or
6fd38327e777 Fix issue #130 (Orthanc failed to start when /tmp partition was full) Sebastien Jodogne <s.jodogne@gmail.com> parents: 3180 diff changeset	34 // "C:/Temp" on Microsoft Windows).
6fd38327e777 Fix issue #130 (Orthanc failed to start when /tmp partition was full) Sebastien Jodogne <s.jodogne@gmail.com> parents: 3180 diff changeset	35 // "TemporaryDirectory" : "/tmp/Orthanc/",
6fd38327e777 Fix issue #130 (Orthanc failed to start when /tmp partition was full) Sebastien Jodogne <s.jodogne@gmail.com> parents: 3180 diff changeset	36
683 7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	37 // Enable the transparent compression of the DICOM instances
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	38 "StorageCompression" : false,
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	39
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	40 // Maximum size of the storage in MB (a value of "0" indicates no
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	41 // limit on the storage size)
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	42 "MaximumStorageSize" : 0,
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	43
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	44 // Maximum number of patients that can be stored at a given time
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	45 // in the storage (a value of "0" indicates no limit on the number
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	46 // of patients)
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	47 "MaximumPatientCount" : 0,
4792 434843934307 Added a StorageCache in the StorageAccessor Alain Mazy <am@osimis.io> parents: 4774 diff changeset	48
5061 e95fadefeb72 new MaximumStorageMode configuration Alain Mazy <am@osimis.io> parents: 5017 diff changeset	49 // Action to take when the maximum storage is reached.
e95fadefeb72 new MaximumStorageMode configuration Alain Mazy <am@osimis.io> parents: 5017 diff changeset	50 // By default, the patients are recycled ("Recycle" mode).
e95fadefeb72 new MaximumStorageMode configuration Alain Mazy <am@osimis.io> parents: 5017 diff changeset	51 // In "Reject" mode, the sender will receive a 0xA700 DIMSE status code
e95fadefeb72 new MaximumStorageMode configuration Alain Mazy <am@osimis.io> parents: 5017 diff changeset	52 // if the instance was sent through C-Store, a 507 HTTP status code
5201 345dac17a349 text Sebastien Jodogne <s.jodogne@gmail.com> parents: 5200 diff changeset	53 // if using the REST API and a 0xA700 Failure reason when using
5467 68e9f7815fb8 Clarified recycle/reject + protection Alain Mazy <am@osimis.io> parents: 5432 diff changeset	54 // DicomWeb Stow-RS.
68e9f7815fb8 Clarified recycle/reject + protection Alain Mazy <am@osimis.io> parents: 5432 diff changeset	55 // Note: this value is taken into account only if you have set
68e9f7815fb8 Clarified recycle/reject + protection Alain Mazy <am@osimis.io> parents: 5432 diff changeset	56 // a MaximumStorageSize != 0 or a MaximumPatientCount != 0
5061 e95fadefeb72 new MaximumStorageMode configuration Alain Mazy <am@osimis.io> parents: 5017 diff changeset	57 // Allowed values: "Recycle", "Reject"
e95fadefeb72 new MaximumStorageMode configuration Alain Mazy <am@osimis.io> parents: 5017 diff changeset	58 // (new in Orthanc 1.11.2)
e95fadefeb72 new MaximumStorageMode configuration Alain Mazy <am@osimis.io> parents: 5017 diff changeset	59 "MaximumStorageMode" : "Recycle",
e95fadefeb72 new MaximumStorageMode configuration Alain Mazy <am@osimis.io> parents: 5017 diff changeset	60
4792 434843934307 Added a StorageCache in the StorageAccessor Alain Mazy <am@osimis.io> parents: 4774 diff changeset	61 // Maximum size of the storage cache in MB. The storage cache
434843934307 Added a StorageCache in the StorageAccessor Alain Mazy <am@osimis.io> parents: 4774 diff changeset	62 // is stored in RAM and contains a copy of recently accessed
434843934307 Added a StorageCache in the StorageAccessor Alain Mazy <am@osimis.io> parents: 4774 diff changeset	63 // files (written or read). A value of "0" indicates the cache
4902 df86d2505df8 Orthanc 1.9.8 is now known as Orthanc 1.10.0 Sebastien Jodogne <s.jodogne@gmail.com> parents: 4888 diff changeset	64 // is disabled. (new in Orthanc 1.10.0)
4792 434843934307 Added a StorageCache in the StorageAccessor Alain Mazy <am@osimis.io> parents: 4774 diff changeset	65 "MaximumStorageCacheSize" : 128,
434843934307 Added a StorageCache in the StorageAccessor Alain Mazy <am@osimis.io> parents: 4774 diff changeset	66
893 f57802f8b4dc plugins for windows Sebastien Jodogne <s.jodogne@gmail.com> parents: 891 diff changeset	67 // List of paths to the custom Lua scripts that are to be loaded
f57802f8b4dc plugins for windows Sebastien Jodogne <s.jodogne@gmail.com> parents: 891 diff changeset	68 // into this instance of Orthanc
683 7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	69 "LuaScripts" : [
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	70 ],
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	71
5017 0d61efc6256c Added Lua OnHeartBeat() Alain Mazy <am@osimis.io> parents: 4944 diff changeset	72 // The period (in seconds) between 2 calls of the "OnHeartBeat"
0d61efc6256c Added Lua OnHeartBeat() Alain Mazy <am@osimis.io> parents: 4944 diff changeset	73 // lua callback. O means the heart beat is disabled.
0d61efc6256c Added Lua OnHeartBeat() Alain Mazy <am@osimis.io> parents: 4944 diff changeset	74 // TODO: text below for Orthanc book:
5130 f2dcdbe05884 ResourceModification jobs can now use multiple threads Alain Mazy <am@osimis.io> parents: 5119 diff changeset	75 // Note: that the period is actually not the delay between
5017 0d61efc6256c Added Lua OnHeartBeat() Alain Mazy <am@osimis.io> parents: 4944 diff changeset	76 // the end of an execution and the triggering of the next one.
0d61efc6256c Added Lua OnHeartBeat() Alain Mazy <am@osimis.io> parents: 4944 diff changeset	77 // Since there is only one lua context, if other lua code is being
0d61efc6256c Added Lua OnHeartBeat() Alain Mazy <am@osimis.io> parents: 4944 diff changeset	78 // executed, the heart beat might be delayed even more.
0d61efc6256c Added Lua OnHeartBeat() Alain Mazy <am@osimis.io> parents: 4944 diff changeset	79 "LuaHeartBeatPeriod" : 0,
0d61efc6256c Added Lua OnHeartBeat() Alain Mazy <am@osimis.io> parents: 4944 diff changeset	80
893 f57802f8b4dc plugins for windows Sebastien Jodogne <s.jodogne@gmail.com> parents: 891 diff changeset	81 // List of paths to the plugins that are to be loaded into this
1199 a843ee8bb903 separated thread for change callbacks in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1164 diff changeset	82 // instance of Orthanc (e.g. "./libPluginTest.so" for Linux, or
1272 7442097b41c9 Scan of folders for plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1199 diff changeset	83 // "./PluginTest.dll" for Windows). These paths can refer to
7442097b41c9 Scan of folders for plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1199 diff changeset	84 // folders, in which case they will be scanned non-recursively to
2229 0f09c1d18584 note about backslashes Sebastien Jodogne <s.jodogne@gmail.com> parents: 2208 diff changeset	85 // find shared libraries. Backslashes must be either escaped by
0f09c1d18584 note about backslashes Sebastien Jodogne <s.jodogne@gmail.com> parents: 2208 diff changeset	86 // doubling them, or replaced by forward slashes "/".
891 d0a08d8881b7 configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 732 diff changeset	87 "Plugins" : [
d0a08d8881b7 configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 732 diff changeset	88 ],
683 7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	89
2736 02e04783f84b typo Sebastien Jodogne <s.jodogne@gmail.com> parents: 2685 diff changeset	90 // Maximum number of processing jobs that are simultaneously running
2570 2e879c796ec7 JobsRegistry::SubmitAndWait(), StoreScuJob Sebastien Jodogne <s.jodogne@gmail.com> parents: 2375 diff changeset	91 // at any given time. A value of "0" indicates to use all the
2e879c796ec7 JobsRegistry::SubmitAndWait(), StoreScuJob Sebastien Jodogne <s.jodogne@gmail.com> parents: 2375 diff changeset	92 // available CPU logical cores. To emulate Orthanc <= 1.3.2, set
2e879c796ec7 JobsRegistry::SubmitAndWait(), StoreScuJob Sebastien Jodogne <s.jodogne@gmail.com> parents: 2375 diff changeset	93 // this value to "1".
2e879c796ec7 JobsRegistry::SubmitAndWait(), StoreScuJob Sebastien Jodogne <s.jodogne@gmail.com> parents: 2375 diff changeset	94 "ConcurrentJobs" : 2,
683 7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	95
5130 f2dcdbe05884 ResourceModification jobs can now use multiple threads Alain Mazy <am@osimis.io> parents: 5119 diff changeset	96 // Defines the number of threads that are used to execute each type of
f2dcdbe05884 ResourceModification jobs can now use multiple threads Alain Mazy <am@osimis.io> parents: 5119 diff changeset	97 // jobs (for the jobs that can be parallelized).
f2dcdbe05884 ResourceModification jobs can now use multiple threads Alain Mazy <am@osimis.io> parents: 5119 diff changeset	98 // A value of "0" indicates to use all the available CPU logical cores.
f2dcdbe05884 ResourceModification jobs can now use multiple threads Alain Mazy <am@osimis.io> parents: 5119 diff changeset	99 // (new in Orthanc 1.11.3)
f2dcdbe05884 ResourceModification jobs can now use multiple threads Alain Mazy <am@osimis.io> parents: 5119 diff changeset	100 "JobsEngineThreadsCount" : {
f2dcdbe05884 ResourceModification jobs can now use multiple threads Alain Mazy <am@osimis.io> parents: 5119 diff changeset	101 "ResourceModification": 1 // for /anonymize, /modify
f2dcdbe05884 ResourceModification jobs can now use multiple threads Alain Mazy <am@osimis.io> parents: 5119 diff changeset	102 },
1592 d73124f6b439 configuration option HttpDescribeErrors Sebastien Jodogne <s.jodogne@gmail.com> parents: 1590 diff changeset	103
683 7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	104 /**
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	105 * Configuration of the HTTP server
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	106 **/
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	107
1592 d73124f6b439 configuration option HttpDescribeErrors Sebastien Jodogne <s.jodogne@gmail.com> parents: 1590 diff changeset	108 // Enable the HTTP server. If this parameter is set to "false",
d73124f6b439 configuration option HttpDescribeErrors Sebastien Jodogne <s.jodogne@gmail.com> parents: 1590 diff changeset	109 // Orthanc acts as a pure DICOM server. The REST API and Orthanc
d73124f6b439 configuration option HttpDescribeErrors Sebastien Jodogne <s.jodogne@gmail.com> parents: 1590 diff changeset	110 // Explorer will not be available.
d73124f6b439 configuration option HttpDescribeErrors Sebastien Jodogne <s.jodogne@gmail.com> parents: 1590 diff changeset	111 "HttpServerEnabled" : true,
d73124f6b439 configuration option HttpDescribeErrors Sebastien Jodogne <s.jodogne@gmail.com> parents: 1590 diff changeset	112
4379 85b5b0e1bac9 added NEWS about "OrthancExplorerEnabled" option Sebastien Jodogne <s.jodogne@gmail.com> parents: 4378 diff changeset	113 // Enable/disable the Orthanc Explorer Web user interface. This
85b5b0e1bac9 added NEWS about "OrthancExplorerEnabled" option Sebastien Jodogne <s.jodogne@gmail.com> parents: 4378 diff changeset	114 // option is only meaningful if the "HttpServerEnabled" option is
85b5b0e1bac9 added NEWS about "OrthancExplorerEnabled" option Sebastien Jodogne <s.jodogne@gmail.com> parents: 4378 diff changeset	115 // set to "true" (new in Orthanc 1.8.2).
4378 9e2fc6911ac8 adding option to disable orthance explorer when http server is enabled Andrew Wallis <andrew.wallis@varian.com>> parents: 4376 diff changeset	116 "OrthancExplorerEnabled" : true,
9e2fc6911ac8 adding option to disable orthance explorer when http server is enabled Andrew Wallis <andrew.wallis@varian.com>> parents: 4376 diff changeset	117
683 7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	118 // HTTP port for the REST services and for the GUI
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	119 "HttpPort" : 8042,
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	120
1592 d73124f6b439 configuration option HttpDescribeErrors Sebastien Jodogne <s.jodogne@gmail.com> parents: 1590 diff changeset	121 // When the following option is "true", if an error is encountered
d73124f6b439 configuration option HttpDescribeErrors Sebastien Jodogne <s.jodogne@gmail.com> parents: 1590 diff changeset	122 // while calling the REST API, a JSON message describing the error
d73124f6b439 configuration option HttpDescribeErrors Sebastien Jodogne <s.jodogne@gmail.com> parents: 1590 diff changeset	123 // is put in the HTTP answer. This feature can be disabled if the
d73124f6b439 configuration option HttpDescribeErrors Sebastien Jodogne <s.jodogne@gmail.com> parents: 1590 diff changeset	124 // HTTP client does not properly handles such answers.
d73124f6b439 configuration option HttpDescribeErrors Sebastien Jodogne <s.jodogne@gmail.com> parents: 1590 diff changeset	125 "HttpDescribeErrors" : true,
d73124f6b439 configuration option HttpDescribeErrors Sebastien Jodogne <s.jodogne@gmail.com> parents: 1590 diff changeset	126
d73124f6b439 configuration option HttpDescribeErrors Sebastien Jodogne <s.jodogne@gmail.com> parents: 1590 diff changeset	127 // Enable HTTP compression to improve network bandwidth utilization,
d73124f6b439 configuration option HttpDescribeErrors Sebastien Jodogne <s.jodogne@gmail.com> parents: 1590 diff changeset	128 // at the expense of more computations on the server. Orthanc
d73124f6b439 configuration option HttpDescribeErrors Sebastien Jodogne <s.jodogne@gmail.com> parents: 1590 diff changeset	129 // supports the "gzip" and "deflate" HTTP encodings.
5407 3206537cbb56 HttpCompression: now disabled by default + only compress known compressible content types Alain Mazy <am@osimis.io> parents: 5334 diff changeset	130 // When working on a LAN or on localhost, you should typically set
3206537cbb56 HttpCompression: now disabled by default + only compress known compressible content types Alain Mazy <am@osimis.io> parents: 5334 diff changeset	131 // this configuration to false while when working on low-bandwidth,
3206537cbb56 HttpCompression: now disabled by default + only compress known compressible content types Alain Mazy <am@osimis.io> parents: 5334 diff changeset	132 // you should set it to true.
3206537cbb56 HttpCompression: now disabled by default + only compress known compressible content types Alain Mazy <am@osimis.io> parents: 5334 diff changeset	133 // Note in versions up to 1.12.1, the default value was "true" and is
3206537cbb56 HttpCompression: now disabled by default + only compress known compressible content types Alain Mazy <am@osimis.io> parents: 5334 diff changeset	134 // "false" since 1.12.2.
3206537cbb56 HttpCompression: now disabled by default + only compress known compressible content types Alain Mazy <am@osimis.io> parents: 5334 diff changeset	135 "HttpCompressionEnabled" : false,
1592 d73124f6b439 configuration option HttpDescribeErrors Sebastien Jodogne <s.jodogne@gmail.com> parents: 1590 diff changeset	136
4243 64f57c9d5f79 configuration options for webdav Sebastien Jodogne <s.jodogne@gmail.com> parents: 4209 diff changeset	137 // Enable the publication of the content of the Orthanc server as a
64f57c9d5f79 configuration options for webdav Sebastien Jodogne <s.jodogne@gmail.com> parents: 4209 diff changeset	138 // WebDAV share (new in Orthanc 1.8.0). On the localhost, the WebDAV
64f57c9d5f79 configuration options for webdav Sebastien Jodogne <s.jodogne@gmail.com> parents: 4209 diff changeset	139 // share is mapped as "http://localhost:8042/webdav/".
64f57c9d5f79 configuration options for webdav Sebastien Jodogne <s.jodogne@gmail.com> parents: 4209 diff changeset	140 "WebDavEnabled" : true,
64f57c9d5f79 configuration options for webdav Sebastien Jodogne <s.jodogne@gmail.com> parents: 4209 diff changeset	141
64f57c9d5f79 configuration options for webdav Sebastien Jodogne <s.jodogne@gmail.com> parents: 4209 diff changeset	142 // Whether to allow deletions through the WebDAV share. This is
64f57c9d5f79 configuration options for webdav Sebastien Jodogne <s.jodogne@gmail.com> parents: 4209 diff changeset	143 // disabled by default to avoid accidental loss of DICOM instances.
64f57c9d5f79 configuration options for webdav Sebastien Jodogne <s.jodogne@gmail.com> parents: 4209 diff changeset	144 "WebDavDeleteAllowed" : false,
64f57c9d5f79 configuration options for webdav Sebastien Jodogne <s.jodogne@gmail.com> parents: 4209 diff changeset	145
64f57c9d5f79 configuration options for webdav Sebastien Jodogne <s.jodogne@gmail.com> parents: 4209 diff changeset	146 // Whether to allow uploads through the WebDAV share.
64f57c9d5f79 configuration options for webdav Sebastien Jodogne <s.jodogne@gmail.com> parents: 4209 diff changeset	147 "WebDavUploadAllowed" : true,
64f57c9d5f79 configuration options for webdav Sebastien Jodogne <s.jodogne@gmail.com> parents: 4209 diff changeset	148
683 7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	149
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	150
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	151 /**
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	152 * Configuration of the DICOM server
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	153 **/
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	154
1592 d73124f6b439 configuration option HttpDescribeErrors Sebastien Jodogne <s.jodogne@gmail.com> parents: 1590 diff changeset	155 // Enable the DICOM server. If this parameter is set to "false",
d73124f6b439 configuration option HttpDescribeErrors Sebastien Jodogne <s.jodogne@gmail.com> parents: 1590 diff changeset	156 // Orthanc acts as a pure REST server. It will not be possible to
d73124f6b439 configuration option HttpDescribeErrors Sebastien Jodogne <s.jodogne@gmail.com> parents: 1590 diff changeset	157 // receive files or to do query/retrieve through the DICOM protocol.
d73124f6b439 configuration option HttpDescribeErrors Sebastien Jodogne <s.jodogne@gmail.com> parents: 1590 diff changeset	158 "DicomServerEnabled" : true,
d73124f6b439 configuration option HttpDescribeErrors Sebastien Jodogne <s.jodogne@gmail.com> parents: 1590 diff changeset	159
3582 d00a803d1802 some additional info about AET in the default config file Sebastien Jodogne <s.jodogne@gmail.com> parents: 3561 diff changeset	160 // The DICOM Application Entity Title (cannot be longer than 16
d00a803d1802 some additional info about AET in the default config file Sebastien Jodogne <s.jodogne@gmail.com> parents: 3561 diff changeset	161 // characters)
683 7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	162 "DicomAet" : "ORTHANC",
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	163
2352 3ab96768d144 Fix issue 52 (DICOM level security association problems) Sebastien Jodogne <s.jodogne@gmail.com> parents: 2334 diff changeset	164 // Check whether the called AET corresponds to the AET of Orthanc
3ab96768d144 Fix issue 52 (DICOM level security association problems) Sebastien Jodogne <s.jodogne@gmail.com> parents: 2334 diff changeset	165 // during an incoming DICOM SCU request
683 7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	166 "DicomCheckCalledAet" : false,
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	167
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	168 // The DICOM port
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	169 "DicomPort" : 4242,
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	170
1115 da56a7916e8a Experimental "KeepAlive" configuration option to enable HTTP Keep-Alive Sebastien Jodogne <s.jodogne@gmail.com> parents: 1090 diff changeset	171 // The default encoding that is assumed for DICOM files without
2203 7d5320c59a05 doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 2184 diff changeset	172 // "SpecificCharacterSet" DICOM tag, and that is used when answering
4474 f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4465 diff changeset	173 // C-FIND requests (including worklists). The allowed values are
2207 6dc3bdb4088b Fix handling of encodings in C-FIND for worklists Sebastien Jodogne <s.jodogne@gmail.com> parents: 2203 diff changeset	174 // "Ascii", "Utf8", "Latin1", "Latin2", "Latin3", "Latin4",
6dc3bdb4088b Fix handling of encodings in C-FIND for worklists Sebastien Jodogne <s.jodogne@gmail.com> parents: 2203 diff changeset	175 // "Latin5", "Cyrillic", "Windows1251", "Arabic", "Greek", "Hebrew",
3226 45e1631febbb support of simplified chinese Sebastien Jodogne <s.jodogne@gmail.com> parents: 3218 diff changeset	176 // "Thai", "Japanese", "Chinese", "JapaneseKanji", "Korean", and
45e1631febbb support of simplified chinese Sebastien Jodogne <s.jodogne@gmail.com> parents: 3218 diff changeset	177 // "SimplifiedChinese".
1115 da56a7916e8a Experimental "KeepAlive" configuration option to enable HTTP Keep-Alive Sebastien Jodogne <s.jodogne@gmail.com> parents: 1090 diff changeset	178 "DefaultEncoding" : "Latin1",
da56a7916e8a Experimental "KeepAlive" configuration option to enable HTTP Keep-Alive Sebastien Jodogne <s.jodogne@gmail.com> parents: 1090 diff changeset	179
4474 f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4465 diff changeset	180 // The transfer syntaxes that are accepted by Orthanc C-STORE SCP.
f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4465 diff changeset	181 // This is an array listing the accepted transfer syntax UIDs. Each
f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4465 diff changeset	182 // entry can contain wildcards ("?" or "*"). By default, all the
f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4465 diff changeset	183 // known transfer syntaxes are accepted. (new in Orthanc 1.9.0)
f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4465 diff changeset	184 "AcceptedTransferSyntaxes" : [ "1.2.840.10008.1.*" ],
683 7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	185
4474 f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4465 diff changeset	186 // User-friendly groups of transfer syntaxes that can be enabled or
f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4465 diff changeset	187 // disabled at once. These options are applied after the main
f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4465 diff changeset	188 // "AcceptedTransferSyntaxes" option has been applied (if present).
f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4465 diff changeset	189 /**
f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4465 diff changeset	190 "DeflatedTransferSyntaxAccepted" : true,
f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4465 diff changeset	191 "JpegTransferSyntaxAccepted" : true,
f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4465 diff changeset	192 "Jpeg2000TransferSyntaxAccepted" : true,
f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4465 diff changeset	193 "JpegLosslessTransferSyntaxAccepted" : true,
f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4465 diff changeset	194 "JpipTransferSyntaxAccepted" : true,
f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4465 diff changeset	195 "Mpeg2TransferSyntaxAccepted" : true,
f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4465 diff changeset	196 "RleTransferSyntaxAccepted" : true,
f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4465 diff changeset	197 "Mpeg4TransferSyntaxAccepted" : true, // New in Orthanc 1.6.0
f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4465 diff changeset	198 "H265TransferSyntaxAccepted" : true, // New in Orthanc 1.9.0
f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4465 diff changeset	199 **/
f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4465 diff changeset	200
f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4465 diff changeset	201 // Whether Orthanc accepts to act as C-STORE SCP for unknown storage
1806 cd213ebcaefd UnknownSopClassAccepted option Sebastien Jodogne <s.jodogne@gmail.com> parents: 1772 diff changeset	202 // SOP classes (aka. "promiscuous mode")
4474 f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4465 diff changeset	203 "UnknownSopClassAccepted" : false,
1806 cd213ebcaefd UnknownSopClassAccepted option Sebastien Jodogne <s.jodogne@gmail.com> parents: 1772 diff changeset	204
2069 fabf7820d1f1 New configuration options: "DicomScuTimeout" and "DicomScpTimeout" + validation of non-negative options Sebastien Jodogne <s.jodogne@gmail.com> parents: 2039 diff changeset	205 // Set the timeout (in seconds) after which the DICOM associations
fabf7820d1f1 New configuration options: "DicomScuTimeout" and "DicomScpTimeout" + validation of non-negative options Sebastien Jodogne <s.jodogne@gmail.com> parents: 2039 diff changeset	206 // are closed by the Orthanc SCP (server) if no further DIMSE
fabf7820d1f1 New configuration options: "DicomScuTimeout" and "DicomScpTimeout" + validation of non-negative options Sebastien Jodogne <s.jodogne@gmail.com> parents: 2039 diff changeset	207 // command is received from the SCU (client).
fabf7820d1f1 New configuration options: "DicomScuTimeout" and "DicomScpTimeout" + validation of non-negative options Sebastien Jodogne <s.jodogne@gmail.com> parents: 2039 diff changeset	208 "DicomScpTimeout" : 30,
fabf7820d1f1 New configuration options: "DicomScuTimeout" and "DicomScpTimeout" + validation of non-negative options Sebastien Jodogne <s.jodogne@gmail.com> parents: 2039 diff changeset	209
683 7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	210
1592 d73124f6b439 configuration option HttpDescribeErrors Sebastien Jodogne <s.jodogne@gmail.com> parents: 1590 diff changeset	211
683 7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	212 /**
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	213 * Security-related options for the HTTP server
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	214 **/
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	215
3506 d2b9981017c4 better handling of HTTP security Sebastien Jodogne <s.jodogne@gmail.com> parents: 3500 diff changeset	216 // Whether remote hosts can connect to the HTTP server
683 7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	217 "RemoteAccessAllowed" : false,
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	218
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	219 // Whether or not SSL is enabled
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	220 "SslEnabled" : false,
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	221
4197 b1d528687e25 merge Sebastien Jodogne <s.jodogne@gmail.com> parents: 4190 diff changeset	222 // Path to the SSL certificate used by the HTTP server. The file
b1d528687e25 merge Sebastien Jodogne <s.jodogne@gmail.com> parents: 4190 diff changeset	223 // must be stored in the PEM format, and must contain both the
b1d528687e25 merge Sebastien Jodogne <s.jodogne@gmail.com> parents: 4190 diff changeset	224 // certificate and the private key. This option is only meaningful
b1d528687e25 merge Sebastien Jodogne <s.jodogne@gmail.com> parents: 4190 diff changeset	225 // if "SslEnabled" is true.
683 7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	226 "SslCertificate" : "certificate.pem",
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	227
4381 df313e410f0c Add support to configure minimimum accepted TLS version and cipher suite Andrew Wallis <andrew.wallis@varian.com>> parents: 4379 diff changeset	228 // Sets the minimum accepted SSL protocol version
4382 3aacd2bd8bbc review changeset 4381:df313e410f0c Sebastien Jodogne <s.jodogne@gmail.com> parents: 4381 diff changeset	229 // (cf. "ssl_protocol_version" option of civetweb). By default,
3aacd2bd8bbc review changeset 4381:df313e410f0c Sebastien Jodogne <s.jodogne@gmail.com> parents: 4381 diff changeset	230 // require SSL 1.2. This option is only meaningful if "SslEnabled"
3aacd2bd8bbc review changeset 4381:df313e410f0c Sebastien Jodogne <s.jodogne@gmail.com> parents: 4381 diff changeset	231 // is true. (new in Orthanc 1.8.2)
3aacd2bd8bbc review changeset 4381:df313e410f0c Sebastien Jodogne <s.jodogne@gmail.com> parents: 4381 diff changeset	232 //
3aacd2bd8bbc review changeset 4381:df313e410f0c Sebastien Jodogne <s.jodogne@gmail.com> parents: 4381 diff changeset	233 // Value => Protocols
3aacd2bd8bbc review changeset 4381:df313e410f0c Sebastien Jodogne <s.jodogne@gmail.com> parents: 4381 diff changeset	234 // 0 SSL2+SSL3+TLS1.0+TLS1.1+TLS1.2
3aacd2bd8bbc review changeset 4381:df313e410f0c Sebastien Jodogne <s.jodogne@gmail.com> parents: 4381 diff changeset	235 // 1 SSL3+TLS1.0+TLS1.1+TLS1.2
3aacd2bd8bbc review changeset 4381:df313e410f0c Sebastien Jodogne <s.jodogne@gmail.com> parents: 4381 diff changeset	236 // 2 TLS1.0+TLS1.1+TLS1.2
3aacd2bd8bbc review changeset 4381:df313e410f0c Sebastien Jodogne <s.jodogne@gmail.com> parents: 4381 diff changeset	237 // 3 TLS1.1+TLS1.2
3aacd2bd8bbc review changeset 4381:df313e410f0c Sebastien Jodogne <s.jodogne@gmail.com> parents: 4381 diff changeset	238 // 4 TLS1.2
3aacd2bd8bbc review changeset 4381:df313e410f0c Sebastien Jodogne <s.jodogne@gmail.com> parents: 4381 diff changeset	239 "SslMinimumProtocolVersion" : 4,
3aacd2bd8bbc review changeset 4381:df313e410f0c Sebastien Jodogne <s.jodogne@gmail.com> parents: 4381 diff changeset	240
3aacd2bd8bbc review changeset 4381:df313e410f0c Sebastien Jodogne <s.jodogne@gmail.com> parents: 4381 diff changeset	241 // Set the accepted ciphers for SSL connections. The ciphers must be
3aacd2bd8bbc review changeset 4381:df313e410f0c Sebastien Jodogne <s.jodogne@gmail.com> parents: 4381 diff changeset	242 // provided as a list of strings. If not set, this will default to
3aacd2bd8bbc review changeset 4381:df313e410f0c Sebastien Jodogne <s.jodogne@gmail.com> parents: 4381 diff changeset	243 // FIPS 140-2 ciphers. This option is only meaningful if
3aacd2bd8bbc review changeset 4381:df313e410f0c Sebastien Jodogne <s.jodogne@gmail.com> parents: 4381 diff changeset	244 // "SslEnabled" is true. (new in Orthanc 1.8.2)
4381 df313e410f0c Add support to configure minimimum accepted TLS version and cipher suite Andrew Wallis <andrew.wallis@varian.com>> parents: 4379 diff changeset	245 /**
4382 3aacd2bd8bbc review changeset 4381:df313e410f0c Sebastien Jodogne <s.jodogne@gmail.com> parents: 4381 diff changeset	246 "SslCiphersAccepted" : [ "AES128-GCM-SHA256" ],
4381 df313e410f0c Add support to configure minimimum accepted TLS version and cipher suite Andrew Wallis <andrew.wallis@varian.com>> parents: 4379 diff changeset	247 **/
df313e410f0c Add support to configure minimimum accepted TLS version and cipher suite Andrew Wallis <andrew.wallis@varian.com>> parents: 4379 diff changeset	248
4197 b1d528687e25 merge Sebastien Jodogne <s.jodogne@gmail.com> parents: 4190 diff changeset	249 // Whether or not peer client certificates shall be checked. This
4209 c3fc0b884442 typo Sebastien Jodogne <s.jodogne@gmail.com> parents: 4197 diff changeset	250 // option is only meaningful if "SslEnabled" is true.
4190 9ce5c89328f5 New configuration options to enable HTTP peers identification through certificates Alain Mazy <alain@mazy.be> parents: 4187 diff changeset	251 "SslVerifyPeers" : false,
9ce5c89328f5 New configuration options to enable HTTP peers identification through certificates Alain Mazy <alain@mazy.be> parents: 4187 diff changeset	252
4197 b1d528687e25 merge Sebastien Jodogne <s.jodogne@gmail.com> parents: 4190 diff changeset	253 // Path to a file containing the concatenation of the client SSL
5413 342b25e120d1 typo Alain Mazy <am@osimis.io> parents: 5407 diff changeset	254 // certificate(s) that are trusted to verify the identity of remote
5419 ac4e9fb87615 clarify doc for SslTrustedClientCertificates Alain Mazy <am@osimis.io> parents: 5413 diff changeset	255 // HTTP clients. The individual certificate(s) or root CAs must be
ac4e9fb87615 clarify doc for SslTrustedClientCertificates Alain Mazy <am@osimis.io> parents: 5413 diff changeset	256 // stored in the PEM format. This option is only meaningful
ac4e9fb87615 clarify doc for SslTrustedClientCertificates Alain Mazy <am@osimis.io> parents: 5413 diff changeset	257 // if "SslVerifyPeers" is true.
4190 9ce5c89328f5 New configuration options to enable HTTP peers identification through certificates Alain Mazy <alain@mazy.be> parents: 4187 diff changeset	258 "SslTrustedClientCertificates" : "trustedClientCertificates.pem",
9ce5c89328f5 New configuration options to enable HTTP peers identification through certificates Alain Mazy <alain@mazy.be> parents: 4187 diff changeset	259
3506 d2b9981017c4 better handling of HTTP security Sebastien Jodogne <s.jodogne@gmail.com> parents: 3500 diff changeset	260 // Whether or not the password protection is enabled (using HTTP
d2b9981017c4 better handling of HTTP security Sebastien Jodogne <s.jodogne@gmail.com> parents: 3500 diff changeset	261 // basic access authentication). Starting with Orthanc 1.5.8, if
d2b9981017c4 better handling of HTTP security Sebastien Jodogne <s.jodogne@gmail.com> parents: 3500 diff changeset	262 // "AuthenticationEnabled" is not explicitly set, authentication is
d2b9981017c4 better handling of HTTP security Sebastien Jodogne <s.jodogne@gmail.com> parents: 3500 diff changeset	263 // enabled iff. remote access is allowed (i.e. the default value of
d2b9981017c4 better handling of HTTP security Sebastien Jodogne <s.jodogne@gmail.com> parents: 3500 diff changeset	264 // "AuthenticationEnabled" equals that of "RemoteAccessAllowed").
d2b9981017c4 better handling of HTTP security Sebastien Jodogne <s.jodogne@gmail.com> parents: 3500 diff changeset	265 /**
d2b9981017c4 better handling of HTTP security Sebastien Jodogne <s.jodogne@gmail.com> parents: 3500 diff changeset	266 "AuthenticationEnabled" : false,
d2b9981017c4 better handling of HTTP security Sebastien Jodogne <s.jodogne@gmail.com> parents: 3500 diff changeset	267 **/
683 7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	268
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	269 // The list of the registered users. Because Orthanc uses HTTP
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	270 // Basic Authentication, the passwords are stored as plain text.
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	271 "RegisteredUsers" : {
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	272 // "alice" : "alicePassword"
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	273 },
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	274
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	275
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	276
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	277 /**
4438 4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU Sebastien Jodogne <s.jodogne@gmail.com> parents: 4424 diff changeset	278 * Security-related options for the DICOM connections (SCU/SCP)
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU Sebastien Jodogne <s.jodogne@gmail.com> parents: 4424 diff changeset	279 **/
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU Sebastien Jodogne <s.jodogne@gmail.com> parents: 4424 diff changeset	280
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU Sebastien Jodogne <s.jodogne@gmail.com> parents: 4424 diff changeset	281 // Whether DICOM TLS is enabled in the Orthanc SCP (new in Orthanc 1.9.0)
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU Sebastien Jodogne <s.jodogne@gmail.com> parents: 4424 diff changeset	282 "DicomTlsEnabled" : false,
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU Sebastien Jodogne <s.jodogne@gmail.com> parents: 4424 diff changeset	283
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU Sebastien Jodogne <s.jodogne@gmail.com> parents: 4424 diff changeset	284 // Path to the TLS certificate file (in PEM format) to be used for
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU Sebastien Jodogne <s.jodogne@gmail.com> parents: 4424 diff changeset	285 // both Orthanc SCP (incoming DICOM connections) and Orthanc SCU
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU Sebastien Jodogne <s.jodogne@gmail.com> parents: 4424 diff changeset	286 // (outgoing DICOM connections). Note that contrarily to the
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU Sebastien Jodogne <s.jodogne@gmail.com> parents: 4424 diff changeset	287 // "SslCertificate" option, the certificate and its private key must
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU Sebastien Jodogne <s.jodogne@gmail.com> parents: 4424 diff changeset	288 // be split into two separate files. (new in Orthanc 1.9.0)
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU Sebastien Jodogne <s.jodogne@gmail.com> parents: 4424 diff changeset	289 /**
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU Sebastien Jodogne <s.jodogne@gmail.com> parents: 4424 diff changeset	290 "DicomTlsCertificate" : "orthanc.crt",
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU Sebastien Jodogne <s.jodogne@gmail.com> parents: 4424 diff changeset	291 **/
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU Sebastien Jodogne <s.jodogne@gmail.com> parents: 4424 diff changeset	292
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU Sebastien Jodogne <s.jodogne@gmail.com> parents: 4424 diff changeset	293 // Path to the file containing the private key (in PEM format) that
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU Sebastien Jodogne <s.jodogne@gmail.com> parents: 4424 diff changeset	294 // corresponds to the TLS certificate specified in option
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU Sebastien Jodogne <s.jodogne@gmail.com> parents: 4424 diff changeset	295 // "DicomTlsCertificate". (new in Orthanc 1.9.0)
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU Sebastien Jodogne <s.jodogne@gmail.com> parents: 4424 diff changeset	296 /**
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU Sebastien Jodogne <s.jodogne@gmail.com> parents: 4424 diff changeset	297 "DicomTlsPrivateKey" : "orthanc.key",
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU Sebastien Jodogne <s.jodogne@gmail.com> parents: 4424 diff changeset	298 **/
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU Sebastien Jodogne <s.jodogne@gmail.com> parents: 4424 diff changeset	299
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU Sebastien Jodogne <s.jodogne@gmail.com> parents: 4424 diff changeset	300 // Path to a file containing all the TLS certificates that Orthanc
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU Sebastien Jodogne <s.jodogne@gmail.com> parents: 4424 diff changeset	301 // can trust, both for its SCP (incoming DICOM connections) and SCU
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU Sebastien Jodogne <s.jodogne@gmail.com> parents: 4424 diff changeset	302 // (outgoing DICOM connections). This file must contain a sequence
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU Sebastien Jodogne <s.jodogne@gmail.com> parents: 4424 diff changeset	303 // of PEM certificates. (new in Orthanc 1.9.0)
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU Sebastien Jodogne <s.jodogne@gmail.com> parents: 4424 diff changeset	304 /**
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU Sebastien Jodogne <s.jodogne@gmail.com> parents: 4424 diff changeset	305 "DicomTlsTrustedCertificates" : "trusted.crt",
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU Sebastien Jodogne <s.jodogne@gmail.com> parents: 4424 diff changeset	306 **/
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU Sebastien Jodogne <s.jodogne@gmail.com> parents: 4424 diff changeset	307
4656 82a314325351 New configuration option: "DicomTlsRemoteCertificateRequired" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4647 diff changeset	308 // Whether Orthanc rejects DICOM TLS connections to/from remote
82a314325351 New configuration option: "DicomTlsRemoteCertificateRequired" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4647 diff changeset	309 // modalities that do not provide a certificate. Setting this option
82a314325351 New configuration option: "DicomTlsRemoteCertificateRequired" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4647 diff changeset	310 // to "true" (resp. "false") corresponds to "--require-peer-cert"
82a314325351 New configuration option: "DicomTlsRemoteCertificateRequired" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4647 diff changeset	311 // (resp. "--verify-peer-cert") in the DCMTK command-line
82a314325351 New configuration option: "DicomTlsRemoteCertificateRequired" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4647 diff changeset	312 // tools. (new in Orthanc 1.9.3)
82a314325351 New configuration option: "DicomTlsRemoteCertificateRequired" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4647 diff changeset	313 "DicomTlsRemoteCertificateRequired" : true,
82a314325351 New configuration option: "DicomTlsRemoteCertificateRequired" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4647 diff changeset	314
4474 f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4465 diff changeset	315 // Whether the Orthanc SCP allows incoming C-ECHO requests, even
4438 4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU Sebastien Jodogne <s.jodogne@gmail.com> parents: 4424 diff changeset	316 // from SCU modalities it does not know about (i.e. that are not
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU Sebastien Jodogne <s.jodogne@gmail.com> parents: 4424 diff changeset	317 // listed in the "DicomModalities" option above). Orthanc 1.3.0
4482 8efeaba1b7f9 new configuration options: "DicomAlwaysAllowFind" and "DicomAlwaysAllowGet" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4480 diff changeset	318 // is the only version to behave as if this argument were set to "false".
4438 4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU Sebastien Jodogne <s.jodogne@gmail.com> parents: 4424 diff changeset	319 "DicomAlwaysAllowEcho" : true,
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU Sebastien Jodogne <s.jodogne@gmail.com> parents: 4424 diff changeset	320
4474 f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4465 diff changeset	321 // Whether the Orthanc SCP allows incoming C-STORE requests, even
4438 4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU Sebastien Jodogne <s.jodogne@gmail.com> parents: 4424 diff changeset	322 // from SCU modalities it does not know about (i.e. that are not
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU Sebastien Jodogne <s.jodogne@gmail.com> parents: 4424 diff changeset	323 // listed in the "DicomModalities" option above)
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU Sebastien Jodogne <s.jodogne@gmail.com> parents: 4424 diff changeset	324 "DicomAlwaysAllowStore" : true,
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU Sebastien Jodogne <s.jodogne@gmail.com> parents: 4424 diff changeset	325
4482 8efeaba1b7f9 new configuration options: "DicomAlwaysAllowFind" and "DicomAlwaysAllowGet" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4480 diff changeset	326 // Whether the Orthanc SCP allows incoming C-FIND requests, even
8efeaba1b7f9 new configuration options: "DicomAlwaysAllowFind" and "DicomAlwaysAllowGet" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4480 diff changeset	327 // from SCU modalities it does not know about (i.e. that are not
8efeaba1b7f9 new configuration options: "DicomAlwaysAllowFind" and "DicomAlwaysAllowGet" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4480 diff changeset	328 // listed in the "DicomModalities" option above). Setting this
8efeaba1b7f9 new configuration options: "DicomAlwaysAllowFind" and "DicomAlwaysAllowGet" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4480 diff changeset	329 // option to "true" implies security risks. (new in Orthanc 1.9.0)
4912 45d6ce72a84e fix linking of Sanitizer sample plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 4902 diff changeset	330 // Note: From Orthanc 1.10.0, this option only applies to C-FIND
45d6ce72a84e fix linking of Sanitizer sample plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 4902 diff changeset	331 // requests for patients/studies/series/instances. Use option
45d6ce72a84e fix linking of Sanitizer sample plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 4902 diff changeset	332 // "DicomAlwaysAllowFindWorklist" for worklists.
4482 8efeaba1b7f9 new configuration options: "DicomAlwaysAllowFind" and "DicomAlwaysAllowGet" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4480 diff changeset	333 "DicomAlwaysAllowFind" : false,
8efeaba1b7f9 new configuration options: "DicomAlwaysAllowFind" and "DicomAlwaysAllowGet" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4480 diff changeset	334
4888 8523078f3f4b added new configuration to authorize C-Find for worklist independently from other C-Find Alain Mazy <am@osimis.io> parents: 4857 diff changeset	335 // Whether the Orthanc SCP allows incoming C-FIND requests for worklists,
8523078f3f4b added new configuration to authorize C-Find for worklist independently from other C-Find Alain Mazy <am@osimis.io> parents: 4857 diff changeset	336 // even from SCU modalities it does not know about (i.e. that are not
8523078f3f4b added new configuration to authorize C-Find for worklist independently from other C-Find Alain Mazy <am@osimis.io> parents: 4857 diff changeset	337 // listed in the "DicomModalities" option above). Setting this
8523078f3f4b added new configuration to authorize C-Find for worklist independently from other C-Find Alain Mazy <am@osimis.io> parents: 4857 diff changeset	338 // option to "true" implies security risks. (new in Orthanc 1.10.0)
8523078f3f4b added new configuration to authorize C-Find for worklist independently from other C-Find Alain Mazy <am@osimis.io> parents: 4857 diff changeset	339 "DicomAlwaysAllowFindWorklist" : false,
8523078f3f4b added new configuration to authorize C-Find for worklist independently from other C-Find Alain Mazy <am@osimis.io> parents: 4857 diff changeset	340
4482 8efeaba1b7f9 new configuration options: "DicomAlwaysAllowFind" and "DicomAlwaysAllowGet" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4480 diff changeset	341 // Whether the Orthanc SCP allows incoming C-GET requests, even
8efeaba1b7f9 new configuration options: "DicomAlwaysAllowFind" and "DicomAlwaysAllowGet" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4480 diff changeset	342 // from SCU modalities it does not know about (i.e. that are not
8efeaba1b7f9 new configuration options: "DicomAlwaysAllowFind" and "DicomAlwaysAllowGet" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4480 diff changeset	343 // listed in the "DicomModalities" option above). Setting this
8efeaba1b7f9 new configuration options: "DicomAlwaysAllowFind" and "DicomAlwaysAllowGet" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4480 diff changeset	344 // option to "true" implies security risks. (new in Orthanc 1.9.0)
8efeaba1b7f9 new configuration options: "DicomAlwaysAllowFind" and "DicomAlwaysAllowGet" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4480 diff changeset	345 "DicomAlwaysAllowGet" : false,
8efeaba1b7f9 new configuration options: "DicomAlwaysAllowFind" and "DicomAlwaysAllowGet" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4480 diff changeset	346
4774 ec6843501db7 doc Alain Mazy <am@osimis.io> parents: 4753 diff changeset	347 // Whether the Orthanc SCP allows incoming C-MOVE requests, even
ec6843501db7 doc Alain Mazy <am@osimis.io> parents: 4753 diff changeset	348 // from SCU modalities it does not know about (i.e. that are not
ec6843501db7 doc Alain Mazy <am@osimis.io> parents: 4753 diff changeset	349 // listed in the "DicomModalities" option above). Setting this
ec6843501db7 doc Alain Mazy <am@osimis.io> parents: 4753 diff changeset	350 // option to "true" implies security risks. (new in Orthanc 1.9.7)
ec6843501db7 doc Alain Mazy <am@osimis.io> parents: 4753 diff changeset	351 "DicomAlwaysAllowMove" : false,
ec6843501db7 doc Alain Mazy <am@osimis.io> parents: 4753 diff changeset	352
4438 4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU Sebastien Jodogne <s.jodogne@gmail.com> parents: 4424 diff changeset	353 // Whether Orthanc checks the IP/hostname address of the remote
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU Sebastien Jodogne <s.jodogne@gmail.com> parents: 4424 diff changeset	354 // modality initiating a DICOM connection (as listed in the
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU Sebastien Jodogne <s.jodogne@gmail.com> parents: 4424 diff changeset	355 // "DicomModalities" option above). If this option is set to
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU Sebastien Jodogne <s.jodogne@gmail.com> parents: 4424 diff changeset	356 // "false", Orthanc only checks the AET of the remote modality.
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU Sebastien Jodogne <s.jodogne@gmail.com> parents: 4424 diff changeset	357 "DicomCheckModalityHost" : false,
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU Sebastien Jodogne <s.jodogne@gmail.com> parents: 4424 diff changeset	358
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU Sebastien Jodogne <s.jodogne@gmail.com> parents: 4424 diff changeset	359
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU Sebastien Jodogne <s.jodogne@gmail.com> parents: 4424 diff changeset	360
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU Sebastien Jodogne <s.jodogne@gmail.com> parents: 4424 diff changeset	361 /**
683 7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	362 * Network topology
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	363 **/
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	364
4316 7dc52763ab1c explanation in configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4315 diff changeset	365 // The list of the known DICOM modalities. This option is ignored if
7dc52763ab1c explanation in configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4315 diff changeset	366 // "DicomModalitiesInDatabase" is set to "true", in which case you
7dc52763ab1c explanation in configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4315 diff changeset	367 // must use the REST API to define modalities.
683 7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	368 "DicomModalities" : {
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	369 /**
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	370 * Uncommenting the following line would enable Orthanc to
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	371 * connect to an instance of the "storescp" open-source DICOM
3582 d00a803d1802 some additional info about AET in the default config file Sebastien Jodogne <s.jodogne@gmail.com> parents: 3561 diff changeset	372 * store (shipped in the DCMTK distribution), as started by the
d00a803d1802 some additional info about AET in the default config file Sebastien Jodogne <s.jodogne@gmail.com> parents: 3561 diff changeset	373 * command line "storescp 2000". The first parameter is the
d00a803d1802 some additional info about AET in the default config file Sebastien Jodogne <s.jodogne@gmail.com> parents: 3561 diff changeset	374 * AET of the remote modality (cannot be longer than 16
d00a803d1802 some additional info about AET in the default config file Sebastien Jodogne <s.jodogne@gmail.com> parents: 3561 diff changeset	375 * characters), the second one is the remote network address,
d00a803d1802 some additional info about AET in the default config file Sebastien Jodogne <s.jodogne@gmail.com> parents: 3561 diff changeset	376 * and the third one is the TCP port number corresponding
d00a803d1802 some additional info about AET in the default config file Sebastien Jodogne <s.jodogne@gmail.com> parents: 3561 diff changeset	377 * to the DICOM protocol on the remote modality (usually 104).
683 7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	378 **/
2032 65b1ce7cb84f Replaced "localhost" by "127.0.0.1", as it might impact performance on Windows Sebastien Jodogne <s.jodogne@gmail.com> parents: 2030 diff changeset	379 // "sample" : [ "STORESCP", "127.0.0.1", 2000 ]
683 7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	380
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	381 /**
2352 3ab96768d144 Fix issue 52 (DICOM level security association problems) Sebastien Jodogne <s.jodogne@gmail.com> parents: 2334 diff changeset	382 * A fourth parameter is available to enable patches for
3ab96768d144 Fix issue 52 (DICOM level security association problems) Sebastien Jodogne <s.jodogne@gmail.com> parents: 2334 diff changeset	383 * specific PACS manufacturers. The allowed values are currently:
3ab96768d144 Fix issue 52 (DICOM level security association problems) Sebastien Jodogne <s.jodogne@gmail.com> parents: 2334 diff changeset	384 * - "Generic" (default value),
3ab96768d144 Fix issue 52 (DICOM level security association problems) Sebastien Jodogne <s.jodogne@gmail.com> parents: 2334 diff changeset	385 * - "GenericNoWildcardInDates" (to replace "*" by "" in date fields
4474 f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4465 diff changeset	386 * in outgoing C-FIND requests originating from Orthanc),
2352 3ab96768d144 Fix issue 52 (DICOM level security association problems) Sebastien Jodogne <s.jodogne@gmail.com> parents: 2334 diff changeset	387 * - "GenericNoUniversalWildcard" (to replace "*" by "" in all fields
4474 f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4465 diff changeset	388 * in outgoing C-FIND SCU requests originating from Orthanc),
2888 61a5667f37d9 New modality manufacturer: "GE" for GE Healthcare EA and AW Sebastien Jodogne <s.jodogne@gmail.com> parents: 2872 diff changeset	389 * - "Vitrea",
61a5667f37d9 New modality manufacturer: "GE" for GE Healthcare EA and AW Sebastien Jodogne <s.jodogne@gmail.com> parents: 2872 diff changeset	390 * - "GE" (Enterprise Archive, MRI consoles and Advantage Workstation
61a5667f37d9 New modality manufacturer: "GE" for GE Healthcare EA and AW Sebastien Jodogne <s.jodogne@gmail.com> parents: 2872 diff changeset	391 * from GE Healthcare).
61a5667f37d9 New modality manufacturer: "GE" for GE Healthcare EA and AW Sebastien Jodogne <s.jodogne@gmail.com> parents: 2872 diff changeset	392 *
2318 e5fc5db6a84b removed EFilm2 from sample configuration file amazy parents: 2229 diff changeset	393 * This parameter is case-sensitive.
683 7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	394 **/
3561 bdafff1ce443 C-Find SCU at Instance level now sets the 0008,0052 tag to IMAGE per default (was INSTANCE). Source: https://groups.google.com/forum/?utm_medium=email&utm_source=footer#!msg/orthanc-users/FYxHXzlaQ0M/rn6d0SowAAAJ Alain Mazy <alain@mazy.be> parents: 3537 diff changeset	395 // "vitrea" : [ "VITREA", "192.168.1.1", 104, "Vitrea" ]
2872 9d08edde614b Possibility to restrict the allowed DICOM commands for each modality Sebastien Jodogne <s.jodogne@gmail.com> parents: 2825 diff changeset	396
9d08edde614b Possibility to restrict the allowed DICOM commands for each modality Sebastien Jodogne <s.jodogne@gmail.com> parents: 2825 diff changeset	397 /**
3273 45786a7c3735 typo Sebastien Jodogne <s.jodogne@gmail.com> parents: 3226 diff changeset	398 * By default, the Orthanc SCP accepts all DICOM commands (C-ECHO,
3818 4f78da5613a1 Add C-GET SCP support Stacy Loesch <stacy.loesch@varian.com> parents: 3736 diff changeset	399 * C-STORE, C-FIND, C-MOVE, C-GET and storage commitment) issued by the
3613 c1e2b91c2ab4 all the abstractions for storage commitment are available Sebastien Jodogne <s.jodogne@gmail.com> parents: 3602 diff changeset	400 * registered remote SCU modalities. Starting with Orthanc 1.5.0,
c1e2b91c2ab4 all the abstractions for storage commitment are available Sebastien Jodogne <s.jodogne@gmail.com> parents: 3602 diff changeset	401 * it is possible to specify which DICOM commands are allowed,
c1e2b91c2ab4 all the abstractions for storage commitment are available Sebastien Jodogne <s.jodogne@gmail.com> parents: 3602 diff changeset	402 * separately for each remote modality, using the syntax
3894 8f7ad4989fec transcoding to uncompressed transfer syntaxes over DICOM protocol is implemented Sebastien Jodogne <s.jodogne@gmail.com> parents: 3852 diff changeset	403 * below.
8f7ad4989fec transcoding to uncompressed transfer syntaxes over DICOM protocol is implemented Sebastien Jodogne <s.jodogne@gmail.com> parents: 3852 diff changeset	404 *
8f7ad4989fec transcoding to uncompressed transfer syntaxes over DICOM protocol is implemented Sebastien Jodogne <s.jodogne@gmail.com> parents: 3852 diff changeset	405 * The "AllowEcho" (resp. "AllowStore") option only has an effect
8f7ad4989fec transcoding to uncompressed transfer syntaxes over DICOM protocol is implemented Sebastien Jodogne <s.jodogne@gmail.com> parents: 3852 diff changeset	406 * respectively if global option "DicomAlwaysAllowEcho"
8f7ad4989fec transcoding to uncompressed transfer syntaxes over DICOM protocol is implemented Sebastien Jodogne <s.jodogne@gmail.com> parents: 3852 diff changeset	407 * (resp. "DicomAlwaysAllowStore") is set to "false".
8f7ad4989fec transcoding to uncompressed transfer syntaxes over DICOM protocol is implemented Sebastien Jodogne <s.jodogne@gmail.com> parents: 3852 diff changeset	408 *
8f7ad4989fec transcoding to uncompressed transfer syntaxes over DICOM protocol is implemented Sebastien Jodogne <s.jodogne@gmail.com> parents: 3852 diff changeset	409 * Starting with Orthanc 1.7.0, "AllowTranscoding" can be used to
8f7ad4989fec transcoding to uncompressed transfer syntaxes over DICOM protocol is implemented Sebastien Jodogne <s.jodogne@gmail.com> parents: 3852 diff changeset	410 * disable the transcoding to uncompressed transfer syntaxes if
4480 d0581d0b22b8 Clarifying documentation of "AllowTranscoding" in "DicomModalities" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4474 diff changeset	411 * this remote modality doesn't support compressed transfer
d0581d0b22b8 Clarifying documentation of "AllowTranscoding" in "DicomModalities" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4474 diff changeset	412 * syntaxes. This option currently applies to Orthanc C-GET SCP
d0581d0b22b8 Clarifying documentation of "AllowTranscoding" in "DicomModalities" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4474 diff changeset	413 * and to Orthanc C-STORE SCU. This option only has an effect if
d0581d0b22b8 Clarifying documentation of "AllowTranscoding" in "DicomModalities" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4474 diff changeset	414 * the global option "EnableTranscoding" is set to "true".
4175 8f0de3998a59 fix doc Alain Mazy <alain@mazy.be> parents: 4044 diff changeset	415 *
8f0de3998a59 fix doc Alain Mazy <alain@mazy.be> parents: 4044 diff changeset	416 * By default, all "Allow*" options are true.
4178 3576616904d3 sample config: storage commitment Alain Mazy <alain@mazy.be> parents: 4177 diff changeset	417 * "AllowStorageCommitment" is actually an alias for
3576616904d3 sample config: storage commitment Alain Mazy <alain@mazy.be> parents: 4177 diff changeset	418 * "AllowNAction" & "AllowEventReport".
4438 4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU Sebastien Jodogne <s.jodogne@gmail.com> parents: 4424 diff changeset	419 *
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU Sebastien Jodogne <s.jodogne@gmail.com> parents: 4424 diff changeset	420 * The "UseDicomTls" option specifies whether DICOM TLS should be
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU Sebastien Jodogne <s.jodogne@gmail.com> parents: 4424 diff changeset	421 * used when opening a SCU connection from Orthanc to this remote
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU Sebastien Jodogne <s.jodogne@gmail.com> parents: 4424 diff changeset	422 * modality. By default, DICOM TLS is not enabled.
4463 522e13a60cfc "LocalAet" in "DicomModalities" to overwrite global "DicomAet" for SCU on a per-modality basis Sebastien Jodogne <s.jodogne@gmail.com> parents: 4451 diff changeset	423 *
4518 cb8fcecf1b02 new option "Timeout" in "DicomModalities" to set DICOM SCU timeout on a per-modality basis Sebastien Jodogne <s.jodogne@gmail.com> parents: 4482 diff changeset	424 * The "LocalAet" option allows one to overwrite the global
cb8fcecf1b02 new option "Timeout" in "DicomModalities" to set DICOM SCU timeout on a per-modality basis Sebastien Jodogne <s.jodogne@gmail.com> parents: 4482 diff changeset	425 * "DicomAet" configuration option in order to specify another AET
cb8fcecf1b02 new option "Timeout" in "DicomModalities" to set DICOM SCU timeout on a per-modality basis Sebastien Jodogne <s.jodogne@gmail.com> parents: 4482 diff changeset	426 * for Orthanc when initiating an SCU to this very specific
cb8fcecf1b02 new option "Timeout" in "DicomModalities" to set DICOM SCU timeout on a per-modality basis Sebastien Jodogne <s.jodogne@gmail.com> parents: 4482 diff changeset	427 * modality. Similarly, "Timeout" allows one to overwrite the
cb8fcecf1b02 new option "Timeout" in "DicomModalities" to set DICOM SCU timeout on a per-modality basis Sebastien Jodogne <s.jodogne@gmail.com> parents: 4482 diff changeset	428 * global value "DicomScuTimeout" on a per-modality basis.
2872 9d08edde614b Possibility to restrict the allowed DICOM commands for each modality Sebastien Jodogne <s.jodogne@gmail.com> parents: 2825 diff changeset	429 **/
9d08edde614b Possibility to restrict the allowed DICOM commands for each modality Sebastien Jodogne <s.jodogne@gmail.com> parents: 2825 diff changeset	430 //"untrusted" : {
9d08edde614b Possibility to restrict the allowed DICOM commands for each modality Sebastien Jodogne <s.jodogne@gmail.com> parents: 2825 diff changeset	431 // "AET" : "ORTHANC",
9d08edde614b Possibility to restrict the allowed DICOM commands for each modality Sebastien Jodogne <s.jodogne@gmail.com> parents: 2825 diff changeset	432 // "Port" : 104,
9d08edde614b Possibility to restrict the allowed DICOM commands for each modality Sebastien Jodogne <s.jodogne@gmail.com> parents: 2825 diff changeset	433 // "Host" : "127.0.0.1",
3716 ae0e3fd609df sample for "Manufacturer" option in "DicomModalities" config Sebastien Jodogne <s.jodogne@gmail.com> parents: 3709 diff changeset	434 // "Manufacturer" : "Generic",
2872 9d08edde614b Possibility to restrict the allowed DICOM commands for each modality Sebastien Jodogne <s.jodogne@gmail.com> parents: 2825 diff changeset	435 // "AllowEcho" : false,
9d08edde614b Possibility to restrict the allowed DICOM commands for each modality Sebastien Jodogne <s.jodogne@gmail.com> parents: 2825 diff changeset	436 // "AllowFind" : false,
4888 8523078f3f4b added new configuration to authorize C-Find for worklist independently from other C-Find Alain Mazy <am@osimis.io> parents: 4857 diff changeset	437 // "AllowFindWorklist" : false, // new in 1.10.0
3818 4f78da5613a1 Add C-GET SCP support Stacy Loesch <stacy.loesch@varian.com> parents: 3736 diff changeset	438 // "AllowGet" : false,
2872 9d08edde614b Possibility to restrict the allowed DICOM commands for each modality Sebastien Jodogne <s.jodogne@gmail.com> parents: 2825 diff changeset	439 // "AllowMove" : false,
3602 085283445db0 AllowNAction in remote modality parameters Sebastien Jodogne <s.jodogne@gmail.com> parents: 3582 diff changeset	440 // "AllowStore" : true,
3894 8f7ad4989fec transcoding to uncompressed transfer syntaxes over DICOM protocol is implemented Sebastien Jodogne <s.jodogne@gmail.com> parents: 3852 diff changeset	441 // "AllowStorageCommitment" : false, // new in 1.6.0
4438 4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU Sebastien Jodogne <s.jodogne@gmail.com> parents: 4424 diff changeset	442 // "AllowTranscoding" : true, // new in 1.7.0
5255 f783b99e4738 fix Sebastien Jodogne <s.jodogne@gmail.com> parents: 5201 diff changeset	443 // "UseDicomTls" : false, // new in 1.9.0
f783b99e4738 fix Sebastien Jodogne <s.jodogne@gmail.com> parents: 5201 diff changeset	444 // "LocalAet" : "HELLO", // new in 1.9.0
4518 cb8fcecf1b02 new option "Timeout" in "DicomModalities" to set DICOM SCU timeout on a per-modality basis Sebastien Jodogne <s.jodogne@gmail.com> parents: 4482 diff changeset	445 // "Timeout" : 60 // new in 1.9.1
2872 9d08edde614b Possibility to restrict the allowed DICOM commands for each modality Sebastien Jodogne <s.jodogne@gmail.com> parents: 2825 diff changeset	446 //}
683 7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	447 },
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	448
2946 2e751f615e03 new configuration options: DicomModalitiesInDatabase and OrthancPeersInDatabase Sebastien Jodogne <s.jodogne@gmail.com> parents: 2932 diff changeset	449 // Whether to store the DICOM modalities in the Orthanc database
2988 9cc3d40e389b Orthanc 1.4.3 is now known as 1.5.0 Sebastien Jodogne <s.jodogne@gmail.com> parents: 2965 diff changeset	450 // instead of in this configuration file (new in Orthanc 1.5.0)
2946 2e751f615e03 new configuration options: DicomModalitiesInDatabase and OrthancPeersInDatabase Sebastien Jodogne <s.jodogne@gmail.com> parents: 2932 diff changeset	451 "DicomModalitiesInDatabase" : false,
2e751f615e03 new configuration options: DicomModalitiesInDatabase and OrthancPeersInDatabase Sebastien Jodogne <s.jodogne@gmail.com> parents: 2932 diff changeset	452
4411 1d93700f5e23 typo Sebastien Jodogne <s.jodogne@gmail.com> parents: 4389 diff changeset	453 // Whether the C-ECHO SCU is automatically followed by a C-FIND SCU,
4340 6fa8bb987be2 "DicomEchoChecksFind" config option + "CheckFind" field in /modalities/.../echo Sebastien Jodogne <s.jodogne@gmail.com> parents: 4316 diff changeset	454 // while testing the connectivity from Orthanc to a remote DICOM
4389 ab5b68f7e948 typo Sebastien Jodogne <s.jodogne@gmail.com> parents: 4384 diff changeset	455 // modality. This allows one to check that the remote modality does
4340 6fa8bb987be2 "DicomEchoChecksFind" config option + "CheckFind" field in /modalities/.../echo Sebastien Jodogne <s.jodogne@gmail.com> parents: 4316 diff changeset	456 // accept C-FIND requests from Orthanc (new in Orthanc 1.8.1).
6fa8bb987be2 "DicomEchoChecksFind" config option + "CheckFind" field in /modalities/.../echo Sebastien Jodogne <s.jodogne@gmail.com> parents: 4316 diff changeset	457 "DicomEchoChecksFind" : false,
6fa8bb987be2 "DicomEchoChecksFind" config option + "CheckFind" field in /modalities/.../echo Sebastien Jodogne <s.jodogne@gmail.com> parents: 4316 diff changeset	458
2069 fabf7820d1f1 New configuration options: "DicomScuTimeout" and "DicomScpTimeout" + validation of non-negative options Sebastien Jodogne <s.jodogne@gmail.com> parents: 2039 diff changeset	459 // The timeout (in seconds) after which the DICOM associations are
fabf7820d1f1 New configuration options: "DicomScuTimeout" and "DicomScpTimeout" + validation of non-negative options Sebastien Jodogne <s.jodogne@gmail.com> parents: 2039 diff changeset	460 // considered as closed by the Orthanc SCU (client) if the remote
fabf7820d1f1 New configuration options: "DicomScuTimeout" and "DicomScpTimeout" + validation of non-negative options Sebastien Jodogne <s.jodogne@gmail.com> parents: 2039 diff changeset	461 // DICOM SCP (server) does not answer.
fabf7820d1f1 New configuration options: "DicomScuTimeout" and "DicomScpTimeout" + validation of non-negative options Sebastien Jodogne <s.jodogne@gmail.com> parents: 2039 diff changeset	462 "DicomScuTimeout" : 10,
fabf7820d1f1 New configuration options: "DicomScuTimeout" and "DicomScpTimeout" + validation of non-negative options Sebastien Jodogne <s.jodogne@gmail.com> parents: 2039 diff changeset	463
4465 fe774d8e904b New configuration option: "DicomScuPreferredTransferSyntax" to control transcoding in C-STORE SCU Sebastien Jodogne <s.jodogne@gmail.com> parents: 4463 diff changeset	464 // During a C-STORE SCU request initiated by Orthanc, if the remote
fe774d8e904b New configuration option: "DicomScuPreferredTransferSyntax" to control transcoding in C-STORE SCU Sebastien Jodogne <s.jodogne@gmail.com> parents: 4463 diff changeset	465 // modality doesn't support the original transfer syntax of some
fe774d8e904b New configuration option: "DicomScuPreferredTransferSyntax" to control transcoding in C-STORE SCU Sebastien Jodogne <s.jodogne@gmail.com> parents: 4463 diff changeset	466 // DICOM instance, specify which transfer syntax should be preferred
fe774d8e904b New configuration option: "DicomScuPreferredTransferSyntax" to control transcoding in C-STORE SCU Sebastien Jodogne <s.jodogne@gmail.com> parents: 4463 diff changeset	467 // to transcode this instance (provided the remote modality accepts
fe774d8e904b New configuration option: "DicomScuPreferredTransferSyntax" to control transcoding in C-STORE SCU Sebastien Jodogne <s.jodogne@gmail.com> parents: 4463 diff changeset	468 // this syntax). In Orthanc between 1.7.0 and 1.8.2, this parameter
fe774d8e904b New configuration option: "DicomScuPreferredTransferSyntax" to control transcoding in C-STORE SCU Sebastien Jodogne <s.jodogne@gmail.com> parents: 4463 diff changeset	469 // was implicitly set to "Little Endian Implicit"
fe774d8e904b New configuration option: "DicomScuPreferredTransferSyntax" to control transcoding in C-STORE SCU Sebastien Jodogne <s.jodogne@gmail.com> parents: 4463 diff changeset	470 // (1.2.840.10008.1.2). In Orthanc <= 1.6.1 and in Orthanc >= 1.9.0,
fe774d8e904b New configuration option: "DicomScuPreferredTransferSyntax" to control transcoding in C-STORE SCU Sebastien Jodogne <s.jodogne@gmail.com> parents: 4463 diff changeset	471 // this parameter is by default set to "Little Endian Explicit"
fe774d8e904b New configuration option: "DicomScuPreferredTransferSyntax" to control transcoding in C-STORE SCU Sebastien Jodogne <s.jodogne@gmail.com> parents: 4463 diff changeset	472 // (1.2.840.10008.1.2.1). This parameter can possibly correspond to
fe774d8e904b New configuration option: "DicomScuPreferredTransferSyntax" to control transcoding in C-STORE SCU Sebastien Jodogne <s.jodogne@gmail.com> parents: 4463 diff changeset	473 // a compressed transfer syntax. (new in Orthanc 1.9.0)
fe774d8e904b New configuration option: "DicomScuPreferredTransferSyntax" to control transcoding in C-STORE SCU Sebastien Jodogne <s.jodogne@gmail.com> parents: 4463 diff changeset	474 "DicomScuPreferredTransferSyntax" : "1.2.840.10008.1.2.1",
4793 fc2ba1ce6538 new configuration 'DicomThreadsCount' Alain Mazy <am@osimis.io> parents: 4774 diff changeset	475
fc2ba1ce6538 new configuration 'DicomThreadsCount' Alain Mazy <am@osimis.io> parents: 4774 diff changeset	476 // Number of threads that are used by the embedded DICOM server.
fc2ba1ce6538 new configuration 'DicomThreadsCount' Alain Mazy <am@osimis.io> parents: 4774 diff changeset	477 // This defines the number of concurrent DICOM operations that can
4912 45d6ce72a84e fix linking of Sanitizer sample plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 4902 diff changeset	478 // be run. Note: This is not limiting the number of concurrent
45d6ce72a84e fix linking of Sanitizer sample plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 4902 diff changeset	479 // connections. With a single thread, if a C-Find is received during
45d6ce72a84e fix linking of Sanitizer sample plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 4902 diff changeset	480 // e.g the transcoding of an incoming C-Store, it will have to wait
45d6ce72a84e fix linking of Sanitizer sample plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 4902 diff changeset	481 // until the end of the C-Store before being processed. (new in
45d6ce72a84e fix linking of Sanitizer sample plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 4902 diff changeset	482 // Orthanc 1.10.0, before this version, the value was fixed to 4)
4793 fc2ba1ce6538 new configuration 'DicomThreadsCount' Alain Mazy <am@osimis.io> parents: 4774 diff changeset	483 "DicomThreadsCount" : 4,
fc2ba1ce6538 new configuration 'DicomThreadsCount' Alain Mazy <am@osimis.io> parents: 4774 diff changeset	484
4316 7dc52763ab1c explanation in configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4315 diff changeset	485 // The list of the known Orthanc peers. This option is ignored if
7dc52763ab1c explanation in configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4315 diff changeset	486 // "OrthancPeersInDatabase" is set to "true", in which case you must
7dc52763ab1c explanation in configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4315 diff changeset	487 // use the REST API to define Orthanc peers.
683 7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	488 "OrthancPeers" : {
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	489 /**
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	490 * Each line gives the base URL of an Orthanc peer, possibly
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	491 * followed by the username/password pair (if the password
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	492 * protection is enabled on the peer).
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	493 **/
2032 65b1ce7cb84f Replaced "localhost" by "127.0.0.1", as it might impact performance on Windows Sebastien Jodogne <s.jodogne@gmail.com> parents: 2030 diff changeset	494 // "peer" : [ "http://127.0.0.1:8043/", "alice", "alicePassword" ]
65b1ce7cb84f Replaced "localhost" by "127.0.0.1", as it might impact performance on Windows Sebastien Jodogne <s.jodogne@gmail.com> parents: 2030 diff changeset	495 // "peer2" : [ "http://127.0.0.1:8044/" ]
2019 9c9332e486ca HTTPS client certificates can be associated with Orthanc peers to enhance security over Internet Sebastien Jodogne <s.jodogne@gmail.com> parents: 1973 diff changeset	496
9c9332e486ca HTTPS client certificates can be associated with Orthanc peers to enhance security over Internet Sebastien Jodogne <s.jodogne@gmail.com> parents: 1973 diff changeset	497 /**
9c9332e486ca HTTPS client certificates can be associated with Orthanc peers to enhance security over Internet Sebastien Jodogne <s.jodogne@gmail.com> parents: 1973 diff changeset	498 * This is another, more advanced format to define Orthanc
3973 d86bddb50972 fix spelling errors according to debian Sebastien Jodogne <s.jodogne@gmail.com> parents: 3958 diff changeset	499 * peers. It notably allows one to specify HTTP headers, a HTTPS
2800 dc7330089736 "OrthancPeers" configuration option now allows to specify HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 2788 diff changeset	500 * client certificate in the PEM format (as in the "--cert" option
dc7330089736 "OrthancPeers" configuration option now allows to specify HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 2788 diff changeset	501 * of curl), or to enable PKCS#11 authentication for smart cards.
4522 017ab543e6ef added field "Timeout" in "OrthancPeers" configuration option Sebastien Jodogne <s.jodogne@gmail.com> parents: 4518 diff changeset	502 *
017ab543e6ef added field "Timeout" in "OrthancPeers" configuration option Sebastien Jodogne <s.jodogne@gmail.com> parents: 4518 diff changeset	503 * The "Timeout" option allows one to overwrite the global value
017ab543e6ef added field "Timeout" in "OrthancPeers" configuration option Sebastien Jodogne <s.jodogne@gmail.com> parents: 4518 diff changeset	504 * "HttpTimeout" on a per-peer basis.
2019 9c9332e486ca HTTPS client certificates can be associated with Orthanc peers to enhance security over Internet Sebastien Jodogne <s.jodogne@gmail.com> parents: 1973 diff changeset	505 **/
9c9332e486ca HTTPS client certificates can be associated with Orthanc peers to enhance security over Internet Sebastien Jodogne <s.jodogne@gmail.com> parents: 1973 diff changeset	506 // "peer" : {
2032 65b1ce7cb84f Replaced "localhost" by "127.0.0.1", as it might impact performance on Windows Sebastien Jodogne <s.jodogne@gmail.com> parents: 2030 diff changeset	507 // "Url" : "http://127.0.0.1:8043/",
2019 9c9332e486ca HTTPS client certificates can be associated with Orthanc peers to enhance security over Internet Sebastien Jodogne <s.jodogne@gmail.com> parents: 1973 diff changeset	508 // "Username" : "alice",
9c9332e486ca HTTPS client certificates can be associated with Orthanc peers to enhance security over Internet Sebastien Jodogne <s.jodogne@gmail.com> parents: 1973 diff changeset	509 // "Password" : "alicePassword",
2800 dc7330089736 "OrthancPeers" configuration option now allows to specify HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 2788 diff changeset	510 // "HttpHeaders" : { "Token" : "Hello world" },
2019 9c9332e486ca HTTPS client certificates can be associated with Orthanc peers to enhance security over Internet Sebastien Jodogne <s.jodogne@gmail.com> parents: 1973 diff changeset	511 // "CertificateFile" : "client.crt",
9c9332e486ca HTTPS client certificates can be associated with Orthanc peers to enhance security over Internet Sebastien Jodogne <s.jodogne@gmail.com> parents: 1973 diff changeset	512 // "CertificateKeyFile" : "client.key",
2022 fefbe71c2272 Possibility to use PKCS#11 authentication for hardware security modules with Orthanc peers Sebastien Jodogne <s.jodogne@gmail.com> parents: 2019 diff changeset	513 // "CertificateKeyPassword" : "certpass",
4522 017ab543e6ef added field "Timeout" in "OrthancPeers" configuration option Sebastien Jodogne <s.jodogne@gmail.com> parents: 4518 diff changeset	514 // "Pkcs11" : false,
017ab543e6ef added field "Timeout" in "OrthancPeers" configuration option Sebastien Jodogne <s.jodogne@gmail.com> parents: 4518 diff changeset	515 // "Timeout" : 42 // New in Orthanc 1.9.1
2019 9c9332e486ca HTTPS client certificates can be associated with Orthanc peers to enhance security over Internet Sebastien Jodogne <s.jodogne@gmail.com> parents: 1973 diff changeset	516 // }
683 7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	517 },
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	518
2946 2e751f615e03 new configuration options: DicomModalitiesInDatabase and OrthancPeersInDatabase Sebastien Jodogne <s.jodogne@gmail.com> parents: 2932 diff changeset	519 // Whether to store the Orthanc peers in the Orthanc database
2988 9cc3d40e389b Orthanc 1.4.3 is now known as 1.5.0 Sebastien Jodogne <s.jodogne@gmail.com> parents: 2965 diff changeset	520 // instead of in this configuration file (new in Orthanc 1.5.0)
2946 2e751f615e03 new configuration options: DicomModalitiesInDatabase and OrthancPeersInDatabase Sebastien Jodogne <s.jodogne@gmail.com> parents: 2932 diff changeset	521 "OrthancPeersInDatabase" : false,
2e751f615e03 new configuration options: DicomModalitiesInDatabase and OrthancPeersInDatabase Sebastien Jodogne <s.jodogne@gmail.com> parents: 2932 diff changeset	522
1273 88010d8e12cf Support of HTTP proxy Sebastien Jodogne <s.jodogne@gmail.com> parents: 1272 diff changeset	523 // Parameters of the HTTP proxy to be used by Orthanc. If set to the
88010d8e12cf Support of HTTP proxy Sebastien Jodogne <s.jodogne@gmail.com> parents: 1272 diff changeset	524 // empty string, no HTTP proxy is used. For instance:
88010d8e12cf Support of HTTP proxy Sebastien Jodogne <s.jodogne@gmail.com> parents: 1272 diff changeset	525 // "HttpProxy" : "192.168.0.1:3128"
88010d8e12cf Support of HTTP proxy Sebastien Jodogne <s.jodogne@gmail.com> parents: 1272 diff changeset	526 // "HttpProxy" : "proxyUser:proxyPassword@192.168.0.1:3128"
88010d8e12cf Support of HTTP proxy Sebastien Jodogne <s.jodogne@gmail.com> parents: 1272 diff changeset	527 "HttpProxy" : "",
683 7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	528
2788 959bd8857eb5 New configuration option: "HttpVerbose" to debug outgoing HTTP connections Sebastien Jodogne <s.jodogne@gmail.com> parents: 2736 diff changeset	529 // If set to "true", debug messages from libcurl will be issued
959bd8857eb5 New configuration option: "HttpVerbose" to debug outgoing HTTP connections Sebastien Jodogne <s.jodogne@gmail.com> parents: 2736 diff changeset	530 // whenever Orthanc makes an outgoing HTTP request. This is notably
959bd8857eb5 New configuration option: "HttpVerbose" to debug outgoing HTTP connections Sebastien Jodogne <s.jodogne@gmail.com> parents: 2736 diff changeset	531 // useful to debug HTTPS-related problems.
959bd8857eb5 New configuration option: "HttpVerbose" to debug outgoing HTTP connections Sebastien Jodogne <s.jodogne@gmail.com> parents: 2736 diff changeset	532 "HttpVerbose" : false,
959bd8857eb5 New configuration option: "HttpVerbose" to debug outgoing HTTP connections Sebastien Jodogne <s.jodogne@gmail.com> parents: 2736 diff changeset	533
1590 ba0226474e22 New configuration option: "HttpTimeout" to set the default timeout for HTTP requests Sebastien Jodogne <s.jodogne@gmail.com> parents: 1534 diff changeset	534 // Set the timeout for HTTP requests issued by Orthanc (in seconds).
3427 3ff4f07806eb Set HttpTimeout to 60 sec (that is a standard value across browsers and the same as in Stone of Orthanc) Benjamin Golinvaux <bgo@osimis.io> parents: 3346 diff changeset	535 "HttpTimeout" : 60,
1590 ba0226474e22 New configuration option: "HttpTimeout" to set the default timeout for HTTP requests Sebastien Jodogne <s.jodogne@gmail.com> parents: 1534 diff changeset	536
1973 7bd4cb780feb Option "HttpsVerifyPeers" can be used to connect against self-signed HTTPS certificates Sebastien Jodogne <s.jodogne@gmail.com> parents: 1871 diff changeset	537 // Enable the verification of the peers during HTTPS requests. This
7bd4cb780feb Option "HttpsVerifyPeers" can be used to connect against self-signed HTTPS certificates Sebastien Jodogne <s.jodogne@gmail.com> parents: 1871 diff changeset	538 // option must be set to "false" if using self-signed certificates.
7bd4cb780feb Option "HttpsVerifyPeers" can be used to connect against self-signed HTTPS certificates Sebastien Jodogne <s.jodogne@gmail.com> parents: 1871 diff changeset	539 // Pay attention that setting this option to "false" results in
7bd4cb780feb Option "HttpsVerifyPeers" can be used to connect against self-signed HTTPS certificates Sebastien Jodogne <s.jodogne@gmail.com> parents: 1871 diff changeset	540 // security risks!
1592 d73124f6b439 configuration option HttpDescribeErrors Sebastien Jodogne <s.jodogne@gmail.com> parents: 1590 diff changeset	541 // Reference: http://curl.haxx.se/docs/sslcerts.html
d73124f6b439 configuration option HttpDescribeErrors Sebastien Jodogne <s.jodogne@gmail.com> parents: 1590 diff changeset	542 "HttpsVerifyPeers" : true,
d73124f6b439 configuration option HttpDescribeErrors Sebastien Jodogne <s.jodogne@gmail.com> parents: 1590 diff changeset	543
d73124f6b439 configuration option HttpDescribeErrors Sebastien Jodogne <s.jodogne@gmail.com> parents: 1590 diff changeset	544 // Path to the CA (certification authority) certificates to validate
d73124f6b439 configuration option HttpDescribeErrors Sebastien Jodogne <s.jodogne@gmail.com> parents: 1590 diff changeset	545 // peers in HTTPS requests. From curl documentation ("--cacert"
d73124f6b439 configuration option HttpDescribeErrors Sebastien Jodogne <s.jodogne@gmail.com> parents: 1590 diff changeset	546 // option): "Tells curl to use the specified certificate file to
d73124f6b439 configuration option HttpDescribeErrors Sebastien Jodogne <s.jodogne@gmail.com> parents: 1590 diff changeset	547 // verify the peers. The file may contain multiple CA
2923 87366b8aed4f note Sebastien Jodogne <s.jodogne@gmail.com> parents: 2888 diff changeset	548 // certificates. The certificate(s) must be in PEM format." On
87366b8aed4f note Sebastien Jodogne <s.jodogne@gmail.com> parents: 2888 diff changeset	549 // Debian-based systems, this option can be set to
87366b8aed4f note Sebastien Jodogne <s.jodogne@gmail.com> parents: 2888 diff changeset	550 // "/etc/ssl/certs/ca-certificates.crt"
1592 d73124f6b439 configuration option HttpDescribeErrors Sebastien Jodogne <s.jodogne@gmail.com> parents: 1590 diff changeset	551 "HttpsCACertificates" : "",
d73124f6b439 configuration option HttpDescribeErrors Sebastien Jodogne <s.jodogne@gmail.com> parents: 1590 diff changeset	552
1590 ba0226474e22 New configuration option: "HttpTimeout" to set the default timeout for HTTP requests Sebastien Jodogne <s.jodogne@gmail.com> parents: 1534 diff changeset	553
683 7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	554
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	555 /**
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	556 * Advanced options
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	557 **/
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	558
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	559 // Dictionary of symbolic names for the user-defined metadata. Each
1772 53e045b5a8ec MIME content type can be associated to custom attachments (cf. "UserContentType") Sebastien Jodogne <s.jodogne@gmail.com> parents: 1765 diff changeset	560 // entry must map an unique string to an unique number between 1024
2184 71e8a70e9e99 note Sebastien Jodogne <s.jodogne@gmail.com> parents: 2152 diff changeset	561 // and 65535. Reserved values:
71e8a70e9e99 note Sebastien Jodogne <s.jodogne@gmail.com> parents: 2152 diff changeset	562 // - The Orthanc whole-slide imaging plugin uses metadata 4200
683 7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	563 "UserMetadata" : {
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	564 // "Sample" : 1024
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	565 },
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	566
696 4c1860179cc5 dictionary of user-defined content types Sebastien Jodogne <s.jodogne@gmail.com> parents: 695 diff changeset	567 // Dictionary of symbolic names for the user-defined types of
1772 53e045b5a8ec MIME content type can be associated to custom attachments (cf. "UserContentType") Sebastien Jodogne <s.jodogne@gmail.com> parents: 1765 diff changeset	568 // attached files. Each entry must map an unique string to an unique
53e045b5a8ec MIME content type can be associated to custom attachments (cf. "UserContentType") Sebastien Jodogne <s.jodogne@gmail.com> parents: 1765 diff changeset	569 // number between 1024 and 65535. Optionally, a second argument can
53e045b5a8ec MIME content type can be associated to custom attachments (cf. "UserContentType") Sebastien Jodogne <s.jodogne@gmail.com> parents: 1765 diff changeset	570 // provided to specify a MIME content type for the attachment.
696 4c1860179cc5 dictionary of user-defined content types Sebastien Jodogne <s.jodogne@gmail.com> parents: 695 diff changeset	571 "UserContentType" : {
4c1860179cc5 dictionary of user-defined content types Sebastien Jodogne <s.jodogne@gmail.com> parents: 695 diff changeset	572 // "sample" : 1024
1772 53e045b5a8ec MIME content type can be associated to custom attachments (cf. "UserContentType") Sebastien Jodogne <s.jodogne@gmail.com> parents: 1765 diff changeset	573 // "sample2" : [ 1025, "application/pdf" ]
696 4c1860179cc5 dictionary of user-defined content types Sebastien Jodogne <s.jodogne@gmail.com> parents: 695 diff changeset	574 },
4c1860179cc5 dictionary of user-defined content types Sebastien Jodogne <s.jodogne@gmail.com> parents: 695 diff changeset	575
683 7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	576 // Number of seconds without receiving any instance before a
7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	577 // patient, a study or a series is considered as stable.
685 b01cc78caba4 possibility to disable the DICOM/HTTP servers Sebastien Jodogne <s.jodogne@gmail.com> parents: 683 diff changeset	578 "StableAge" : 60,
b01cc78caba4 possibility to disable the DICOM/HTTP servers Sebastien Jodogne <s.jodogne@gmail.com> parents: 683 diff changeset	579
690 2e67366aab83 case-insensitive matching of Application Entity Titles Sebastien Jodogne <s.jodogne@gmail.com> parents: 685 diff changeset	580 // By default, Orthanc compares AET (Application Entity Titles) in a
2e67366aab83 case-insensitive matching of Application Entity Titles Sebastien Jodogne <s.jodogne@gmail.com> parents: 685 diff changeset	581 // case-insensitive way. Setting this option to "true" will enable
2e67366aab83 case-insensitive matching of Application Entity Titles Sebastien Jodogne <s.jodogne@gmail.com> parents: 685 diff changeset	582 // case-sensitive matching.
695 c59bc408fb10 parameter to disable the computation of the MD5 Sebastien Jodogne <s.jodogne@gmail.com> parents: 690 diff changeset	583 "StrictAetComparison" : false,
c59bc408fb10 parameter to disable the computation of the MD5 Sebastien Jodogne <s.jodogne@gmail.com> parents: 690 diff changeset	584
c59bc408fb10 parameter to disable the computation of the MD5 Sebastien Jodogne <s.jodogne@gmail.com> parents: 690 diff changeset	585 // When the following option is "true", the MD5 of the DICOM files
c59bc408fb10 parameter to disable the computation of the MD5 Sebastien Jodogne <s.jodogne@gmail.com> parents: 690 diff changeset	586 // will be computed and stored in the Orthanc database. This
c59bc408fb10 parameter to disable the computation of the MD5 Sebastien Jodogne <s.jodogne@gmail.com> parents: 690 diff changeset	587 // information can be used to detect disk corruption, at the price
c59bc408fb10 parameter to disable the computation of the MD5 Sebastien Jodogne <s.jodogne@gmail.com> parents: 690 diff changeset	588 // of a small performance overhead.
941 83489fddd8c5 Options to limit the number of results for an incoming C-FIND query Sebastien Jodogne <s.jodogne@gmail.com> parents: 732 diff changeset	589 "StoreMD5ForAttachments" : true,
83489fddd8c5 Options to limit the number of results for an incoming C-FIND query Sebastien Jodogne <s.jodogne@gmail.com> parents: 732 diff changeset	590
83489fddd8c5 Options to limit the number of results for an incoming C-FIND query Sebastien Jodogne <s.jodogne@gmail.com> parents: 732 diff changeset	591 // The maximum number of results for a single C-FIND request at the
83489fddd8c5 Options to limit the number of results for an incoming C-FIND query Sebastien Jodogne <s.jodogne@gmail.com> parents: 732 diff changeset	592 // Patient, Study or Series level. Setting this option to "0" means
83489fddd8c5 Options to limit the number of results for an incoming C-FIND query Sebastien Jodogne <s.jodogne@gmail.com> parents: 732 diff changeset	593 // no limit.
83489fddd8c5 Options to limit the number of results for an incoming C-FIND query Sebastien Jodogne <s.jodogne@gmail.com> parents: 732 diff changeset	594 "LimitFindResults" : 0,
83489fddd8c5 Options to limit the number of results for an incoming C-FIND query Sebastien Jodogne <s.jodogne@gmail.com> parents: 732 diff changeset	595
83489fddd8c5 Options to limit the number of results for an incoming C-FIND query Sebastien Jodogne <s.jodogne@gmail.com> parents: 732 diff changeset	596 // The maximum number of results for a single C-FIND request at the
83489fddd8c5 Options to limit the number of results for an incoming C-FIND query Sebastien Jodogne <s.jodogne@gmail.com> parents: 732 diff changeset	597 // Instance level. Setting this option to "0" means no limit.
995 8c67382f44a7 limit number of jobs in the scheduler Sebastien Jodogne <s.jodogne@gmail.com> parents: 941 diff changeset	598 "LimitFindInstances" : 0,
8c67382f44a7 limit number of jobs in the scheduler Sebastien Jodogne <s.jodogne@gmail.com> parents: 941 diff changeset	599
2685 6801f99bbc2f Configuration option "LogExportedResources" is now "false" by default Sebastien Jodogne <s.jodogne@gmail.com> parents: 2625 diff changeset	600 // If this option is set to "true" (default behavior until Orthanc
6801f99bbc2f Configuration option "LogExportedResources" is now "false" by default Sebastien Jodogne <s.jodogne@gmail.com> parents: 2625 diff changeset	601 // 1.3.2), Orthanc will log the resources that are exported to other
6801f99bbc2f Configuration option "LogExportedResources" is now "false" by default Sebastien Jodogne <s.jodogne@gmail.com> parents: 2625 diff changeset	602 // DICOM modalities or Orthanc peers, inside the URI
6801f99bbc2f Configuration option "LogExportedResources" is now "false" by default Sebastien Jodogne <s.jodogne@gmail.com> parents: 2625 diff changeset	603 // "/exports". Setting this option to "false" is useful to prevent
6801f99bbc2f Configuration option "LogExportedResources" is now "false" by default Sebastien Jodogne <s.jodogne@gmail.com> parents: 2625 diff changeset	604 // the index to grow indefinitely in auto-routing tasks (this is the
6801f99bbc2f Configuration option "LogExportedResources" is now "false" by default Sebastien Jodogne <s.jodogne@gmail.com> parents: 2625 diff changeset	605 // default behavior since Orthanc 1.4.0).
6801f99bbc2f Configuration option "LogExportedResources" is now "false" by default Sebastien Jodogne <s.jodogne@gmail.com> parents: 2625 diff changeset	606 "LogExportedResources" : false,
1142 952cf9b6be83 Configuration option to disable the logging of exported resources Sebastien Jodogne <s.jodogne@gmail.com> parents: 1135 diff changeset	607
3126 b1787ba94eef fix issue #32 (HTTP keep-alive), make CivetWeb the default HTTP server Sebastien Jodogne <s.jodogne@gmail.com> parents: 3045 diff changeset	608 // Enable or disable HTTP Keep-Alive (persistent HTTP
b1787ba94eef fix issue #32 (HTTP keep-alive), make CivetWeb the default HTTP server Sebastien Jodogne <s.jodogne@gmail.com> parents: 3045 diff changeset	609 // connections). Setting this option to "true" prevents Orthanc
b1787ba94eef fix issue #32 (HTTP keep-alive), make CivetWeb the default HTTP server Sebastien Jodogne <s.jodogne@gmail.com> parents: 3045 diff changeset	610 // issue #32 ("HttpServer does not support multiple HTTP requests in
3137 5a3b961e9524 New configuration option: 'TcpNoDelay' to disable Nagle's algorithm in HTTP server Sebastien Jodogne <s.jodogne@gmail.com> parents: 3126 diff changeset	611 // the same TCP stream"), but can possibly slow down HTTP clients
5a3b961e9524 New configuration option: 'TcpNoDelay' to disable Nagle's algorithm in HTTP server Sebastien Jodogne <s.jodogne@gmail.com> parents: 3126 diff changeset	612 // that do not support persistent connections. The default behavior
5a3b961e9524 New configuration option: 'TcpNoDelay' to disable Nagle's algorithm in HTTP server Sebastien Jodogne <s.jodogne@gmail.com> parents: 3126 diff changeset	613 // used to be "false" in Orthanc <= 1.5.1. Setting this option to
5a3b961e9524 New configuration option: 'TcpNoDelay' to disable Nagle's algorithm in HTTP server Sebastien Jodogne <s.jodogne@gmail.com> parents: 3126 diff changeset	614 // "false" is also recommended if Orthanc is compiled against
5a3b961e9524 New configuration option: 'TcpNoDelay' to disable Nagle's algorithm in HTTP server Sebastien Jodogne <s.jodogne@gmail.com> parents: 3126 diff changeset	615 // Mongoose.
3126 b1787ba94eef fix issue #32 (HTTP keep-alive), make CivetWeb the default HTTP server Sebastien Jodogne <s.jodogne@gmail.com> parents: 3045 diff changeset	616 "KeepAlive" : true,
1135 67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1115 diff changeset	617
5119 bdec57f3cbf2 New configuration KeepAliveTimeout with a default value of 1 second Alain Mazy <am@osimis.io> parents: 5061 diff changeset	618 // Defines the Keep-Alive timeout in seconds.
bdec57f3cbf2 New configuration KeepAliveTimeout with a default value of 1 second Alain Mazy <am@osimis.io> parents: 5061 diff changeset	619 // (new in Orthanc 1.11.3)
bdec57f3cbf2 New configuration KeepAliveTimeout with a default value of 1 second Alain Mazy <am@osimis.io> parents: 5061 diff changeset	620 "KeepAliveTimeout" : 1,
bdec57f3cbf2 New configuration KeepAliveTimeout with a default value of 1 second Alain Mazy <am@osimis.io> parents: 5061 diff changeset	621
3137 5a3b961e9524 New configuration option: 'TcpNoDelay' to disable Nagle's algorithm in HTTP server Sebastien Jodogne <s.jodogne@gmail.com> parents: 3126 diff changeset	622 // Enable or disable Nagle's algorithm. Only taken into
5a3b961e9524 New configuration option: 'TcpNoDelay' to disable Nagle's algorithm in HTTP server Sebastien Jodogne <s.jodogne@gmail.com> parents: 3126 diff changeset	623 // consideration if Orthanc is compiled to use CivetWeb. Experiments
5a3b961e9524 New configuration option: 'TcpNoDelay' to disable Nagle's algorithm in HTTP server Sebastien Jodogne <s.jodogne@gmail.com> parents: 3126 diff changeset	624 // show that best performance can be obtained by setting both
5a3b961e9524 New configuration option: 'TcpNoDelay' to disable Nagle's algorithm in HTTP server Sebastien Jodogne <s.jodogne@gmail.com> parents: 3126 diff changeset	625 // "KeepAlive" and "TcpNoDelay" to "true". Beware however of
5a3b961e9524 New configuration option: 'TcpNoDelay' to disable Nagle's algorithm in HTTP server Sebastien Jodogne <s.jodogne@gmail.com> parents: 3126 diff changeset	626 // caveats: https://eklitzke.org/the-caveats-of-tcp-nodelay
5a3b961e9524 New configuration option: 'TcpNoDelay' to disable Nagle's algorithm in HTTP server Sebastien Jodogne <s.jodogne@gmail.com> parents: 3126 diff changeset	627 "TcpNoDelay" : true,
5a3b961e9524 New configuration option: 'TcpNoDelay' to disable Nagle's algorithm in HTTP server Sebastien Jodogne <s.jodogne@gmail.com> parents: 3126 diff changeset	628
3852 ee0a1211419f reverting default HttpThreadsCount to 50, as this slows performance of integration tests from 40s to 170s Sebastien Jodogne <s.jodogne@gmail.com> parents: 3851 diff changeset	629 // Number of threads that are used by the embedded HTTP server.
ee0a1211419f reverting default HttpThreadsCount to 50, as this slows performance of integration tests from 40s to 170s Sebastien Jodogne <s.jodogne@gmail.com> parents: 3851 diff changeset	630 "HttpThreadsCount" : 50,
3180 07a2f637b76d new option: "HttpThreadsCount" to set the number of threads in the embedded HTTP server Sebastien Jodogne <s.jodogne@gmail.com> parents: 3174 diff changeset	631
1135 67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1115 diff changeset	632 // If this option is set to "false", Orthanc will run in index-only
4647 c8886cd6cae8 clarification about "StoreDicom" option Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	633 // mode. The DICOM files will not be stored on the drive: Orthanc
c8886cd6cae8 clarification about "StoreDicom" option Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	634 // only indexes the small subset of the so-called "main DICOM tags"
c8886cd6cae8 clarification about "StoreDicom" option Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	635 // in its SQL database. Note that this option might prevent the
c8886cd6cae8 clarification about "StoreDicom" option Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	636 // upgrade to newer versions of Orthanc. Also note that this
c8886cd6cae8 clarification about "StoreDicom" option Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	637 // behavior might not be available with the storage area plugins.
1284 21ea32170764 Option "DicomAssociationCloseDelay" to set delay before closing DICOM association Sebastien Jodogne <s.jodogne@gmail.com> parents: 1283 diff changeset	638 "StoreDicom" : true,
21ea32170764 Option "DicomAssociationCloseDelay" to set delay before closing DICOM association Sebastien Jodogne <s.jodogne@gmail.com> parents: 1283 diff changeset	639
2620 1232922c8793 speeding up shutdown if Lua script is in trailing phase Sebastien Jodogne <s.jodogne@gmail.com> parents: 2570 diff changeset	640 // DICOM associations initiated by Lua scripts are kept open as long
1232922c8793 speeding up shutdown if Lua script is in trailing phase Sebastien Jodogne <s.jodogne@gmail.com> parents: 2570 diff changeset	641 // as new DICOM commands are issued. This option sets the number of
1232922c8793 speeding up shutdown if Lua script is in trailing phase Sebastien Jodogne <s.jodogne@gmail.com> parents: 2570 diff changeset	642 // seconds of inactivity to wait before automatically closing a
1232922c8793 speeding up shutdown if Lua script is in trailing phase Sebastien Jodogne <s.jodogne@gmail.com> parents: 2570 diff changeset	643 // DICOM association used by Lua. If set to 0, the connection is
3851 6498739a3c3c refactoring: TimeoutDicomConnectionManager is now only used by Lua Sebastien Jodogne <s.jodogne@gmail.com> parents: 3842 diff changeset	644 // closed immediately. This option is only used in Lua scripts.
1374 a1745d9be6e9 CaseSensitivePN configuration option Sebastien Jodogne <s.jodogne@gmail.com> parents: 1347 diff changeset	645 "DicomAssociationCloseDelay" : 5,
a1745d9be6e9 CaseSensitivePN configuration option Sebastien Jodogne <s.jodogne@gmail.com> parents: 1347 diff changeset	646
1368 b22ba8c5edbe query retrieve Sebastien Jodogne <s.jodogne@gmail.com> parents: 1347 diff changeset	647 // Maximum number of query/retrieve DICOM requests that are
b22ba8c5edbe query retrieve Sebastien Jodogne <s.jodogne@gmail.com> parents: 1347 diff changeset	648 // maintained by Orthanc. The least recently used requests get
b22ba8c5edbe query retrieve Sebastien Jodogne <s.jodogne@gmail.com> parents: 1347 diff changeset	649 // deleted as new requests are issued.
3346 f509d3c6d570 increasing default value of QueryRetrieveSize to 100 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3300 diff changeset	650 "QueryRetrieveSize" : 100,
1383 5c11c4e728eb integration mainline->query-retrieve Sebastien Jodogne <s.jodogne@gmail.com> parents: 1368 1382 diff changeset	651
4474 f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4465 diff changeset	652 // When handling a C-FIND SCP request, setting this flag to "true"
1729 54d78925cbb6 notes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1668 diff changeset	653 // will enable case-sensitive match for PN value representation
54d78925cbb6 notes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1668 diff changeset	654 // (such as PatientName). By default, the search is
54d78925cbb6 notes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1668 diff changeset	655 // case-insensitive, which does not follow the DICOM standard.
1765 57b9e6890482 New configuration option: "Dictionary" to declare custom DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1729 diff changeset	656 "CaseSensitivePN" : false,
2022 fefbe71c2272 Possibility to use PKCS#11 authentication for hardware security modules with Orthanc peers Sebastien Jodogne <s.jodogne@gmail.com> parents: 2019 diff changeset	657
fefbe71c2272 Possibility to use PKCS#11 authentication for hardware security modules with Orthanc peers Sebastien Jodogne <s.jodogne@gmail.com> parents: 2019 diff changeset	658 // Configure PKCS#11 to use hardware security modules (HSM) and
fefbe71c2272 Possibility to use PKCS#11 authentication for hardware security modules with Orthanc peers Sebastien Jodogne <s.jodogne@gmail.com> parents: 2019 diff changeset	659 // smart cards when carrying on HTTPS client authentication.
fefbe71c2272 Possibility to use PKCS#11 authentication for hardware security modules with Orthanc peers Sebastien Jodogne <s.jodogne@gmail.com> parents: 2019 diff changeset	660 /**
fefbe71c2272 Possibility to use PKCS#11 authentication for hardware security modules with Orthanc peers Sebastien Jodogne <s.jodogne@gmail.com> parents: 2019 diff changeset	661 "Pkcs11" : {
fefbe71c2272 Possibility to use PKCS#11 authentication for hardware security modules with Orthanc peers Sebastien Jodogne <s.jodogne@gmail.com> parents: 2019 diff changeset	662 "Module" : "/usr/local/lib/libbeidpkcs11.so",
2030 b4da986c82bb beid Sebastien Jodogne <s.jodogne@gmail.com> parents: 2022 diff changeset	663 "Module" : "C:/Windows/System32/beidpkcs11.dll",
2022 fefbe71c2272 Possibility to use PKCS#11 authentication for hardware security modules with Orthanc peers Sebastien Jodogne <s.jodogne@gmail.com> parents: 2019 diff changeset	664 "Pin" : "1234",
fefbe71c2272 Possibility to use PKCS#11 authentication for hardware security modules with Orthanc peers Sebastien Jodogne <s.jodogne@gmail.com> parents: 2019 diff changeset	665 "Verbose" : true
fefbe71c2272 Possibility to use PKCS#11 authentication for hardware security modules with Orthanc peers Sebastien Jodogne <s.jodogne@gmail.com> parents: 2019 diff changeset	666 }
fefbe71c2272 Possibility to use PKCS#11 authentication for hardware security modules with Orthanc peers Sebastien Jodogne <s.jodogne@gmail.com> parents: 2019 diff changeset	667 **/
1765 57b9e6890482 New configuration option: "Dictionary" to declare custom DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1729 diff changeset	668
2151 8cbb55089a1d New configuration option: "LoadPrivateDictionary" Sebastien Jodogne <s.jodogne@gmail.com> parents: 2129 diff changeset	669 // If set to "false", Orthanc will not load its default dictionary
8cbb55089a1d New configuration option: "LoadPrivateDictionary" Sebastien Jodogne <s.jodogne@gmail.com> parents: 2129 diff changeset	670 // of private tags. This might be necessary if you cannot import a
8cbb55089a1d New configuration option: "LoadPrivateDictionary" Sebastien Jodogne <s.jodogne@gmail.com> parents: 2129 diff changeset	671 // DICOM file encoded using the Implicit VR Endian transfer syntax,
2152 cbebc5d072b0 Use of DCMTK 3.6.1 dictionary of private tags in standalone builds Sebastien Jodogne <s.jodogne@gmail.com> parents: 2151 diff changeset	672 // and containing private tags: Such an import error might stem from
cbebc5d072b0 Use of DCMTK 3.6.1 dictionary of private tags in standalone builds Sebastien Jodogne <s.jodogne@gmail.com> parents: 2151 diff changeset	673 // a bad dictionary. You can still list your private tags of
cbebc5d072b0 Use of DCMTK 3.6.1 dictionary of private tags in standalone builds Sebastien Jodogne <s.jodogne@gmail.com> parents: 2151 diff changeset	674 // interest in the "Dictionary" configuration option below.
2151 8cbb55089a1d New configuration option: "LoadPrivateDictionary" Sebastien Jodogne <s.jodogne@gmail.com> parents: 2129 diff changeset	675 "LoadPrivateDictionary" : true,
8cbb55089a1d New configuration option: "LoadPrivateDictionary" Sebastien Jodogne <s.jodogne@gmail.com> parents: 2129 diff changeset	676
2334 dd26536454a0 fix for mingw Sebastien Jodogne <s.jodogne@gmail.com> parents: 2330 diff changeset	677 // Locale to be used by Orthanc. Currently, only used if comparing
dd26536454a0 fix for mingw Sebastien Jodogne <s.jodogne@gmail.com> parents: 2330 diff changeset	678 // strings in a case-insensitive way. It should be safe to keep this
dd26536454a0 fix for mingw Sebastien Jodogne <s.jodogne@gmail.com> parents: 2330 diff changeset	679 // value undefined, which lets Orthanc autodetect the suitable locale.
2330 9c7a80c87ae9 "Locale" configuration option Sebastien Jodogne <s.jodogne@gmail.com> parents: 2319 diff changeset	680 // "Locale" : "en_US.UTF-8",
9c7a80c87ae9 "Locale" configuration option Sebastien Jodogne <s.jodogne@gmail.com> parents: 2319 diff changeset	681
1765 57b9e6890482 New configuration option: "Dictionary" to declare custom DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1729 diff changeset	682 // Register a new tag in the dictionary of DICOM tags that are known
57b9e6890482 New configuration option: "Dictionary" to declare custom DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1729 diff changeset	683 // to Orthanc. Each line must contain the tag (formatted as 2
57b9e6890482 New configuration option: "Dictionary" to declare custom DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1729 diff changeset	684 // hexadecimal numbers), the value representation (2 upcase
57b9e6890482 New configuration option: "Dictionary" to declare custom DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1729 diff changeset	685 // characters), a nickname for the tag, possibly the minimum
2115 a657f7772e69 Handling of private tags/creators in the "Dictionary" configuration option Sebastien Jodogne <s.jodogne@gmail.com> parents: 2069 diff changeset	686 // multiplicity (> 0 with defaults to 1), possibly the maximum
a657f7772e69 Handling of private tags/creators in the "Dictionary" configuration option Sebastien Jodogne <s.jodogne@gmail.com> parents: 2069 diff changeset	687 // multiplicity (0 means arbitrary multiplicity, defaults to 1), and
a657f7772e69 Handling of private tags/creators in the "Dictionary" configuration option Sebastien Jodogne <s.jodogne@gmail.com> parents: 2069 diff changeset	688 // possibly the Private Creator (for private tags).
4912 45d6ce72a84e fix linking of Sanitizer sample plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 4902 diff changeset	689 // Note: For private tags, you should only declare the lower 8 bits
4857 275bc6769d60 doc for private tags Alain Mazy <am@osimis.io> parents: 4810 diff changeset	690 // of the element since the higher 8 bits may vary from one file to
275bc6769d60 doc for private tags Alain Mazy <am@osimis.io> parents: 4810 diff changeset	691 // the other.
1765 57b9e6890482 New configuration option: "Dictionary" to declare custom DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1729 diff changeset	692 "Dictionary" : {
57b9e6890482 New configuration option: "Dictionary" to declare custom DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1729 diff changeset	693 // "0014,1020" : [ "DA", "ValidationExpiryDate", 1, 1 ]
4857 275bc6769d60 doc for private tags Alain Mazy <am@osimis.io> parents: 4810 diff changeset	694 // "00e1,c2" : [ "UI", "PET-CT Multi Modality Name", 1, 1, "ELSCINT1" ]
275bc6769d60 doc for private tags Alain Mazy <am@osimis.io> parents: 4810 diff changeset	695 // "7053,03" : [ "ST", "Original Image Filename", 1, 1, "Philips PET Private Group" ]
2152 cbebc5d072b0 Use of DCMTK 3.6.1 dictionary of private tags in standalone builds Sebastien Jodogne <s.jodogne@gmail.com> parents: 2151 diff changeset	696 // "2001,5f" : [ "SQ", "StackSequence", 1, 1, "Philips Imaging DD 001" ]
2620 1232922c8793 speeding up shutdown if Lua script is in trailing phase Sebastien Jodogne <s.jodogne@gmail.com> parents: 2570 diff changeset	697 },
1232922c8793 speeding up shutdown if Lua script is in trailing phase Sebastien Jodogne <s.jodogne@gmail.com> parents: 2570 diff changeset	698
4696 dd6274412ff4 new configuration option "ExternalDictionaries" to load external DICOM dictionaries Sebastien Jodogne <s.jodogne@gmail.com> parents: 4677 diff changeset	699 // Load a set of external DICOM dictionaries in order to replace the
dd6274412ff4 new configuration option "ExternalDictionaries" to load external DICOM dictionaries Sebastien Jodogne <s.jodogne@gmail.com> parents: 4677 diff changeset	700 // default dictionaries. This option must contain a set of files in
dd6274412ff4 new configuration option "ExternalDictionaries" to load external DICOM dictionaries Sebastien Jodogne <s.jodogne@gmail.com> parents: 4677 diff changeset	701 // the DCMTK format. The order of the dictionaries is
4699 facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4696 diff changeset	702 // important. This option can be used to turn Orthanc into a DICONDE
4696 dd6274412ff4 new configuration option "ExternalDictionaries" to load external DICOM dictionaries Sebastien Jodogne <s.jodogne@gmail.com> parents: 4677 diff changeset	703 // server. (new in Orthanc 1.9.4)
dd6274412ff4 new configuration option "ExternalDictionaries" to load external DICOM dictionaries Sebastien Jodogne <s.jodogne@gmail.com> parents: 4677 diff changeset	704 /**
dd6274412ff4 new configuration option "ExternalDictionaries" to load external DICOM dictionaries Sebastien Jodogne <s.jodogne@gmail.com> parents: 4677 diff changeset	705 "ExternalDictionaries" : [
dd6274412ff4 new configuration option "ExternalDictionaries" to load external DICOM dictionaries Sebastien Jodogne <s.jodogne@gmail.com> parents: 4677 diff changeset	706 "/usr/share/libdcmtk12/dicom.dic",
dd6274412ff4 new configuration option "ExternalDictionaries" to load external DICOM dictionaries Sebastien Jodogne <s.jodogne@gmail.com> parents: 4677 diff changeset	707 "/usr/share/libdcmtk12/diconde.dic"
dd6274412ff4 new configuration option "ExternalDictionaries" to load external DICOM dictionaries Sebastien Jodogne <s.jodogne@gmail.com> parents: 4677 diff changeset	708 ]
dd6274412ff4 new configuration option "ExternalDictionaries" to load external DICOM dictionaries Sebastien Jodogne <s.jodogne@gmail.com> parents: 4677 diff changeset	709 **/
dd6274412ff4 new configuration option "ExternalDictionaries" to load external DICOM dictionaries Sebastien Jodogne <s.jodogne@gmail.com> parents: 4677 diff changeset	710
4474 f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4465 diff changeset	711 // Whether to run DICOM C-MOVE operations synchronously. If set to
f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4465 diff changeset	712 // "false" (asynchronous mode), each incoming C-MOVE request results
3045 095193bbd7b9 fix issue #118 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3015 diff changeset	713 // in the creation of a new background job. Up to Orthanc 1.3.2, the
4474 f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4465 diff changeset	714 // implicit behavior was to use synchronous C-MOVE ("true"). Between
3045 095193bbd7b9 fix issue #118 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3015 diff changeset	715 // Orthanc 1.4.0 and 1.4.2, the default behavior was set to
4474 f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4465 diff changeset	716 // asynchronous C-MOVE ("false"). Since Orthanc 1.5.0, the default
f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4465 diff changeset	717 // behavior is back to synchronous C-MOVE ("true", which ensures
3045 095193bbd7b9 fix issue #118 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3015 diff changeset	718 // backward compatibility with Orthanc <= 1.3.2).
2932 00504dcc996f "SynchronousCMove" is now "true" by default Sebastien Jodogne <s.jodogne@gmail.com> parents: 2923 diff changeset	719 "SynchronousCMove" : true,
2625 5469dda691cd new configuration option: SynchronousCMove Sebastien Jodogne <s.jodogne@gmail.com> parents: 2620 diff changeset	720
2620 1232922c8793 speeding up shutdown if Lua script is in trailing phase Sebastien Jodogne <s.jodogne@gmail.com> parents: 2570 diff changeset	721 // Maximum number of completed jobs that are kept in memory. A
1232922c8793 speeding up shutdown if Lua script is in trailing phase Sebastien Jodogne <s.jodogne@gmail.com> parents: 2570 diff changeset	722 // processing job is considered as complete once it is tagged as
2988 9cc3d40e389b Orthanc 1.4.3 is now known as 1.5.0 Sebastien Jodogne <s.jodogne@gmail.com> parents: 2965 diff changeset	723 // "Success" or "Failure". Since Orthanc 1.5.0, a value of "0"
2950 dc18d5804746 support of JobsHistorySize set to zero Sebastien Jodogne <s.jodogne@gmail.com> parents: 2946 diff changeset	724 // indicates to keep no job in memory (i.e. jobs are removed from
3162 94a4f75cc746 Fix issue #119 (/patients/.../archive returns a 500 when JobsHistorySize is 0) Sebastien Jodogne <s.jodogne@gmail.com> parents: 3137 diff changeset	725 // the history as soon as they are completed), which prevents the
94a4f75cc746 Fix issue #119 (/patients/.../archive returns a 500 when JobsHistorySize is 0) Sebastien Jodogne <s.jodogne@gmail.com> parents: 3137 diff changeset	726 // use of some features of Orthanc (typically, synchronous mode in
94a4f75cc746 Fix issue #119 (/patients/.../archive returns a 500 when JobsHistorySize is 0) Sebastien Jodogne <s.jodogne@gmail.com> parents: 3137 diff changeset	727 // REST API) and should be avoided for non-developers.
2825 8aa6aef11b70 New configuration option "OverwriteInstances" to choose how duplicate SOPInstanceUID are handled Sebastien Jodogne <s.jodogne@gmail.com> parents: 2800 diff changeset	728 "JobsHistorySize" : 10,
8aa6aef11b70 New configuration option "OverwriteInstances" to choose how duplicate SOPInstanceUID are handled Sebastien Jodogne <s.jodogne@gmail.com> parents: 2800 diff changeset	729
3165 1fe524e211af New configuration option: "SaveJobs" to specify whether jobs are stored in the database Sebastien Jodogne <s.jodogne@gmail.com> parents: 3162 diff changeset	730 // Whether to save the jobs into the Orthanc database. If this
1fe524e211af New configuration option: "SaveJobs" to specify whether jobs are stored in the database Sebastien Jodogne <s.jodogne@gmail.com> parents: 3162 diff changeset	731 // option is set to "true", the pending/running/completed jobs are
1fe524e211af New configuration option: "SaveJobs" to specify whether jobs are stored in the database Sebastien Jodogne <s.jodogne@gmail.com> parents: 3162 diff changeset	732 // automatically reloaded from the database if Orthanc is stopped
1fe524e211af New configuration option: "SaveJobs" to specify whether jobs are stored in the database Sebastien Jodogne <s.jodogne@gmail.com> parents: 3162 diff changeset	733 // then restarted (except if the "--no-jobs" command-line argument
1fe524e211af New configuration option: "SaveJobs" to specify whether jobs are stored in the database Sebastien Jodogne <s.jodogne@gmail.com> parents: 3162 diff changeset	734 // is specified). This option should be set to "false" if multiple
1fe524e211af New configuration option: "SaveJobs" to specify whether jobs are stored in the database Sebastien Jodogne <s.jodogne@gmail.com> parents: 3162 diff changeset	735 // Orthanc servers are using the same database (e.g. if PostgreSQL
1fe524e211af New configuration option: "SaveJobs" to specify whether jobs are stored in the database Sebastien Jodogne <s.jodogne@gmail.com> parents: 3162 diff changeset	736 // or MariaDB/MySQL is used).
1fe524e211af New configuration option: "SaveJobs" to specify whether jobs are stored in the database Sebastien Jodogne <s.jodogne@gmail.com> parents: 3162 diff changeset	737 "SaveJobs" : true,
1fe524e211af New configuration option: "SaveJobs" to specify whether jobs are stored in the database Sebastien Jodogne <s.jodogne@gmail.com> parents: 3162 diff changeset	738
2825 8aa6aef11b70 New configuration option "OverwriteInstances" to choose how duplicate SOPInstanceUID are handled Sebastien Jodogne <s.jodogne@gmail.com> parents: 2800 diff changeset	739 // Specifies how Orthanc reacts when it receives a DICOM instance
8aa6aef11b70 New configuration option "OverwriteInstances" to choose how duplicate SOPInstanceUID are handled Sebastien Jodogne <s.jodogne@gmail.com> parents: 2800 diff changeset	740 // whose SOPInstanceUID is already stored. If set to "true", the new
8aa6aef11b70 New configuration option "OverwriteInstances" to choose how duplicate SOPInstanceUID are handled Sebastien Jodogne <s.jodogne@gmail.com> parents: 2800 diff changeset	741 // instance replaces the old one. If set to "false", the new
8aa6aef11b70 New configuration option "OverwriteInstances" to choose how duplicate SOPInstanceUID are handled Sebastien Jodogne <s.jodogne@gmail.com> parents: 2800 diff changeset	742 // instance is discarded and the old one is kept. Up to Orthanc
8aa6aef11b70 New configuration option "OverwriteInstances" to choose how duplicate SOPInstanceUID are handled Sebastien Jodogne <s.jodogne@gmail.com> parents: 2800 diff changeset	743 // 1.4.1, the implicit behavior corresponded to "false".
2965 9c0b0a6d8b54 MediaArchiveSize configuration option Sebastien Jodogne <s.jodogne@gmail.com> parents: 2950 diff changeset	744 "OverwriteInstances" : false,
9c0b0a6d8b54 MediaArchiveSize configuration option Sebastien Jodogne <s.jodogne@gmail.com> parents: 2950 diff changeset	745
9c0b0a6d8b54 MediaArchiveSize configuration option Sebastien Jodogne <s.jodogne@gmail.com> parents: 2950 diff changeset	746 // Maximum number of ZIP/media archives that are maintained by
9c0b0a6d8b54 MediaArchiveSize configuration option Sebastien Jodogne <s.jodogne@gmail.com> parents: 2950 diff changeset	747 // Orthanc, as a response to the asynchronous creation of archives.
9c0b0a6d8b54 MediaArchiveSize configuration option Sebastien Jodogne <s.jodogne@gmail.com> parents: 2950 diff changeset	748 // The least recently used archives get deleted as new archives are
2988 9cc3d40e389b Orthanc 1.4.3 is now known as 1.5.0 Sebastien Jodogne <s.jodogne@gmail.com> parents: 2965 diff changeset	749 // generated. This option was introduced in Orthanc 1.5.0, and has
2965 9c0b0a6d8b54 MediaArchiveSize configuration option Sebastien Jodogne <s.jodogne@gmail.com> parents: 2950 diff changeset	750 // no effect on the synchronous generation of archives.
3015 abe49ca61cd5 On C-FIND, avoid accessing the storage area whenever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 2988 diff changeset	751 "MediaArchiveSize" : 1,
abe49ca61cd5 On C-FIND, avoid accessing the storage area whenever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 2988 diff changeset	752
abe49ca61cd5 On C-FIND, avoid accessing the storage area whenever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 2988 diff changeset	753 // Performance setting to specify how Orthanc accesses the storage
4753 c95e4a1e65ed doc StorageAccessOnFind Alain Mazy <am@osimis.io> parents: 4751 diff changeset	754 // area during find operations (C-FIND, /tools/find API route and
c95e4a1e65ed doc StorageAccessOnFind Alain Mazy <am@osimis.io> parents: 4751 diff changeset	755 // QIDO-RS in dicom-web). Three modes are available: (1) "Always"
3015 abe49ca61cd5 On C-FIND, avoid accessing the storage area whenever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 2988 diff changeset	756 // allows Orthanc to read the storage area as soon as it needs an
abe49ca61cd5 On C-FIND, avoid accessing the storage area whenever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 2988 diff changeset	757 // information that is not present in its database (slowest mode),
abe49ca61cd5 On C-FIND, avoid accessing the storage area whenever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 2988 diff changeset	758 // (2) "Never" prevents Orthanc from accessing the storage area, and
abe49ca61cd5 On C-FIND, avoid accessing the storage area whenever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 2988 diff changeset	759 // makes it uses exclusively its database (fastest mode), and (3)
abe49ca61cd5 On C-FIND, avoid accessing the storage area whenever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 2988 diff changeset	760 // "Answers" allows Orthanc to read the storage area to generate its
abe49ca61cd5 On C-FIND, avoid accessing the storage area whenever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 2988 diff changeset	761 // answers, but not to filter the DICOM resources (balance between
abe49ca61cd5 On C-FIND, avoid accessing the storage area whenever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 2988 diff changeset	762 // the two modes). By default, the mode is "Always", which
abe49ca61cd5 On C-FIND, avoid accessing the storage area whenever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 2988 diff changeset	763 // corresponds to the behavior of Orthanc <= 1.5.0.
3174 8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3165 diff changeset	764 "StorageAccessOnFind" : "Always",
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3165 diff changeset	765
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3165 diff changeset	766 // Whether Orthanc monitors its metrics (new in Orthanc 1.5.4). If
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3165 diff changeset	767 // set to "true", the metrics can be retrieved at
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3165 diff changeset	768 // "/tools/metrics-prometheus" formetted using the Prometheus
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3165 diff changeset	769 // text-based exposition format.
3526 f07352e0375c new configuration option ExecuteLuaEnabled Sebastien Jodogne <s.jodogne@gmail.com> parents: 3506 diff changeset	770 "MetricsEnabled" : true,
f07352e0375c new configuration option ExecuteLuaEnabled Sebastien Jodogne <s.jodogne@gmail.com> parents: 3506 diff changeset	771
f07352e0375c new configuration option ExecuteLuaEnabled Sebastien Jodogne <s.jodogne@gmail.com> parents: 3506 diff changeset	772 // Whether calls to URI "/tools/execute-script" is enabled. Starting
f07352e0375c new configuration option ExecuteLuaEnabled Sebastien Jodogne <s.jodogne@gmail.com> parents: 3506 diff changeset	773 // with Orthanc 1.5.8, this URI is disabled by default for security.
3537 9cc09f4c0fa9 New configuration option: "HttpRequestTimeout" Sebastien Jodogne <s.jodogne@gmail.com> parents: 3526 diff changeset	774 "ExecuteLuaEnabled" : false,
9cc09f4c0fa9 New configuration option: "HttpRequestTimeout" Sebastien Jodogne <s.jodogne@gmail.com> parents: 3526 diff changeset	775
5201 345dac17a349 text Sebastien Jodogne <s.jodogne@gmail.com> parents: 5200 diff changeset	776 // Whether the REST API can write to the filesystem (e.g. in
5200 f8f1c4a9a216 New configuration option 'RestApiWriteToFileSystemEnabled' Alain Mazy <am@osimis.io> parents: 5174 diff changeset	777 // /instances/../export route). Starting with Orthanc 1.12.0,
f8f1c4a9a216 New configuration option 'RestApiWriteToFileSystemEnabled' Alain Mazy <am@osimis.io> parents: 5174 diff changeset	778 // this URI is disabled by default for security.
f8f1c4a9a216 New configuration option 'RestApiWriteToFileSystemEnabled' Alain Mazy <am@osimis.io> parents: 5174 diff changeset	779 "RestApiWriteToFileSystemEnabled": false,
f8f1c4a9a216 New configuration option 'RestApiWriteToFileSystemEnabled' Alain Mazy <am@osimis.io> parents: 5174 diff changeset	780
4522 017ab543e6ef added field "Timeout" in "OrthancPeers" configuration option Sebastien Jodogne <s.jodogne@gmail.com> parents: 4518 diff changeset	781 // Set the timeout while serving HTTP requests by the embedded Web
017ab543e6ef added field "Timeout" in "OrthancPeers" configuration option Sebastien Jodogne <s.jodogne@gmail.com> parents: 4518 diff changeset	782 // server, in seconds. This corresponds to option
017ab543e6ef added field "Timeout" in "OrthancPeers" configuration option Sebastien Jodogne <s.jodogne@gmail.com> parents: 4518 diff changeset	783 // "request_timeout_ms" of Mongoose/Civetweb. It will set the socket
017ab543e6ef added field "Timeout" in "OrthancPeers" configuration option Sebastien Jodogne <s.jodogne@gmail.com> parents: 4518 diff changeset	784 // options "SO_RCVTIMEO" and "SO_SNDTIMEO" to the specified value.
3709 1f4910999fe7 Fix issue #168 (Plugins can't read private tags from the configuration file) Sebastien Jodogne <s.jodogne@gmail.com> parents: 3643 diff changeset	785 "HttpRequestTimeout" : 30,
1f4910999fe7 Fix issue #168 (Plugins can't read private tags from the configuration file) Sebastien Jodogne <s.jodogne@gmail.com> parents: 3643 diff changeset	786
1f4910999fe7 Fix issue #168 (Plugins can't read private tags from the configuration file) Sebastien Jodogne <s.jodogne@gmail.com> parents: 3643 diff changeset	787 // Set the default private creator that is used by Orthanc when it
1f4910999fe7 Fix issue #168 (Plugins can't read private tags from the configuration file) Sebastien Jodogne <s.jodogne@gmail.com> parents: 3643 diff changeset	788 // looks for a private tag in its dictionary (cf. "Dictionary"
1f4910999fe7 Fix issue #168 (Plugins can't read private tags from the configuration file) Sebastien Jodogne <s.jodogne@gmail.com> parents: 3643 diff changeset	789 // option), or when it creates/modifies a DICOM file (new in Orthanc 1.6.0).
3736 0540b54324f1 StorageCommitmentReports Sebastien Jodogne <s.jodogne@gmail.com> parents: 3718 diff changeset	790 "DefaultPrivateCreator" : "",
0540b54324f1 StorageCommitmentReports Sebastien Jodogne <s.jodogne@gmail.com> parents: 3718 diff changeset	791
0540b54324f1 StorageCommitmentReports Sebastien Jodogne <s.jodogne@gmail.com> parents: 3718 diff changeset	792 // Maximum number of storage commitment reports (i.e. received from
0540b54324f1 StorageCommitmentReports Sebastien Jodogne <s.jodogne@gmail.com> parents: 3718 diff changeset	793 // remote modalities) to be kept in memory (new in Orthanc 1.6.0).
3894 8f7ad4989fec transcoding to uncompressed transfer syntaxes over DICOM protocol is implemented Sebastien Jodogne <s.jodogne@gmail.com> parents: 3852 diff changeset	794 "StorageCommitmentReportsSize" : 100,
8f7ad4989fec transcoding to uncompressed transfer syntaxes over DICOM protocol is implemented Sebastien Jodogne <s.jodogne@gmail.com> parents: 3852 diff changeset	795
8f7ad4989fec transcoding to uncompressed transfer syntaxes over DICOM protocol is implemented Sebastien Jodogne <s.jodogne@gmail.com> parents: 3852 diff changeset	796 // Whether Orthanc transcodes DICOM files to an uncompressed
3911 0ef7f4528be2 renamed option TranscodingEnabled to TranscodeDicomProtocol Sebastien Jodogne <s.jodogne@gmail.com> parents: 3894 diff changeset	797 // transfer syntax over the DICOM protocol, if the remote modality
0ef7f4528be2 renamed option TranscodingEnabled to TranscodeDicomProtocol Sebastien Jodogne <s.jodogne@gmail.com> parents: 3894 diff changeset	798 // does not support compressed transfer syntaxes (new in Orthanc 1.7.0).
3931 e6606d3ec892 new configuration option: BuiltinDecoderTranscoderOrder Sebastien Jodogne <s.jodogne@gmail.com> parents: 3911 diff changeset	799 "TranscodeDicomProtocol" : true,
e6606d3ec892 new configuration option: BuiltinDecoderTranscoderOrder Sebastien Jodogne <s.jodogne@gmail.com> parents: 3911 diff changeset	800
e6606d3ec892 new configuration option: BuiltinDecoderTranscoderOrder Sebastien Jodogne <s.jodogne@gmail.com> parents: 3911 diff changeset	801 // If some plugin to decode/transcode DICOM instances is installed,
e6606d3ec892 new configuration option: BuiltinDecoderTranscoderOrder Sebastien Jodogne <s.jodogne@gmail.com> parents: 3911 diff changeset	802 // this option specifies whether the built-in decoder/transcoder of
e6606d3ec892 new configuration option: BuiltinDecoderTranscoderOrder Sebastien Jodogne <s.jodogne@gmail.com> parents: 3911 diff changeset	803 // Orthanc (that uses DCMTK) is applied before or after the plugins,
3937 41eec97c23ef documented new primitives in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 3931 diff changeset	804 // or is not applied at all (new in Orthanc 1.7.0). The allowed
41eec97c23ef documented new primitives in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 3931 diff changeset	805 // values for this option are "After" (default value, corresponding
41eec97c23ef documented new primitives in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 3931 diff changeset	806 // to the behavior of Orthanc <= 1.6.1), "Before", or "Disabled".
3939 c205f670098e new configuration options: BuiltinDecoderTranscoderOrder and IngestTranscoding Sebastien Jodogne <s.jodogne@gmail.com> parents: 3937 diff changeset	807 "BuiltinDecoderTranscoderOrder" : "After",
c205f670098e new configuration options: BuiltinDecoderTranscoderOrder and IngestTranscoding Sebastien Jodogne <s.jodogne@gmail.com> parents: 3937 diff changeset	808
c205f670098e new configuration options: BuiltinDecoderTranscoderOrder and IngestTranscoding Sebastien Jodogne <s.jodogne@gmail.com> parents: 3937 diff changeset	809 // If this option is set, Orthanc will transparently transcode any
c205f670098e new configuration options: BuiltinDecoderTranscoderOrder and IngestTranscoding Sebastien Jodogne <s.jodogne@gmail.com> parents: 3937 diff changeset	810 // incoming DICOM instance to the given transfer syntax before
c205f670098e new configuration options: BuiltinDecoderTranscoderOrder and IngestTranscoding Sebastien Jodogne <s.jodogne@gmail.com> parents: 3937 diff changeset	811 // storing it into its database. Beware that this might result in
c205f670098e new configuration options: BuiltinDecoderTranscoderOrder and IngestTranscoding Sebastien Jodogne <s.jodogne@gmail.com> parents: 3937 diff changeset	812 // high CPU usage (if transcoding to some compressed transfer
c205f670098e new configuration options: BuiltinDecoderTranscoderOrder and IngestTranscoding Sebastien Jodogne <s.jodogne@gmail.com> parents: 3937 diff changeset	813 // syntax), or in higher disk consumption (if transcoding to an
c205f670098e new configuration options: BuiltinDecoderTranscoderOrder and IngestTranscoding Sebastien Jodogne <s.jodogne@gmail.com> parents: 3937 diff changeset	814 // uncompressed syntax). Also, beware that transcoding to a transfer
c205f670098e new configuration options: BuiltinDecoderTranscoderOrder and IngestTranscoding Sebastien Jodogne <s.jodogne@gmail.com> parents: 3937 diff changeset	815 // syntax with lossy compression (notably JPEG) will change the
c205f670098e new configuration options: BuiltinDecoderTranscoderOrder and IngestTranscoding Sebastien Jodogne <s.jodogne@gmail.com> parents: 3937 diff changeset	816 // "SOPInstanceUID" DICOM tag, and thus the Orthanc identifier at
c205f670098e new configuration options: BuiltinDecoderTranscoderOrder and IngestTranscoding Sebastien Jodogne <s.jodogne@gmail.com> parents: 3937 diff changeset	817 // the instance level, which might break external workflow.
c205f670098e new configuration options: BuiltinDecoderTranscoderOrder and IngestTranscoding Sebastien Jodogne <s.jodogne@gmail.com> parents: 3937 diff changeset	818 /**
c205f670098e new configuration options: BuiltinDecoderTranscoderOrder and IngestTranscoding Sebastien Jodogne <s.jodogne@gmail.com> parents: 3937 diff changeset	819 "IngestTranscoding" : "1.2.840.10008.1.2",
c205f670098e new configuration options: BuiltinDecoderTranscoderOrder and IngestTranscoding Sebastien Jodogne <s.jodogne@gmail.com> parents: 3937 diff changeset	820 **/
c205f670098e new configuration options: BuiltinDecoderTranscoderOrder and IngestTranscoding Sebastien Jodogne <s.jodogne@gmail.com> parents: 3937 diff changeset	821
4384 7e0d015ad109 new configuration options IngestTranscodingOfUncompressed and IngestTranscodingOfCompressed Sebastien Jodogne <s.jodogne@gmail.com> parents: 4382 diff changeset	822 // Whether ingest transcoding is applied to incoming DICOM instances
7e0d015ad109 new configuration options IngestTranscodingOfUncompressed and IngestTranscodingOfCompressed Sebastien Jodogne <s.jodogne@gmail.com> parents: 4382 diff changeset	823 // that have an uncompressed transfer syntax, i.e. Little Endian
7e0d015ad109 new configuration options IngestTranscodingOfUncompressed and IngestTranscodingOfCompressed Sebastien Jodogne <s.jodogne@gmail.com> parents: 4382 diff changeset	824 // Implicit, Little Endian Explicit or Big Endian Explicit (new in
7e0d015ad109 new configuration options IngestTranscodingOfUncompressed and IngestTranscodingOfCompressed Sebastien Jodogne <s.jodogne@gmail.com> parents: 4382 diff changeset	825 // Orthanc 1.8.2).
7e0d015ad109 new configuration options IngestTranscodingOfUncompressed and IngestTranscodingOfCompressed Sebastien Jodogne <s.jodogne@gmail.com> parents: 4382 diff changeset	826 "IngestTranscodingOfUncompressed" : true,
7e0d015ad109 new configuration options IngestTranscodingOfUncompressed and IngestTranscodingOfCompressed Sebastien Jodogne <s.jodogne@gmail.com> parents: 4382 diff changeset	827
7e0d015ad109 new configuration options IngestTranscodingOfUncompressed and IngestTranscodingOfCompressed Sebastien Jodogne <s.jodogne@gmail.com> parents: 4382 diff changeset	828 // Whether ingest transcoding is applied to incoming DICOM instances
7e0d015ad109 new configuration options IngestTranscodingOfUncompressed and IngestTranscodingOfCompressed Sebastien Jodogne <s.jodogne@gmail.com> parents: 4382 diff changeset	829 // that have a compressed transfer syntax (new in Orthanc 1.8.2).
7e0d015ad109 new configuration options IngestTranscodingOfUncompressed and IngestTranscodingOfCompressed Sebastien Jodogne <s.jodogne@gmail.com> parents: 4382 diff changeset	830 "IngestTranscodingOfCompressed" : true,
7e0d015ad109 new configuration options IngestTranscodingOfUncompressed and IngestTranscodingOfCompressed Sebastien Jodogne <s.jodogne@gmail.com> parents: 4382 diff changeset	831
3939 c205f670098e new configuration options: BuiltinDecoderTranscoderOrder and IngestTranscoding Sebastien Jodogne <s.jodogne@gmail.com> parents: 3937 diff changeset	832 // The compression level that is used when transcoding to one of the
c205f670098e new configuration options: BuiltinDecoderTranscoderOrder and IngestTranscoding Sebastien Jodogne <s.jodogne@gmail.com> parents: 3937 diff changeset	833 // lossy/JPEG transfer syntaxes (integer between 1 and 100).
4185 b289a1234822 giving a try to cross-platform compilation of SyncStorageArea Sebastien Jodogne <s.jodogne@gmail.com> parents: 4178 diff changeset	834 "DicomLossyTranscodingQuality" : 90,
b289a1234822 giving a try to cross-platform compilation of SyncStorageArea Sebastien Jodogne <s.jodogne@gmail.com> parents: 4178 diff changeset	835
b289a1234822 giving a try to cross-platform compilation of SyncStorageArea Sebastien Jodogne <s.jodogne@gmail.com> parents: 4178 diff changeset	836 // Whether "fsync()" is called after each write to the storage area
b289a1234822 giving a try to cross-platform compilation of SyncStorageArea Sebastien Jodogne <s.jodogne@gmail.com> parents: 4178 diff changeset	837 // (new in Orthanc 1.7.4). If this option is set to "true", Orthanc
b289a1234822 giving a try to cross-platform compilation of SyncStorageArea Sebastien Jodogne <s.jodogne@gmail.com> parents: 4178 diff changeset	838 // will run more slowly, but the DICOM are guaranteed to be
4187 a8d2f4e65f05 clarification to configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4185 diff changeset	839 // immediately written to the disk. This option only makes sense if
a8d2f4e65f05 clarification to configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4185 diff changeset	840 // the builtin filesystem storage area is used. It defaults to
a8d2f4e65f05 clarification to configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4185 diff changeset	841 // "false" in Orthanc <= 1.7.3, and to "true" in Orthanc >= 1.7.4.
4366 6a39ca7083b9 New config option "MallocArenaMax" to control memory usage on GNU/Linux Sebastien Jodogne <s.jodogne@gmail.com> parents: 4340 diff changeset	842 "SyncStorageArea" : true,
6a39ca7083b9 New config option "MallocArenaMax" to control memory usage on GNU/Linux Sebastien Jodogne <s.jodogne@gmail.com> parents: 4340 diff changeset	843
6a39ca7083b9 New config option "MallocArenaMax" to control memory usage on GNU/Linux Sebastien Jodogne <s.jodogne@gmail.com> parents: 4340 diff changeset	844 // If specified, on compatible systems, call "mallopt(M_ARENA_MAX,
6a39ca7083b9 New config option "MallocArenaMax" to control memory usage on GNU/Linux Sebastien Jodogne <s.jodogne@gmail.com> parents: 4340 diff changeset	845 // ...)" while starting Orthanc. This has the same effect at setting
6a39ca7083b9 New config option "MallocArenaMax" to control memory usage on GNU/Linux Sebastien Jodogne <s.jodogne@gmail.com> parents: 4340 diff changeset	846 // the environment variable "MALLOC_ARENA_MAX". This avoids large
6a39ca7083b9 New config option "MallocArenaMax" to control memory usage on GNU/Linux Sebastien Jodogne <s.jodogne@gmail.com> parents: 4340 diff changeset	847 // growth in RES memory if the threads of the embedded HTTP server
6a39ca7083b9 New config option "MallocArenaMax" to control memory usage on GNU/Linux Sebastien Jodogne <s.jodogne@gmail.com> parents: 4340 diff changeset	848 // have to allocate large chunks of memory (typically the case with
6a39ca7083b9 New config option "MallocArenaMax" to control memory usage on GNU/Linux Sebastien Jodogne <s.jodogne@gmail.com> parents: 4340 diff changeset	849 // large DICOM files). By setting "MallocArenaMax" to "N", these
6a39ca7083b9 New config option "MallocArenaMax" to control memory usage on GNU/Linux Sebastien Jodogne <s.jodogne@gmail.com> parents: 4340 diff changeset	850 // threads share "N" memory pools (known as "arenas"). Setting this
6a39ca7083b9 New config option "MallocArenaMax" to control memory usage on GNU/Linux Sebastien Jodogne <s.jodogne@gmail.com> parents: 4340 diff changeset	851 // option to "0" doesn't call mallopt()", which was the behavior of
6a39ca7083b9 New config option "MallocArenaMax" to control memory usage on GNU/Linux Sebastien Jodogne <s.jodogne@gmail.com> parents: 4340 diff changeset	852 // Orthanc <= 1.8.1.
4376 b002f9abe802 review of changeset 4375:208029732d51 Sebastien Jodogne <s.jodogne@gmail.com> parents: 4375 diff changeset	853 "MallocArenaMax" : 5,
4375 208029732d51 New config option "DeidentifyDimseQueryLogs" Mark Poscablo <Mark.Poscablo@varian.com> parents: 4366 diff changeset	854
4474 f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4465 diff changeset	855 // Deidentify/anonymize the contents of the logs (notably C-FIND,
f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4465 diff changeset	856 // C-GET, and C-MOVE queries submitted to Orthanc) according to
4376 b002f9abe802 review of changeset 4375:208029732d51 Sebastien Jodogne <s.jodogne@gmail.com> parents: 4375 diff changeset	857 // Table E.1-1 of the DICOM standard (new in Orthanc 1.8.2)
b002f9abe802 review of changeset 4375:208029732d51 Sebastien Jodogne <s.jodogne@gmail.com> parents: 4375 diff changeset	858 "DeidentifyLogs" : true,
4375 208029732d51 New config option "DeidentifyDimseQueryLogs" Mark Poscablo <Mark.Poscablo@varian.com> parents: 4366 diff changeset	859
4424 83371ccdfe80 openapi documentation is now completed Sebastien Jodogne <s.jodogne@gmail.com> parents: 4411 diff changeset	860 // If "DeidentifyLogs" is true, this sets the DICOM standard to
83371ccdfe80 openapi documentation is now completed Sebastien Jodogne <s.jodogne@gmail.com> parents: 4411 diff changeset	861 // follow for the deidentification/anonymization of the query
5334 5b2a5cc64cb1 upgraded anonymization to Basic Profile of PS 3.15-2023b Table E.1-1 Sebastien Jodogne <s.jodogne@gmail.com> parents: 5255 diff changeset	862 // contents. Possible values are "2008", "2017c", "2021b" (new
5b2a5cc64cb1 upgraded anonymization to Basic Profile of PS 3.15-2023b Table E.1-1 Sebastien Jodogne <s.jodogne@gmail.com> parents: 5255 diff changeset	863 // in Orthanc 1.8.2), and "2023b" (new in Orthanc 1.12.1)
5b2a5cc64cb1 upgraded anonymization to Basic Profile of PS 3.15-2023b Table E.1-1 Sebastien Jodogne <s.jodogne@gmail.com> parents: 5255 diff changeset	864 "DeidentifyLogsDicomVersion" : "2023b",
4451 f4dbdb2dcba6 new configuration option "MaximumPduLength" to tune the maximum PDU length Sebastien Jodogne <s.jodogne@gmail.com> parents: 4438 diff changeset	865
f4dbdb2dcba6 new configuration option "MaximumPduLength" to tune the maximum PDU length Sebastien Jodogne <s.jodogne@gmail.com> parents: 4438 diff changeset	866 // Maximum length of the PDU (Protocol Data Unit) in the DICOM
f4dbdb2dcba6 new configuration option "MaximumPduLength" to tune the maximum PDU length Sebastien Jodogne <s.jodogne@gmail.com> parents: 4438 diff changeset	867 // network protocol, expressed in bytes. This value affects both
f4dbdb2dcba6 new configuration option "MaximumPduLength" to tune the maximum PDU length Sebastien Jodogne <s.jodogne@gmail.com> parents: 4438 diff changeset	868 // Orthanc SCU and Orthanc SCP. It defaults to 16KB. The allowed
f4dbdb2dcba6 new configuration option "MaximumPduLength" to tune the maximum PDU length Sebastien Jodogne <s.jodogne@gmail.com> parents: 4438 diff changeset	869 // range is [4096,131072]. (new in Orthanc 1.9.0)
4623 95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4604 diff changeset	870 "MaximumPduLength" : 16384,
4604 2c702cfae274 New option "DatabaseServerIdentifier" to identify the server among a pool of Orthanc servers Sebastien Jodogne <s.jodogne@gmail.com> parents: 4522 diff changeset	871
2c702cfae274 New option "DatabaseServerIdentifier" to identify the server among a pool of Orthanc servers Sebastien Jodogne <s.jodogne@gmail.com> parents: 4522 diff changeset	872 // Arbitrary identifier of this Orthanc server when storing its
4623 95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4604 diff changeset	873 // global properties if a custom index plugin is used. This
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4604 diff changeset	874 // identifier is only useful in the case of multiple
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4604 diff changeset	875 // readers/writers, in order to avoid collisions between multiple
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4604 diff changeset	876 // Orthanc servers. If unset, this identifier is taken as a SHA-1
4751 b3957ddd88f1 typos Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	877 // hash derived from the MAC addresses of the network interfaces,
4623 95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4604 diff changeset	878 // and from the AET and TCP ports used by Orthanc. Manually setting
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4604 diff changeset	879 // this option is needed in Docker/Kubernetes environments. (new in
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4604 diff changeset	880 // Orthanc 1.9.2)
4604 2c702cfae274 New option "DatabaseServerIdentifier" to identify the server among a pool of Orthanc servers Sebastien Jodogne <s.jodogne@gmail.com> parents: 4522 diff changeset	881 /**
4623 95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4604 diff changeset	882 "DatabaseServerIdentifier" : "Orthanc1",
4604 2c702cfae274 New option "DatabaseServerIdentifier" to identify the server among a pool of Orthanc servers Sebastien Jodogne <s.jodogne@gmail.com> parents: 4522 diff changeset	883 **/
4623 95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4604 diff changeset	884
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4604 diff changeset	885 // Whether Orthanc protects the modification of metadata and
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4604 diff changeset	886 // attachments using revisions, which is done using the HTTP headers
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4604 diff changeset	887 // "ETag", "If-Match" and "If-None-Match" in the calls to the REST
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4604 diff changeset	888 // API. This is needed to handle collisions between concurrent
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4604 diff changeset	889 // modifications in the case of multiple writers. The database
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4604 diff changeset	890 // back-end must support this option, which is notably not yet the
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4604 diff changeset	891 // case of the built-in SQLite index. (new in Orthanc 1.9.2)
4674 cdab941fe17d ZIP archive/media generated in synchronous mode are now streamed by default Sebastien Jodogne <s.jodogne@gmail.com> parents: 4656 diff changeset	892 "CheckRevisions" : false,
cdab941fe17d ZIP archive/media generated in synchronous mode are now streamed by default Sebastien Jodogne <s.jodogne@gmail.com> parents: 4656 diff changeset	893
cdab941fe17d ZIP archive/media generated in synchronous mode are now streamed by default Sebastien Jodogne <s.jodogne@gmail.com> parents: 4656 diff changeset	894 // Whether Orthanc streams ZIP archive/media to the HTTP
cdab941fe17d ZIP archive/media generated in synchronous mode are now streamed by default Sebastien Jodogne <s.jodogne@gmail.com> parents: 4656 diff changeset	895 // client. Setting this option to "false" corresponds to the
cdab941fe17d ZIP archive/media generated in synchronous mode are now streamed by default Sebastien Jodogne <s.jodogne@gmail.com> parents: 4656 diff changeset	896 // behavior of Orthanc <= 1.9.3: The ZIP is first entirely written
cdab941fe17d ZIP archive/media generated in synchronous mode are now streamed by default Sebastien Jodogne <s.jodogne@gmail.com> parents: 4656 diff changeset	897 // to a temporary file, then sent to the client (which necessitates
cdab941fe17d ZIP archive/media generated in synchronous mode are now streamed by default Sebastien Jodogne <s.jodogne@gmail.com> parents: 4656 diff changeset	898 // disk space and might lead to HTTP timeouts on large archives). If
cdab941fe17d ZIP archive/media generated in synchronous mode are now streamed by default Sebastien Jodogne <s.jodogne@gmail.com> parents: 4656 diff changeset	899 // set to "true", the chunks of the ZIP file are progressively sent
cdab941fe17d ZIP archive/media generated in synchronous mode are now streamed by default Sebastien Jodogne <s.jodogne@gmail.com> parents: 4656 diff changeset	900 // as soon as one DICOM file gets compressed (new in Orthanc 1.9.4)
4797 4e765c18ace7 enable using multiple threads to load instances when generating zip archive/media Alain Mazy <am@osimis.io> parents: 4792 diff changeset	901 "SynchronousZipStream" : true,
4e765c18ace7 enable using multiple threads to load instances when generating zip archive/media Alain Mazy <am@osimis.io> parents: 4792 diff changeset	902
4e765c18ace7 enable using multiple threads to load instances when generating zip archive/media Alain Mazy <am@osimis.io> parents: 4792 diff changeset	903 // Default number of loader threads when generating Zip archive/media.
4e765c18ace7 enable using multiple threads to load instances when generating zip archive/media Alain Mazy <am@osimis.io> parents: 4792 diff changeset	904 // A value of 0 means reading and writing are performed in sequence
4798 96ab170294fd typo Alain Mazy <am@osimis.io> parents: 4797 diff changeset	905 // (default behaviour). A value > 1 is meaningful only if the storage
4797 4e765c18ace7 enable using multiple threads to load instances when generating zip archive/media Alain Mazy <am@osimis.io> parents: 4792 diff changeset	906 // is a distributed network storage (e.g object storage plugin).
4918 eb23e13f8b0e experimental feature: zip loader threads Alain Mazy <am@osimis.io> parents: 4912 diff changeset	907 // (new experimental feature in Orthanc 1.10.0)
4934 94a7b681b340 added configuration for extra main dicom tags + save signature in metadata + show warning if inconsistent main dicom tags Alain Mazy <am@osimis.io> parents: 4930 diff changeset	908 "ZipLoaderThreads": 0,
94a7b681b340 added configuration for extra main dicom tags + save signature in metadata + show warning if inconsistent main dicom tags Alain Mazy <am@osimis.io> parents: 4930 diff changeset	909
94a7b681b340 added configuration for extra main dicom tags + save signature in metadata + show warning if inconsistent main dicom tags Alain Mazy <am@osimis.io> parents: 4930 diff changeset	910 // Extra Main Dicom tags that are stored in DB together with all default
5130 f2dcdbe05884 ResourceModification jobs can now use multiple threads Alain Mazy <am@osimis.io> parents: 5119 diff changeset	911 // Main Dicom tags that are already stored.
5432 59e3b6f8c5be migration to UCLouvain servers Sebastien Jodogne <s.jodogne@gmail.com> parents: 5419 diff changeset	912 // see https://orthanc.uclouvain.be/book/faq/main-dicom-tags.html
4934 94a7b681b340 added configuration for extra main dicom tags + save signature in metadata + show warning if inconsistent main dicom tags Alain Mazy <am@osimis.io> parents: 4930 diff changeset	913 // (new in Orthanc 1.11.0)
4944 f377d5643538 new Warnings configuration + InstanceAvailability tag Alain Mazy <am@osimis.io> parents: 4934 diff changeset	914 // Sequences tags are not supported.
4934 94a7b681b340 added configuration for extra main dicom tags + save signature in metadata + show warning if inconsistent main dicom tags Alain Mazy <am@osimis.io> parents: 4930 diff changeset	915 /**
94a7b681b340 added configuration for extra main dicom tags + save signature in metadata + show warning if inconsistent main dicom tags Alain Mazy <am@osimis.io> parents: 4930 diff changeset	916 "ExtraMainDicomTags" : {
94a7b681b340 added configuration for extra main dicom tags + save signature in metadata + show warning if inconsistent main dicom tags Alain Mazy <am@osimis.io> parents: 4930 diff changeset	917 "Instance" : [
94a7b681b340 added configuration for extra main dicom tags + save signature in metadata + show warning if inconsistent main dicom tags Alain Mazy <am@osimis.io> parents: 4930 diff changeset	918 "Rows",
94a7b681b340 added configuration for extra main dicom tags + save signature in metadata + show warning if inconsistent main dicom tags Alain Mazy <am@osimis.io> parents: 4930 diff changeset	919 "Columns",
94a7b681b340 added configuration for extra main dicom tags + save signature in metadata + show warning if inconsistent main dicom tags Alain Mazy <am@osimis.io> parents: 4930 diff changeset	920 "ImageType",
94a7b681b340 added configuration for extra main dicom tags + save signature in metadata + show warning if inconsistent main dicom tags Alain Mazy <am@osimis.io> parents: 4930 diff changeset	921 "SOPClassUID",
94a7b681b340 added configuration for extra main dicom tags + save signature in metadata + show warning if inconsistent main dicom tags Alain Mazy <am@osimis.io> parents: 4930 diff changeset	922 "ContentDate",
94a7b681b340 added configuration for extra main dicom tags + save signature in metadata + show warning if inconsistent main dicom tags Alain Mazy <am@osimis.io> parents: 4930 diff changeset	923 "ContentTime",
94a7b681b340 added configuration for extra main dicom tags + save signature in metadata + show warning if inconsistent main dicom tags Alain Mazy <am@osimis.io> parents: 4930 diff changeset	924 "FrameOfReferenceUID",
94a7b681b340 added configuration for extra main dicom tags + save signature in metadata + show warning if inconsistent main dicom tags Alain Mazy <am@osimis.io> parents: 4930 diff changeset	925 "PixelSpacing",
94a7b681b340 added configuration for extra main dicom tags + save signature in metadata + show warning if inconsistent main dicom tags Alain Mazy <am@osimis.io> parents: 4930 diff changeset	926 "SpecificCharacterSet",
94a7b681b340 added configuration for extra main dicom tags + save signature in metadata + show warning if inconsistent main dicom tags Alain Mazy <am@osimis.io> parents: 4930 diff changeset	927 "BitsAllocated"
94a7b681b340 added configuration for extra main dicom tags + save signature in metadata + show warning if inconsistent main dicom tags Alain Mazy <am@osimis.io> parents: 4930 diff changeset	928 ],
94a7b681b340 added configuration for extra main dicom tags + save signature in metadata + show warning if inconsistent main dicom tags Alain Mazy <am@osimis.io> parents: 4930 diff changeset	929 "Series" : [],
94a7b681b340 added configuration for extra main dicom tags + save signature in metadata + show warning if inconsistent main dicom tags Alain Mazy <am@osimis.io> parents: 4930 diff changeset	930 "Study": [],
94a7b681b340 added configuration for extra main dicom tags + save signature in metadata + show warning if inconsistent main dicom tags Alain Mazy <am@osimis.io> parents: 4930 diff changeset	931 "Patient": []
94a7b681b340 added configuration for extra main dicom tags + save signature in metadata + show warning if inconsistent main dicom tags Alain Mazy <am@osimis.io> parents: 4930 diff changeset	932 },
94a7b681b340 added configuration for extra main dicom tags + save signature in metadata + show warning if inconsistent main dicom tags Alain Mazy <am@osimis.io> parents: 4930 diff changeset	933 */
94a7b681b340 added configuration for extra main dicom tags + save signature in metadata + show warning if inconsistent main dicom tags Alain Mazy <am@osimis.io> parents: 4930 diff changeset	934
4944 f377d5643538 new Warnings configuration + InstanceAvailability tag Alain Mazy <am@osimis.io> parents: 4934 diff changeset	935 // Enables/disables warnings in the logs.
f377d5643538 new Warnings configuration + InstanceAvailability tag Alain Mazy <am@osimis.io> parents: 4934 diff changeset	936 // "true" enables a warning. All warnings are enabled by default
5432 59e3b6f8c5be migration to UCLouvain servers Sebastien Jodogne <s.jodogne@gmail.com> parents: 5419 diff changeset	937 // see https://orthanc.uclouvain.be/book/faq/main-dicom-tags.html#warnings
4934 94a7b681b340 added configuration for extra main dicom tags + save signature in metadata + show warning if inconsistent main dicom tags Alain Mazy <am@osimis.io> parents: 4930 diff changeset	938 // (new in Orthanc 1.11.0)
4944 f377d5643538 new Warnings configuration + InstanceAvailability tag Alain Mazy <am@osimis.io> parents: 4934 diff changeset	939 "Warnings" : {
f377d5643538 new Warnings configuration + InstanceAvailability tag Alain Mazy <am@osimis.io> parents: 4934 diff changeset	940 // A "RequestedTags" has been read from storage which is slower than
f377d5643538 new Warnings configuration + InstanceAvailability tag Alain Mazy <am@osimis.io> parents: 4934 diff changeset	941 // reading it from DB.
f377d5643538 new Warnings configuration + InstanceAvailability tag Alain Mazy <am@osimis.io> parents: 4934 diff changeset	942 // You might want to store this tag in ExtraMainDicomTags to build
f377d5643538 new Warnings configuration + InstanceAvailability tag Alain Mazy <am@osimis.io> parents: 4934 diff changeset	943 // the response faster.
f377d5643538 new Warnings configuration + InstanceAvailability tag Alain Mazy <am@osimis.io> parents: 4934 diff changeset	944 "W001_TagsBeingReadFromStorage": true,
f377d5643538 new Warnings configuration + InstanceAvailability tag Alain Mazy <am@osimis.io> parents: 4934 diff changeset	945
f377d5643538 new Warnings configuration + InstanceAvailability tag Alain Mazy <am@osimis.io> parents: 4934 diff changeset	946 // Retrieving a list of Main dicom tags from a resource that has been
f377d5643538 new Warnings configuration + InstanceAvailability tag Alain Mazy <am@osimis.io> parents: 4934 diff changeset	947 // saved with another "ExtraMainDicomTags" configuration which means that
f377d5643538 new Warnings configuration + InstanceAvailability tag Alain Mazy <am@osimis.io> parents: 4934 diff changeset	948 // your response might be incomplete/inconsistent.
f377d5643538 new Warnings configuration + InstanceAvailability tag Alain Mazy <am@osimis.io> parents: 4934 diff changeset	949 // You should call patients\|studies\|series\|instances/../reconstruct to rebuild
5130 f2dcdbe05884 ResourceModification jobs can now use multiple threads Alain Mazy <am@osimis.io> parents: 5119 diff changeset	950 // the DB. You may also check for the "Housekeeper" plugin
4944 f377d5643538 new Warnings configuration + InstanceAvailability tag Alain Mazy <am@osimis.io> parents: 4934 diff changeset	951 "W002_InconsistentDicomTagsInDb": true
f377d5643538 new Warnings configuration + InstanceAvailability tag Alain Mazy <am@osimis.io> parents: 4934 diff changeset	952 }
4934 94a7b681b340 added configuration for extra main dicom tags + save signature in metadata + show warning if inconsistent main dicom tags Alain Mazy <am@osimis.io> parents: 4930 diff changeset	953
683 7bc5ccc550a1 switch from DOS to UNIX end of lines Sebastien Jodogne <s.jodogne@gmail.com> parents: 665 diff changeset	954 }

Mercurial > hg > orthanc

annotate OrthancServer/Resources/Configuration.json @ 5611:1a995c6f9dae default