annotate OrthancServer/Resources/Configuration.json @ 4727:72e338b11548

todo
author Sebastien Jodogne <s.jodogne@gmail.com>
date Fri, 25 Jun 2021 08:44:18 +0200
parents facea16b055b
children b3957ddd88f1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
4 **/
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
5
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
6 // 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
7 // 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
8 "Name" : "MyOrthanc",
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
9
2229
0f09c1d18584 note about backslashes
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2208
diff changeset
10 // 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
11 // raw DICOM instances). Backslashes must be either escaped by
0f09c1d18584 note about backslashes
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2208
diff changeset
12 // 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
13 "StorageDirectory" : "OrthancStorage",
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 SQLite index (if unset, the
0f09c1d18584 note about backslashes
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2208
diff changeset
16 // 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
17 // 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
18 "IndexDirectory" : "OrthancStorage",
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
19
3181
6fd38327e777 Fix issue #130 (Orthanc failed to start when /tmp partition was full)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3180
diff changeset
20 // 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
21 // 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
22 // Orthanc is stopped. The folder must exist. The corresponding
3183
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3181
diff changeset
23 // filesystem must be properly sized, given that for instance a ZIP
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3181
diff changeset
24 // archive of DICOM images created by a job can weight several GBs,
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3181
diff changeset
25 // and that there might be up to "min(JobsHistorySize,
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3181
diff changeset
26 // 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
27 // 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
28 // 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
29 // "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
30 // "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
31
683
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
32 // 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
33 "StorageCompression" : false,
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
34
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
35 // 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
36 // limit on the storage size)
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
37 "MaximumStorageSize" : 0,
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
38
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
39 // 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
40 // 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
41 // of patients)
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
42 "MaximumPatientCount" : 0,
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
43
893
f57802f8b4dc plugins for windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 891
diff changeset
44 // 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
45 // 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
46 "LuaScripts" : [
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
47 ],
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
48
893
f57802f8b4dc plugins for windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 891
diff changeset
49 // 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
50 // 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
51 // "./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
52 // 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
53 // find shared libraries. Backslashes must be either escaped by
0f09c1d18584 note about backslashes
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2208
diff changeset
54 // doubling them, or replaced by forward slashes "/".
891
d0a08d8881b7 configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 732
diff changeset
55 "Plugins" : [
d0a08d8881b7 configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 732
diff changeset
56 ],
683
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
57
2736
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2685
diff changeset
58 // Maximum number of processing jobs that are simultaneously running
2570
2e879c796ec7 JobsRegistry::SubmitAndWait(), StoreScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2375
diff changeset
59 // 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
60 // 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
61 // this value to "1".
2e879c796ec7 JobsRegistry::SubmitAndWait(), StoreScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2375
diff changeset
62 "ConcurrentJobs" : 2,
683
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
63
1592
d73124f6b439 configuration option HttpDescribeErrors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1590
diff changeset
64
683
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
65 /**
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
66 * Configuration of the HTTP server
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
67 **/
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
68
1592
d73124f6b439 configuration option HttpDescribeErrors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1590
diff changeset
69 // 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
70 // 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
71 // Explorer will not be available.
d73124f6b439 configuration option HttpDescribeErrors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1590
diff changeset
72 "HttpServerEnabled" : true,
d73124f6b439 configuration option HttpDescribeErrors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1590
diff changeset
73
4379
85b5b0e1bac9 added NEWS about "OrthancExplorerEnabled" option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4378
diff changeset
74 // 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
75 // 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
76 // 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
77 "OrthancExplorerEnabled" : true,
9e2fc6911ac8 adding option to disable orthance explorer when http server is enabled
Andrew Wallis <andrew.wallis@varian.com>>
parents: 4376
diff changeset
78
683
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
79 // 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
80 "HttpPort" : 8042,
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
81
1592
d73124f6b439 configuration option HttpDescribeErrors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1590
diff changeset
82 // 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
83 // 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
84 // 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
85 // HTTP client does not properly handles such answers.
d73124f6b439 configuration option HttpDescribeErrors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1590
diff changeset
86 "HttpDescribeErrors" : true,
d73124f6b439 configuration option HttpDescribeErrors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1590
diff changeset
87
d73124f6b439 configuration option HttpDescribeErrors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1590
diff changeset
88 // Enable HTTP compression to improve network bandwidth utilization,
d73124f6b439 configuration option HttpDescribeErrors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1590
diff changeset
89 // at the expense of more computations on the server. Orthanc
d73124f6b439 configuration option HttpDescribeErrors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1590
diff changeset
90 // supports the "gzip" and "deflate" HTTP encodings.
d73124f6b439 configuration option HttpDescribeErrors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1590
diff changeset
91 "HttpCompressionEnabled" : true,
d73124f6b439 configuration option HttpDescribeErrors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1590
diff changeset
92
4243
64f57c9d5f79 configuration options for webdav
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4209
diff changeset
93 // 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
94 // 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
95 // share is mapped as "http://localhost:8042/webdav/".
64f57c9d5f79 configuration options for webdav
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4209
diff changeset
96 "WebDavEnabled" : true,
64f57c9d5f79 configuration options for webdav
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4209
diff changeset
97
64f57c9d5f79 configuration options for webdav
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4209
diff changeset
98 // 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
99 // 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
100 "WebDavDeleteAllowed" : false,
64f57c9d5f79 configuration options for webdav
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4209
diff changeset
101
64f57c9d5f79 configuration options for webdav
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4209
diff changeset
102 // Whether to allow uploads through the WebDAV share.
64f57c9d5f79 configuration options for webdav
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4209
diff changeset
103 "WebDavUploadAllowed" : true,
64f57c9d5f79 configuration options for webdav
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4209
diff changeset
104
683
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
105
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 /**
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
108 * Configuration of the DICOM server
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
109 **/
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
110
1592
d73124f6b439 configuration option HttpDescribeErrors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1590
diff changeset
111 // 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
112 // 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
113 // 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
114 "DicomServerEnabled" : true,
d73124f6b439 configuration option HttpDescribeErrors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1590
diff changeset
115
3582
d00a803d1802 some additional info about AET in the default config file
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3561
diff changeset
116 // 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
117 // characters)
683
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
118 "DicomAet" : "ORTHANC",
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
119
2352
3ab96768d144 Fix issue 52 (DICOM level security association problems)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2334
diff changeset
120 // 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
121 // 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
122 "DicomCheckCalledAet" : false,
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
123
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
124 // The DICOM port
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
125 "DicomPort" : 4242,
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
126
1115
da56a7916e8a Experimental "KeepAlive" configuration option to enable HTTP Keep-Alive
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1090
diff changeset
127 // The default encoding that is assumed for DICOM files without
2203
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2184
diff changeset
128 // "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
129 // 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
130 // "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
131 // "Latin5", "Cyrillic", "Windows1251", "Arabic", "Greek", "Hebrew",
3226
45e1631febbb support of simplified chinese
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3218
diff changeset
132 // "Thai", "Japanese", "Chinese", "JapaneseKanji", "Korean", and
45e1631febbb support of simplified chinese
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3218
diff changeset
133 // "SimplifiedChinese".
1115
da56a7916e8a Experimental "KeepAlive" configuration option to enable HTTP Keep-Alive
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1090
diff changeset
134 "DefaultEncoding" : "Latin1",
da56a7916e8a Experimental "KeepAlive" configuration option to enable HTTP Keep-Alive
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1090
diff changeset
135
4474
f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4465
diff changeset
136 // 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
137 // 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
138 // 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
139 // 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
140 "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
141
4474
f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4465
diff changeset
142 // 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
143 // 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
144 // "AcceptedTransferSyntaxes" option has been applied (if present).
f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4465
diff changeset
145 /**
f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4465
diff changeset
146 "DeflatedTransferSyntaxAccepted" : true,
f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4465
diff changeset
147 "JpegTransferSyntaxAccepted" : true,
f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4465
diff changeset
148 "Jpeg2000TransferSyntaxAccepted" : true,
f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4465
diff changeset
149 "JpegLosslessTransferSyntaxAccepted" : true,
f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4465
diff changeset
150 "JpipTransferSyntaxAccepted" : true,
f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4465
diff changeset
151 "Mpeg2TransferSyntaxAccepted" : true,
f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4465
diff changeset
152 "RleTransferSyntaxAccepted" : true,
f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4465
diff changeset
153 "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
154 "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
155 **/
f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4465
diff changeset
156
f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4465
diff changeset
157 // 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
158 // SOP classes (aka. "promiscuous mode")
4474
f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4465
diff changeset
159 "UnknownSopClassAccepted" : false,
1806
cd213ebcaefd UnknownSopClassAccepted option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1772
diff changeset
160
2069
fabf7820d1f1 New configuration options: "DicomScuTimeout" and "DicomScpTimeout" + validation of non-negative options
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2039
diff changeset
161 // 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
162 // 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
163 // 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
164 "DicomScpTimeout" : 30,
fabf7820d1f1 New configuration options: "DicomScuTimeout" and "DicomScpTimeout" + validation of non-negative options
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2039
diff changeset
165
683
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
166
1592
d73124f6b439 configuration option HttpDescribeErrors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1590
diff changeset
167
683
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
168 /**
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
169 * 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
170 **/
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
171
3506
d2b9981017c4 better handling of HTTP security
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3500
diff changeset
172 // 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
173 "RemoteAccessAllowed" : false,
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
174
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
175 // 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
176 "SslEnabled" : false,
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
177
4197
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4190
diff changeset
178 // Path to the SSL certificate used by the HTTP server. The file
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4190
diff changeset
179 // must be stored in the PEM format, and must contain both the
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4190
diff changeset
180 // certificate and the private key. This option is only meaningful
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4190
diff changeset
181 // if "SslEnabled" is true.
683
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
182 "SslCertificate" : "certificate.pem",
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
183
4381
df313e410f0c Add support to configure minimimum accepted TLS version and cipher suite
Andrew Wallis <andrew.wallis@varian.com>>
parents: 4379
diff changeset
184 // Sets the minimum accepted SSL protocol version
4382
3aacd2bd8bbc review changeset 4381:df313e410f0c
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4381
diff changeset
185 // (cf. "ssl_protocol_version" option of civetweb). By default,
3aacd2bd8bbc review changeset 4381:df313e410f0c
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4381
diff changeset
186 // 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
187 // is true. (new in Orthanc 1.8.2)
3aacd2bd8bbc review changeset 4381:df313e410f0c
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4381
diff changeset
188 //
3aacd2bd8bbc review changeset 4381:df313e410f0c
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4381
diff changeset
189 // Value => Protocols
3aacd2bd8bbc review changeset 4381:df313e410f0c
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4381
diff changeset
190 // 0 SSL2+SSL3+TLS1.0+TLS1.1+TLS1.2
3aacd2bd8bbc review changeset 4381:df313e410f0c
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4381
diff changeset
191 // 1 SSL3+TLS1.0+TLS1.1+TLS1.2
3aacd2bd8bbc review changeset 4381:df313e410f0c
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4381
diff changeset
192 // 2 TLS1.0+TLS1.1+TLS1.2
3aacd2bd8bbc review changeset 4381:df313e410f0c
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4381
diff changeset
193 // 3 TLS1.1+TLS1.2
3aacd2bd8bbc review changeset 4381:df313e410f0c
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4381
diff changeset
194 // 4 TLS1.2
3aacd2bd8bbc review changeset 4381:df313e410f0c
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4381
diff changeset
195 "SslMinimumProtocolVersion" : 4,
3aacd2bd8bbc review changeset 4381:df313e410f0c
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4381
diff changeset
196
3aacd2bd8bbc review changeset 4381:df313e410f0c
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4381
diff changeset
197 // 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
198 // 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
199 // 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
200 // "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
201 /**
4382
3aacd2bd8bbc review changeset 4381:df313e410f0c
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4381
diff changeset
202 "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
203 **/
df313e410f0c Add support to configure minimimum accepted TLS version and cipher suite
Andrew Wallis <andrew.wallis@varian.com>>
parents: 4379
diff changeset
204
4197
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4190
diff changeset
205 // Whether or not peer client certificates shall be checked. This
4209
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4197
diff changeset
206 // 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
207 "SslVerifyPeers" : false,
9ce5c89328f5 New configuration options to enable HTTP peers identification through certificates
Alain Mazy <alain@mazy.be>
parents: 4187
diff changeset
208
4197
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4190
diff changeset
209 // Path to a file containing the concatenation of the client SSL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4190
diff changeset
210 // certificate(s) that are trusted to verify the identify of remote
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4190
diff changeset
211 // HTTP clients. The individual certificate(s) must be stored in the
4209
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4197
diff changeset
212 // PEM format. This option is only meaningful if "SslVerifyPeers"
4197
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4190
diff changeset
213 // is true.
4190
9ce5c89328f5 New configuration options to enable HTTP peers identification through certificates
Alain Mazy <alain@mazy.be>
parents: 4187
diff changeset
214 "SslTrustedClientCertificates" : "trustedClientCertificates.pem",
9ce5c89328f5 New configuration options to enable HTTP peers identification through certificates
Alain Mazy <alain@mazy.be>
parents: 4187
diff changeset
215
3506
d2b9981017c4 better handling of HTTP security
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3500
diff changeset
216 // 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
217 // 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
218 // "AuthenticationEnabled" is not explicitly set, authentication is
d2b9981017c4 better handling of HTTP security
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3500
diff changeset
219 // 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
220 // "AuthenticationEnabled" equals that of "RemoteAccessAllowed").
d2b9981017c4 better handling of HTTP security
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3500
diff changeset
221 /**
d2b9981017c4 better handling of HTTP security
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3500
diff changeset
222 "AuthenticationEnabled" : false,
d2b9981017c4 better handling of HTTP security
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3500
diff changeset
223 **/
683
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
224
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
225 // 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
226 // 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
227 "RegisteredUsers" : {
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
228 // "alice" : "alicePassword"
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
229 },
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
230
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
231
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
232
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
233 /**
4438
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4424
diff changeset
234 * 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
235 **/
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4424
diff changeset
236
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4424
diff changeset
237 // 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
238 "DicomTlsEnabled" : false,
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4424
diff changeset
239
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4424
diff changeset
240 // 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
241 // 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
242 // (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
243 // "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
244 // 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
245 /**
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4424
diff changeset
246 "DicomTlsCertificate" : "orthanc.crt",
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4424
diff changeset
247 **/
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4424
diff changeset
248
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4424
diff changeset
249 // 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
250 // 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
251 // "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
252 /**
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4424
diff changeset
253 "DicomTlsPrivateKey" : "orthanc.key",
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4424
diff changeset
254 **/
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4424
diff changeset
255
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4424
diff changeset
256 // 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
257 // 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
258 // (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
259 // 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
260 /**
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4424
diff changeset
261 "DicomTlsTrustedCertificates" : "trusted.crt",
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4424
diff changeset
262 **/
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4424
diff changeset
263
4656
82a314325351 New configuration option: "DicomTlsRemoteCertificateRequired"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4647
diff changeset
264 // Whether Orthanc rejects DICOM TLS connections to/from remote
82a314325351 New configuration option: "DicomTlsRemoteCertificateRequired"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4647
diff changeset
265 // 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
266 // to "true" (resp. "false") corresponds to "--require-peer-cert"
82a314325351 New configuration option: "DicomTlsRemoteCertificateRequired"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4647
diff changeset
267 // (resp. "--verify-peer-cert") in the DCMTK command-line
82a314325351 New configuration option: "DicomTlsRemoteCertificateRequired"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4647
diff changeset
268 // tools. (new in Orthanc 1.9.3)
82a314325351 New configuration option: "DicomTlsRemoteCertificateRequired"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4647
diff changeset
269 "DicomTlsRemoteCertificateRequired" : true,
82a314325351 New configuration option: "DicomTlsRemoteCertificateRequired"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4647
diff changeset
270
4474
f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4465
diff changeset
271 // 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
272 // 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
273 // 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
274 // 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
275 "DicomAlwaysAllowEcho" : true,
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4424
diff changeset
276
4474
f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4465
diff changeset
277 // 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
278 // 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
279 // 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
280 "DicomAlwaysAllowStore" : true,
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4424
diff changeset
281
4482
8efeaba1b7f9 new configuration options: "DicomAlwaysAllowFind" and "DicomAlwaysAllowGet"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4480
diff changeset
282 // 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
283 // 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
284 // 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
285 // 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
286 "DicomAlwaysAllowFind" : false,
8efeaba1b7f9 new configuration options: "DicomAlwaysAllowFind" and "DicomAlwaysAllowGet"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4480
diff changeset
287
8efeaba1b7f9 new configuration options: "DicomAlwaysAllowFind" and "DicomAlwaysAllowGet"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4480
diff changeset
288 // 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
289 // 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
290 // 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
291 // 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
292 "DicomAlwaysAllowGet" : false,
8efeaba1b7f9 new configuration options: "DicomAlwaysAllowFind" and "DicomAlwaysAllowGet"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4480
diff changeset
293
4438
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4424
diff changeset
294 // 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
295 // 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
296 // "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
297 // "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
298 "DicomCheckModalityHost" : false,
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
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4424
diff changeset
301
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4424
diff changeset
302 /**
683
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
303 * Network topology
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
304 **/
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
305
4316
7dc52763ab1c explanation in configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4315
diff changeset
306 // 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
307 // "DicomModalitiesInDatabase" is set to "true", in which case you
7dc52763ab1c explanation in configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4315
diff changeset
308 // 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
309 "DicomModalities" : {
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
310 /**
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
311 * 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
312 * 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
313 * 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
314 * 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
315 * 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
316 * 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
317 * 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
318 * 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
319 **/
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
320 // "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
321
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
322 /**
2352
3ab96768d144 Fix issue 52 (DICOM level security association problems)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2334
diff changeset
323 * 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
324 * 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
325 * - "Generic" (default value),
3ab96768d144 Fix issue 52 (DICOM level security association problems)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2334
diff changeset
326 * - "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
327 * 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
328 * - "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
329 * 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
330 * - "Vitrea",
61a5667f37d9 New modality manufacturer: "GE" for GE Healthcare EA and AW
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2872
diff changeset
331 * - "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
332 * from GE Healthcare).
61a5667f37d9 New modality manufacturer: "GE" for GE Healthcare EA and AW
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2872
diff changeset
333 *
2318
e5fc5db6a84b removed EFilm2 from sample configuration file
amazy
parents: 2229
diff changeset
334 * 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
335 **/
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
336 // "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
337
9d08edde614b Possibility to restrict the allowed DICOM commands for each modality
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2825
diff changeset
338 /**
3273
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3226
diff changeset
339 * 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
340 * 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
341 * 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
342 * 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
343 * 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
344 * below.
8f7ad4989fec transcoding to uncompressed transfer syntaxes over DICOM protocol is implemented
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3852
diff changeset
345 *
8f7ad4989fec transcoding to uncompressed transfer syntaxes over DICOM protocol is implemented
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3852
diff changeset
346 * 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
347 * 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
348 * (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
349 *
8f7ad4989fec transcoding to uncompressed transfer syntaxes over DICOM protocol is implemented
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3852
diff changeset
350 * 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
351 * 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
352 * 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
353 * 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
354 * 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
355 * the global option "EnableTranscoding" is set to "true".
4175
8f0de3998a59 fix doc
Alain Mazy <alain@mazy.be>
parents: 4044
diff changeset
356 *
8f0de3998a59 fix doc
Alain Mazy <alain@mazy.be>
parents: 4044
diff changeset
357 * By default, all "Allow*" options are true.
4178
3576616904d3 sample config: storage commitment
Alain Mazy <alain@mazy.be>
parents: 4177
diff changeset
358 * "AllowStorageCommitment" is actually an alias for
3576616904d3 sample config: storage commitment
Alain Mazy <alain@mazy.be>
parents: 4177
diff changeset
359 * "AllowNAction" & "AllowEventReport".
4438
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 * 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
362 * 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
363 * 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
364 *
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
365 * 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
366 * "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
367 * 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
368 * 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
369 * 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
370 **/
9d08edde614b Possibility to restrict the allowed DICOM commands for each modality
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2825
diff changeset
371 //"untrusted" : {
9d08edde614b Possibility to restrict the allowed DICOM commands for each modality
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2825
diff changeset
372 // "AET" : "ORTHANC",
9d08edde614b Possibility to restrict the allowed DICOM commands for each modality
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2825
diff changeset
373 // "Port" : 104,
9d08edde614b Possibility to restrict the allowed DICOM commands for each modality
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2825
diff changeset
374 // "Host" : "127.0.0.1",
3716
ae0e3fd609df sample for "Manufacturer" option in "DicomModalities" config
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3709
diff changeset
375 // "Manufacturer" : "Generic",
2872
9d08edde614b Possibility to restrict the allowed DICOM commands for each modality
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2825
diff changeset
376 // "AllowEcho" : false,
9d08edde614b Possibility to restrict the allowed DICOM commands for each modality
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2825
diff changeset
377 // "AllowFind" : false,
3818
4f78da5613a1 Add C-GET SCP support
Stacy Loesch <stacy.loesch@varian.com>
parents: 3736
diff changeset
378 // "AllowGet" : false,
2872
9d08edde614b Possibility to restrict the allowed DICOM commands for each modality
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2825
diff changeset
379 // "AllowMove" : false,
3602
085283445db0 AllowNAction in remote modality parameters
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3582
diff changeset
380 // "AllowStore" : true,
3894
8f7ad4989fec transcoding to uncompressed transfer syntaxes over DICOM protocol is implemented
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3852
diff changeset
381 // "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
382 // "AllowTranscoding" : true, // new in 1.7.0
4a4e33c9082d configuration options for DICOM TLS in Orthanc SCU
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4424
diff changeset
383 // "UseDicomTls" : false // new in 1.9.0
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
384 // "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
385 // "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
386 //}
683
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
387 },
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
388
2946
2e751f615e03 new configuration options: DicomModalitiesInDatabase and OrthancPeersInDatabase
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2932
diff changeset
389 // 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
390 // 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
391 "DicomModalitiesInDatabase" : false,
2e751f615e03 new configuration options: DicomModalitiesInDatabase and OrthancPeersInDatabase
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2932
diff changeset
392
4411
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4389
diff changeset
393 // 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
394 // while testing the connectivity from Orthanc to a remote DICOM
4389
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4384
diff changeset
395 // 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
396 // 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
397 "DicomEchoChecksFind" : false,
6fa8bb987be2 "DicomEchoChecksFind" config option + "CheckFind" field in /modalities/.../echo
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4316
diff changeset
398
2069
fabf7820d1f1 New configuration options: "DicomScuTimeout" and "DicomScpTimeout" + validation of non-negative options
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2039
diff changeset
399 // 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
400 // 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
401 // 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
402 "DicomScuTimeout" : 10,
fabf7820d1f1 New configuration options: "DicomScuTimeout" and "DicomScpTimeout" + validation of non-negative options
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2039
diff changeset
403
4465
fe774d8e904b New configuration option: "DicomScuPreferredTransferSyntax" to control transcoding in C-STORE SCU
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4463
diff changeset
404 // 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
405 // 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
406 // 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
407 // 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
408 // 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
409 // 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
410 // (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
411 // 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
412 // (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
413 // 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
414 "DicomScuPreferredTransferSyntax" : "1.2.840.10008.1.2.1",
fe774d8e904b New configuration option: "DicomScuPreferredTransferSyntax" to control transcoding in C-STORE SCU
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4463
diff changeset
415
4316
7dc52763ab1c explanation in configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4315
diff changeset
416 // 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
417 // "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
418 // 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
419 "OrthancPeers" : {
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
420 /**
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
421 * 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
422 * 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
423 * 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
424 **/
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
425 // "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
426 // "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
427
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
428 /**
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
429 * 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
430 * 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
431 * 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
432 * 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
433 *
017ab543e6ef added field "Timeout" in "OrthancPeers" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4518
diff changeset
434 * 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
435 * "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
436 **/
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
437 // "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
438 // "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
439 // "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
440 // "Password" : "alicePassword",
2800
dc7330089736 "OrthancPeers" configuration option now allows to specify HTTP headers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2788
diff changeset
441 // "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
442 // "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
443 // "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
444 // "CertificateKeyPassword" : "certpass",
4522
017ab543e6ef added field "Timeout" in "OrthancPeers" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4518
diff changeset
445 // "Pkcs11" : false,
017ab543e6ef added field "Timeout" in "OrthancPeers" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4518
diff changeset
446 // "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
447 // }
683
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
448 },
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
449
2946
2e751f615e03 new configuration options: DicomModalitiesInDatabase and OrthancPeersInDatabase
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2932
diff changeset
450 // 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
451 // 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
452 "OrthancPeersInDatabase" : false,
2e751f615e03 new configuration options: DicomModalitiesInDatabase and OrthancPeersInDatabase
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2932
diff changeset
453
1273
88010d8e12cf Support of HTTP proxy
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1272
diff changeset
454 // 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
455 // empty string, no HTTP proxy is used. For instance:
88010d8e12cf Support of HTTP proxy
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1272
diff changeset
456 // "HttpProxy" : "192.168.0.1:3128"
88010d8e12cf Support of HTTP proxy
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1272
diff changeset
457 // "HttpProxy" : "proxyUser:proxyPassword@192.168.0.1:3128"
88010d8e12cf Support of HTTP proxy
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1272
diff changeset
458 "HttpProxy" : "",
683
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
459
2788
959bd8857eb5 New configuration option: "HttpVerbose" to debug outgoing HTTP connections
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2736
diff changeset
460 // 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
461 // 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
462 // 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
463 "HttpVerbose" : false,
959bd8857eb5 New configuration option: "HttpVerbose" to debug outgoing HTTP connections
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2736
diff changeset
464
1590
ba0226474e22 New configuration option: "HttpTimeout" to set the default timeout for HTTP requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1534
diff changeset
465 // 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
466 "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
467
1973
7bd4cb780feb Option "HttpsVerifyPeers" can be used to connect against self-signed HTTPS certificates
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1871
diff changeset
468 // 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
469 // 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
470 // 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
471 // security risks!
1592
d73124f6b439 configuration option HttpDescribeErrors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1590
diff changeset
472 // Reference: http://curl.haxx.se/docs/sslcerts.html
d73124f6b439 configuration option HttpDescribeErrors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1590
diff changeset
473 "HttpsVerifyPeers" : true,
d73124f6b439 configuration option HttpDescribeErrors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1590
diff changeset
474
d73124f6b439 configuration option HttpDescribeErrors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1590
diff changeset
475 // Path to the CA (certification authority) certificates to validate
d73124f6b439 configuration option HttpDescribeErrors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1590
diff changeset
476 // peers in HTTPS requests. From curl documentation ("--cacert"
d73124f6b439 configuration option HttpDescribeErrors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1590
diff changeset
477 // option): "Tells curl to use the specified certificate file to
d73124f6b439 configuration option HttpDescribeErrors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1590
diff changeset
478 // verify the peers. The file may contain multiple CA
2923
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2888
diff changeset
479 // certificates. The certificate(s) must be in PEM format." On
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2888
diff changeset
480 // Debian-based systems, this option can be set to
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2888
diff changeset
481 // "/etc/ssl/certs/ca-certificates.crt"
1592
d73124f6b439 configuration option HttpDescribeErrors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1590
diff changeset
482 "HttpsCACertificates" : "",
d73124f6b439 configuration option HttpDescribeErrors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1590
diff changeset
483
1590
ba0226474e22 New configuration option: "HttpTimeout" to set the default timeout for HTTP requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1534
diff changeset
484
683
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
485
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
486 /**
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
487 * Advanced options
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
488 **/
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 // 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
491 // entry must map an unique string to an unique number between 1024
2184
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2152
diff changeset
492 // and 65535. Reserved values:
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2152
diff changeset
493 // - 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
494 "UserMetadata" : {
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
495 // "Sample" : 1024
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
496 },
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
497
696
4c1860179cc5 dictionary of user-defined content types
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 695
diff changeset
498 // 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
499 // 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
500 // 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
501 // 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
502 "UserContentType" : {
4c1860179cc5 dictionary of user-defined content types
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 695
diff changeset
503 // "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
504 // "sample2" : [ 1025, "application/pdf" ]
696
4c1860179cc5 dictionary of user-defined content types
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 695
diff changeset
505 },
4c1860179cc5 dictionary of user-defined content types
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 695
diff changeset
506
683
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
507 // 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
508 // 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
509 "StableAge" : 60,
b01cc78caba4 possibility to disable the DICOM/HTTP servers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 683
diff changeset
510
690
2e67366aab83 case-insensitive matching of Application Entity Titles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 685
diff changeset
511 // 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
512 // 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
513 // case-sensitive matching.
695
c59bc408fb10 parameter to disable the computation of the MD5
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 690
diff changeset
514 "StrictAetComparison" : false,
c59bc408fb10 parameter to disable the computation of the MD5
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 690
diff changeset
515
c59bc408fb10 parameter to disable the computation of the MD5
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 690
diff changeset
516 // 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
517 // 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
518 // 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
519 // 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
520 "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
521
83489fddd8c5 Options to limit the number of results for an incoming C-FIND query
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 732
diff changeset
522 // 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
523 // 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
524 // 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
525 "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
526
83489fddd8c5 Options to limit the number of results for an incoming C-FIND query
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 732
diff changeset
527 // 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
528 // 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
529 "LimitFindInstances" : 0,
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 941
diff changeset
530
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 941
diff changeset
531 // The maximum number of active jobs in the Orthanc scheduler. When
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 941
diff changeset
532 // this limit is reached, the addition of new jobs is blocked until
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 941
diff changeset
533 // some job finishes.
1086
e56c3ed8d738 Parameter to set the default encoding for DICOM files without SpecificCharacterSet
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1018
diff changeset
534 "LimitJobs" : 10,
e56c3ed8d738 Parameter to set the default encoding for DICOM files without SpecificCharacterSet
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1018
diff changeset
535
2685
6801f99bbc2f Configuration option "LogExportedResources" is now "false" by default
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2625
diff changeset
536 // 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
537 // 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
538 // 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
539 // "/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
540 // 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
541 // 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
542 "LogExportedResources" : false,
1142
952cf9b6be83 Configuration option to disable the logging of exported resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1135
diff changeset
543
3126
b1787ba94eef fix issue #32 (HTTP keep-alive), make CivetWeb the default HTTP server
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3045
diff changeset
544 // 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
545 // 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
546 // 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
547 // 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
548 // 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
549 // 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
550 // "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
551 // 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
552 "KeepAlive" : true,
1135
67c3c1e4a6e0 index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1115
diff changeset
553
3137
5a3b961e9524 New configuration option: 'TcpNoDelay' to disable Nagle's algorithm in HTTP server
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3126
diff changeset
554 // 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
555 // 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
556 // 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
557 // "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
558 // 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
559 "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
560
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
561 // 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
562 "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
563
1135
67c3c1e4a6e0 index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1115
diff changeset
564 // 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
565 // 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
566 // 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
567 // 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
568 // 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
569 // 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
570 "StoreDicom" : true,
21ea32170764 Option "DicomAssociationCloseDelay" to set delay before closing DICOM association
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1283
diff changeset
571
2620
1232922c8793 speeding up shutdown if Lua script is in trailing phase
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2570
diff changeset
572 // 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
573 // 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
574 // 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
575 // 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
576 // 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
577 "DicomAssociationCloseDelay" : 5,
a1745d9be6e9 CaseSensitivePN configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1347
diff changeset
578
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1347
diff changeset
579 // Maximum number of query/retrieve DICOM requests that are
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1347
diff changeset
580 // maintained by Orthanc. The least recently used requests get
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1347
diff changeset
581 // 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
582 "QueryRetrieveSize" : 100,
1383
5c11c4e728eb integration mainline->query-retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1368 1382
diff changeset
583
4474
f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4465
diff changeset
584 // When handling a C-FIND SCP request, setting this flag to "true"
1729
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1668
diff changeset
585 // will enable case-sensitive match for PN value representation
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1668
diff changeset
586 // (such as PatientName). By default, the search is
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1668
diff changeset
587 // 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
588 "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
589
fefbe71c2272 Possibility to use PKCS#11 authentication for hardware security modules with Orthanc peers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2019
diff changeset
590 // 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
591 // 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
592 /**
fefbe71c2272 Possibility to use PKCS#11 authentication for hardware security modules with Orthanc peers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2019
diff changeset
593 "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
594 "Module" : "/usr/local/lib/libbeidpkcs11.so",
2030
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2022
diff changeset
595 "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
596 "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
597 "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
598 }
fefbe71c2272 Possibility to use PKCS#11 authentication for hardware security modules with Orthanc peers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2019
diff changeset
599 **/
1765
57b9e6890482 New configuration option: "Dictionary" to declare custom DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1729
diff changeset
600
2151
8cbb55089a1d New configuration option: "LoadPrivateDictionary"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2129
diff changeset
601 // 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
602 // 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
603 // 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
604 // 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
605 // 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
606 // interest in the "Dictionary" configuration option below.
2151
8cbb55089a1d New configuration option: "LoadPrivateDictionary"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2129
diff changeset
607 "LoadPrivateDictionary" : true,
8cbb55089a1d New configuration option: "LoadPrivateDictionary"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2129
diff changeset
608
2334
dd26536454a0 fix for mingw
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2330
diff changeset
609 // 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
610 // 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
611 // value undefined, which lets Orthanc autodetect the suitable locale.
2330
9c7a80c87ae9 "Locale" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2319
diff changeset
612 // "Locale" : "en_US.UTF-8",
9c7a80c87ae9 "Locale" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2319
diff changeset
613
1765
57b9e6890482 New configuration option: "Dictionary" to declare custom DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1729
diff changeset
614 // 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
615 // 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
616 // 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
617 // 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
618 // 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
619 // 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
620 // possibly the Private Creator (for private tags).
1765
57b9e6890482 New configuration option: "Dictionary" to declare custom DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1729
diff changeset
621 "Dictionary" : {
57b9e6890482 New configuration option: "Dictionary" to declare custom DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1729
diff changeset
622 // "0014,1020" : [ "DA", "ValidationExpiryDate", 1, 1 ]
2151
8cbb55089a1d New configuration option: "LoadPrivateDictionary"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2129
diff changeset
623 // "00e1,10c2" : [ "UI", "PET-CT Multi Modality Name", 1, 1, "ELSCINT1" ]
2129
0c09d1af22f3 "/tools/invalidate-tags" to invalidate the JSON summary of all the DICOM files
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2116
diff changeset
624 // "7053,1003" : [ "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
625 // "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
626 },
1232922c8793 speeding up shutdown if Lua script is in trailing phase
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2570
diff changeset
627
4696
dd6274412ff4 new configuration option "ExternalDictionaries" to load external DICOM dictionaries
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4677
diff changeset
628 // 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
629 // 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
630 // 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
631 // 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
632 // 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
633 /**
dd6274412ff4 new configuration option "ExternalDictionaries" to load external DICOM dictionaries
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4677
diff changeset
634 "ExternalDictionaries" : [
dd6274412ff4 new configuration option "ExternalDictionaries" to load external DICOM dictionaries
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4677
diff changeset
635 "/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
636 "/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
637 ]
dd6274412ff4 new configuration option "ExternalDictionaries" to load external DICOM dictionaries
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4677
diff changeset
638 **/
dd6274412ff4 new configuration option "ExternalDictionaries" to load external DICOM dictionaries
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4677
diff changeset
639
4474
f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4465
diff changeset
640 // 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
641 // "false" (asynchronous mode), each incoming C-MOVE request results
3045
095193bbd7b9 fix issue #118
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3015
diff changeset
642 // 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
643 // 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
644 // 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
645 // 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
646 // 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
647 // 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
648 "SynchronousCMove" : true,
2625
5469dda691cd new configuration option: SynchronousCMove
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2620
diff changeset
649
2620
1232922c8793 speeding up shutdown if Lua script is in trailing phase
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2570
diff changeset
650 // 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
651 // 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
652 // "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
653 // 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
654 // 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
655 // 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
656 // 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
657 "JobsHistorySize" : 10,
8aa6aef11b70 New configuration option "OverwriteInstances" to choose how duplicate SOPInstanceUID are handled
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2800
diff changeset
658
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
659 // 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
660 // 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
661 // 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
662 // 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
663 // 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
664 // 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
665 // 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
666 "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
667
2825
8aa6aef11b70 New configuration option "OverwriteInstances" to choose how duplicate SOPInstanceUID are handled
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2800
diff changeset
668 // 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
669 // 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
670 // 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
671 // 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
672 // 1.4.1, the implicit behavior corresponded to "false".
2965
9c0b0a6d8b54 MediaArchiveSize configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2950
diff changeset
673 "OverwriteInstances" : false,
9c0b0a6d8b54 MediaArchiveSize configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2950
diff changeset
674
9c0b0a6d8b54 MediaArchiveSize configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2950
diff changeset
675 // Maximum number of ZIP/media archives that are maintained by
9c0b0a6d8b54 MediaArchiveSize configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2950
diff changeset
676 // Orthanc, as a response to the asynchronous creation of archives.
9c0b0a6d8b54 MediaArchiveSize configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2950
diff changeset
677 // 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
678 // 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
679 // 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
680 "MediaArchiveSize" : 1,
abe49ca61cd5 On C-FIND, avoid accessing the storage area whenever possible
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2988
diff changeset
681
abe49ca61cd5 On C-FIND, avoid accessing the storage area whenever possible
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2988
diff changeset
682 // Performance setting to specify how Orthanc accesses the storage
abe49ca61cd5 On C-FIND, avoid accessing the storage area whenever possible
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2988
diff changeset
683 // area during C-FIND. Three modes are available: (1) "Always"
abe49ca61cd5 On C-FIND, avoid accessing the storage area whenever possible
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2988
diff changeset
684 // 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
685 // 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
686 // (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
687 // 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
688 // "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
689 // 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
690 // 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
691 // 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
692 "StorageAccessOnFind" : "Always",
8ea7c4546c3a primitives to collect metrics in Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3165
diff changeset
693
8ea7c4546c3a primitives to collect metrics in Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3165
diff changeset
694 // 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
695 // 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
696 // "/tools/metrics-prometheus" formetted using the Prometheus
8ea7c4546c3a primitives to collect metrics in Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3165
diff changeset
697 // text-based exposition format.
3526
f07352e0375c new configuration option ExecuteLuaEnabled
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3506
diff changeset
698 "MetricsEnabled" : true,
f07352e0375c new configuration option ExecuteLuaEnabled
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3506
diff changeset
699
f07352e0375c new configuration option ExecuteLuaEnabled
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3506
diff changeset
700 // 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
701 // 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
702 "ExecuteLuaEnabled" : false,
9cc09f4c0fa9 New configuration option: "HttpRequestTimeout"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3526
diff changeset
703
4522
017ab543e6ef added field "Timeout" in "OrthancPeers" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4518
diff changeset
704 // 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
705 // 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
706 // "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
707 // 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
708 "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
709
1f4910999fe7 Fix issue #168 (Plugins can't read private tags from the configuration file)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3643
diff changeset
710 // 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
711 // 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
712 // 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
713 "DefaultPrivateCreator" : "",
0540b54324f1 StorageCommitmentReports
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3718
diff changeset
714
0540b54324f1 StorageCommitmentReports
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3718
diff changeset
715 // Maximum number of storage commitment reports (i.e. received from
0540b54324f1 StorageCommitmentReports
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3718
diff changeset
716 // 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
717 "StorageCommitmentReportsSize" : 100,
8f7ad4989fec transcoding to uncompressed transfer syntaxes over DICOM protocol is implemented
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3852
diff changeset
718
8f7ad4989fec transcoding to uncompressed transfer syntaxes over DICOM protocol is implemented
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3852
diff changeset
719 // 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
720 // 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
721 // 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
722 "TranscodeDicomProtocol" : true,
e6606d3ec892 new configuration option: BuiltinDecoderTranscoderOrder
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3911
diff changeset
723
e6606d3ec892 new configuration option: BuiltinDecoderTranscoderOrder
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3911
diff changeset
724 // 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
725 // 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
726 // 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
727 // 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
728 // 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
729 // 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
730 "BuiltinDecoderTranscoderOrder" : "After",
c205f670098e new configuration options: BuiltinDecoderTranscoderOrder and IngestTranscoding
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3937
diff changeset
731
c205f670098e new configuration options: BuiltinDecoderTranscoderOrder and IngestTranscoding
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3937
diff changeset
732 // 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
733 // 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
734 // 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
735 // 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
736 // 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
737 // 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
738 // 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
739 // "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
740 // 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
741 /**
c205f670098e new configuration options: BuiltinDecoderTranscoderOrder and IngestTranscoding
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3937
diff changeset
742 "IngestTranscoding" : "1.2.840.10008.1.2",
c205f670098e new configuration options: BuiltinDecoderTranscoderOrder and IngestTranscoding
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3937
diff changeset
743 **/
c205f670098e new configuration options: BuiltinDecoderTranscoderOrder and IngestTranscoding
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3937
diff changeset
744
4384
7e0d015ad109 new configuration options IngestTranscodingOfUncompressed and IngestTranscodingOfCompressed
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4382
diff changeset
745 // 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
746 // 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
747 // 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
748 // Orthanc 1.8.2).
7e0d015ad109 new configuration options IngestTranscodingOfUncompressed and IngestTranscodingOfCompressed
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4382
diff changeset
749 "IngestTranscodingOfUncompressed" : true,
7e0d015ad109 new configuration options IngestTranscodingOfUncompressed and IngestTranscodingOfCompressed
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4382
diff changeset
750
7e0d015ad109 new configuration options IngestTranscodingOfUncompressed and IngestTranscodingOfCompressed
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4382
diff changeset
751 // 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
752 // 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
753 "IngestTranscodingOfCompressed" : true,
7e0d015ad109 new configuration options IngestTranscodingOfUncompressed and IngestTranscodingOfCompressed
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4382
diff changeset
754
3939
c205f670098e new configuration options: BuiltinDecoderTranscoderOrder and IngestTranscoding
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3937
diff changeset
755 // 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
756 // 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
757 "DicomLossyTranscodingQuality" : 90,
b289a1234822 giving a try to cross-platform compilation of SyncStorageArea
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4178
diff changeset
758
b289a1234822 giving a try to cross-platform compilation of SyncStorageArea
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4178
diff changeset
759 // 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
760 // (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
761 // 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
762 // 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
763 // 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
764 // "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
765 "SyncStorageArea" : true,
6a39ca7083b9 New config option "MallocArenaMax" to control memory usage on GNU/Linux
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4340
diff changeset
766
6a39ca7083b9 New config option "MallocArenaMax" to control memory usage on GNU/Linux
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4340
diff changeset
767 // 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
768 // ...)" 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
769 // 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
770 // 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
771 // 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
772 // 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
773 // 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
774 // 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
775 // Orthanc <= 1.8.1.
4376
b002f9abe802 review of changeset 4375:208029732d51
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4375
diff changeset
776 "MallocArenaMax" : 5,
4375
208029732d51 New config option "DeidentifyDimseQueryLogs"
Mark Poscablo <Mark.Poscablo@varian.com>
parents: 4366
diff changeset
777
4474
f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4465
diff changeset
778 // 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
779 // 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
780 // 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
781 "DeidentifyLogs" : true,
4375
208029732d51 New config option "DeidentifyDimseQueryLogs"
Mark Poscablo <Mark.Poscablo@varian.com>
parents: 4366
diff changeset
782
4424
83371ccdfe80 openapi documentation is now completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4411
diff changeset
783 // 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
784 // follow for the deidentification/anonymization of the query
4677
521e39b3f2c0 Fix issue #146 (Update Anonyization to 2019c) - was actually updated to 2021b
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4674
diff changeset
785 // contents. Possible values are "2008", "2017c" and "2021b" (new
521e39b3f2c0 Fix issue #146 (Update Anonyization to 2019c) - was actually updated to 2021b
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4674
diff changeset
786 // in Orthanc 1.8.2)
521e39b3f2c0 Fix issue #146 (Update Anonyization to 2019c) - was actually updated to 2021b
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4674
diff changeset
787 "DeidentifyLogsDicomVersion" : "2021b",
4451
f4dbdb2dcba6 new configuration option "MaximumPduLength" to tune the maximum PDU length
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4438
diff changeset
788
f4dbdb2dcba6 new configuration option "MaximumPduLength" to tune the maximum PDU length
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4438
diff changeset
789 // 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
790 // 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
791 // 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
792 // 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
793 "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
794
2c702cfae274 New option "DatabaseServerIdentifier" to identify the server among a pool of Orthanc servers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4522
diff changeset
795 // 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
796 // 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
797 // 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
798 // 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
799 // Orthanc servers. If unset, this identifier is taken as a SHA-1
95ffe3b6ef7c handling of revisions for metadata
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4604
diff changeset
800 // hash derived from the MAC adddresses of the network interfaces,
95ffe3b6ef7c handling of revisions for metadata
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4604
diff changeset
801 // 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
802 // 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
803 // 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
804 /**
4623
95ffe3b6ef7c handling of revisions for metadata
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4604
diff changeset
805 "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
806 **/
4623
95ffe3b6ef7c handling of revisions for metadata
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4604
diff changeset
807
95ffe3b6ef7c handling of revisions for metadata
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4604
diff changeset
808 // Whether Orthanc protects the modification of metadata and
95ffe3b6ef7c handling of revisions for metadata
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4604
diff changeset
809 // 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
810 // "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
811 // 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
812 // 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
813 // 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
814 // 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
815 "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
816
cdab941fe17d ZIP archive/media generated in synchronous mode are now streamed by default
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4656
diff changeset
817 // 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
818 // 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
819 // 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
820 // 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
821 // 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
822 // 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
823 // as soon as one DICOM file gets compressed (new in Orthanc 1.9.4)
cdab941fe17d ZIP archive/media generated in synchronous mode are now streamed by default
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4656
diff changeset
824 "SynchronousZipStream" : true
683
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
825 }