annotate Resources/Configuration.json @ 2151:8cbb55089a1d

New configuration option: "LoadPrivateDictionary"
author Sebastien Jodogne <s.jodogne@gmail.com>
date Mon, 14 Nov 2016 14:22:45 +0100
parents 0c09d1af22f3
children cbebc5d072b0
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
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
10 // Path to the directory that holds the heavyweight files
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
11 // (i.e. the raw DICOM instances)
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
12 "StorageDirectory" : "OrthancStorage",
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
13
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
14 // Path to the directory that holds the SQLite index (if unset,
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
15 // the value of StorageDirectory is used). This index could be
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
16 // stored on a RAM-drive or a SSD device for performance reasons.
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
17 "IndexDirectory" : "OrthancStorage",
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
18
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
19 // 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
20 "StorageCompression" : false,
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
21
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
22 // 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
23 // limit on the storage size)
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
24 "MaximumStorageSize" : 0,
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
25
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
26 // 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
27 // 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
28 // of patients)
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
29 "MaximumPatientCount" : 0,
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
30
893
f57802f8b4dc plugins for windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 891
diff changeset
31 // 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
32 // 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
33 "LuaScripts" : [
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
893
f57802f8b4dc plugins for windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 891
diff changeset
36 // 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
37 // 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
38 // "./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
39 // folders, in which case they will be scanned non-recursively to
7442097b41c9 Scan of folders for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1199
diff changeset
40 // find shared libraries.
891
d0a08d8881b7 configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 732
diff changeset
41 "Plugins" : [
d0a08d8881b7 configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 732
diff changeset
42 ],
683
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
43
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
44
1592
d73124f6b439 configuration option HttpDescribeErrors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1590
diff changeset
45
683
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
46 /**
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
47 * Configuration of the HTTP server
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
48 **/
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
49
1592
d73124f6b439 configuration option HttpDescribeErrors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1590
diff changeset
50 // 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
51 // 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
52 // Explorer will not be available.
d73124f6b439 configuration option HttpDescribeErrors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1590
diff changeset
53 "HttpServerEnabled" : true,
d73124f6b439 configuration option HttpDescribeErrors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1590
diff changeset
54
683
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
55 // 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
56 "HttpPort" : 8042,
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
57
1592
d73124f6b439 configuration option HttpDescribeErrors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1590
diff changeset
58 // 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
59 // 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
60 // 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
61 // HTTP client does not properly handles such answers.
d73124f6b439 configuration option HttpDescribeErrors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1590
diff changeset
62 "HttpDescribeErrors" : true,
d73124f6b439 configuration option HttpDescribeErrors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1590
diff changeset
63
d73124f6b439 configuration option HttpDescribeErrors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1590
diff changeset
64 // Enable HTTP compression to improve network bandwidth utilization,
d73124f6b439 configuration option HttpDescribeErrors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1590
diff changeset
65 // at the expense of more computations on the server. Orthanc
d73124f6b439 configuration option HttpDescribeErrors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1590
diff changeset
66 // supports the "gzip" and "deflate" HTTP encodings.
d73124f6b439 configuration option HttpDescribeErrors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1590
diff changeset
67 "HttpCompressionEnabled" : true,
d73124f6b439 configuration option HttpDescribeErrors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1590
diff changeset
68
683
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
69
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
70
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
71 /**
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
72 * Configuration of the DICOM server
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
73 **/
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
74
1592
d73124f6b439 configuration option HttpDescribeErrors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1590
diff changeset
75 // 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
76 // 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
77 // 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
78 "DicomServerEnabled" : true,
d73124f6b439 configuration option HttpDescribeErrors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1590
diff changeset
79
683
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
80 // The DICOM Application Entity Title
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
81 "DicomAet" : "ORTHANC",
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
82
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
83 // Check whether the called AET corresponds during a DICOM request
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
84 "DicomCheckCalledAet" : false,
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
85
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
86 // The DICOM port
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
87 "DicomPort" : 4242,
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
88
1115
da56a7916e8a Experimental "KeepAlive" configuration option to enable HTTP Keep-Alive
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1090
diff changeset
89 // The default encoding that is assumed for DICOM files without
da56a7916e8a Experimental "KeepAlive" configuration option to enable HTTP Keep-Alive
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1090
diff changeset
90 // "SpecificCharacterSet" DICOM tag. The allowed values are "Ascii",
da56a7916e8a Experimental "KeepAlive" configuration option to enable HTTP Keep-Alive
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1090
diff changeset
91 // "Utf8", "Latin1", "Latin2", "Latin3", "Latin4", "Latin5",
1347
60cc0ee61edb fix issue 32
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1284
diff changeset
92 // "Cyrillic", "Windows1251", "Arabic", "Greek", "Hebrew", "Thai",
60cc0ee61edb fix issue 32
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1284
diff changeset
93 // "Japanese", and "Chinese".
1115
da56a7916e8a Experimental "KeepAlive" configuration option to enable HTTP Keep-Alive
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1090
diff changeset
94 "DefaultEncoding" : "Latin1",
da56a7916e8a Experimental "KeepAlive" configuration option to enable HTTP Keep-Alive
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1090
diff changeset
95
1164
0a55d8eb194e Configuration/Lua to select the accepted C-Store SCP transfer syntaxes
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1142
diff changeset
96 // The transfer syntaxes that are accepted by Orthanc C-Store SCP
0a55d8eb194e Configuration/Lua to select the accepted C-Store SCP transfer syntaxes
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1142
diff changeset
97 "DeflatedTransferSyntaxAccepted" : true,
0a55d8eb194e Configuration/Lua to select the accepted C-Store SCP transfer syntaxes
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1142
diff changeset
98 "JpegTransferSyntaxAccepted" : true,
0a55d8eb194e Configuration/Lua to select the accepted C-Store SCP transfer syntaxes
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1142
diff changeset
99 "Jpeg2000TransferSyntaxAccepted" : true,
0a55d8eb194e Configuration/Lua to select the accepted C-Store SCP transfer syntaxes
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1142
diff changeset
100 "JpegLosslessTransferSyntaxAccepted" : true,
0a55d8eb194e Configuration/Lua to select the accepted C-Store SCP transfer syntaxes
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1142
diff changeset
101 "JpipTransferSyntaxAccepted" : true,
0a55d8eb194e Configuration/Lua to select the accepted C-Store SCP transfer syntaxes
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1142
diff changeset
102 "Mpeg2TransferSyntaxAccepted" : true,
0a55d8eb194e Configuration/Lua to select the accepted C-Store SCP transfer syntaxes
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1142
diff changeset
103 "RleTransferSyntaxAccepted" : true,
683
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
104
1806
cd213ebcaefd UnknownSopClassAccepted option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1772
diff changeset
105 // Whether Orthanc accepts to act as C-Store SCP for unknown storage
cd213ebcaefd UnknownSopClassAccepted option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1772
diff changeset
106 // SOP classes (aka. "promiscuous mode")
1871
e8146c9c28a4 Promiscuous mode is now turned off by default
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1856
diff changeset
107 "UnknownSopClassAccepted" : false,
1806
cd213ebcaefd UnknownSopClassAccepted option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1772
diff changeset
108
2069
fabf7820d1f1 New configuration options: "DicomScuTimeout" and "DicomScpTimeout" + validation of non-negative options
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2039
diff changeset
109 // 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
110 // 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
111 // 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
112 "DicomScpTimeout" : 30,
fabf7820d1f1 New configuration options: "DicomScuTimeout" and "DicomScpTimeout" + validation of non-negative options
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2039
diff changeset
113
683
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
114
1592
d73124f6b439 configuration option HttpDescribeErrors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1590
diff changeset
115
683
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
116 /**
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
117 * 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
118 **/
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
119
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
120 // Whether remote hosts can connect to the HTTP server
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
121 "RemoteAccessAllowed" : false,
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
122
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
123 // 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
124 "SslEnabled" : false,
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
125
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
126 // Path to the SSL certificate in the PEM format (meaningful only if
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
127 // SSL is enabled)
683
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
128 "SslCertificate" : "certificate.pem",
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
129
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
130 // Whether or not the password protection is enabled
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
131 "AuthenticationEnabled" : false,
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
132
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
133 // 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
134 // 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
135 "RegisteredUsers" : {
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
136 // "alice" : "alicePassword"
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
137 },
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
138
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
139
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
140
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
141 /**
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
142 * Network topology
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
143 **/
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
144
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
145 // The list of the known DICOM modalities
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
146 "DicomModalities" : {
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
147 /**
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
148 * 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
149 * connect to an instance of the "storescp" open-source DICOM
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
150 * store (shipped in the DCMTK distribution) started by the
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
151 * command line "storescp 2000".
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
152 **/
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
153 // "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
154
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
155 /**
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
156 * A fourth parameter is available to enable patches for a
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
157 * specific PACS manufacturer. The allowed values are currently
1017
9d0c7301596e storescp modality
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 995
diff changeset
158 * "Generic" (default value), "StoreScp" (storescp tool from
1852
efbc3afd6cd3 Efilm and Vitrea manufacturers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1846
diff changeset
159 * DCMTK), "ClearCanvas", "MedInria", "Dcm4Chee", "SyngoVia",
1856
36ab170733d6 Made eFilm version explicit
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1852
diff changeset
160 * "AgfaImpax" (Agfa IMPAX), "EFilm2" (eFilm version 2), and
36ab170733d6 Made eFilm version explicit
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1852
diff changeset
161 * "Vitrea". 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
162 **/
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
163 // "clearcanvas" : [ "CLEARCANVAS", "192.168.1.1", 104, "ClearCanvas" ]
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
164 },
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
165
2069
fabf7820d1f1 New configuration options: "DicomScuTimeout" and "DicomScpTimeout" + validation of non-negative options
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2039
diff changeset
166 // 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
167 // 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
168 // 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
169 "DicomScuTimeout" : 10,
fabf7820d1f1 New configuration options: "DicomScuTimeout" and "DicomScpTimeout" + validation of non-negative options
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2039
diff changeset
170
683
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
171 // The list of the known Orthanc peers
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
172 "OrthancPeers" : {
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
173 /**
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
174 * 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
175 * 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
176 * 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
177 **/
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
178 // "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
179 // "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
180
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
181 /**
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
182 * This is another, more advanced format to define Orthanc
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
183 * peers. It notably allows to specify a HTTPS client certificate
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
184 * in the PEM format (as in the "--cert" option of curl), or to
fefbe71c2272 Possibility to use PKCS#11 authentication for hardware security modules with Orthanc peers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2019
diff changeset
185 * enable PKCS#11 authentication for smart cards.
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
186 **/
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
187 // "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
188 // "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
189 // "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
190 // "Password" : "alicePassword",
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
191 // "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
192 // "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
193 // "CertificateKeyPassword" : "certpass",
fefbe71c2272 Possibility to use PKCS#11 authentication for hardware security modules with Orthanc peers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2019
diff changeset
194 // "Pkcs11" : false
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
195 // }
683
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
196 },
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
197
1273
88010d8e12cf Support of HTTP proxy
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1272
diff changeset
198 // 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
199 // empty string, no HTTP proxy is used. For instance:
88010d8e12cf Support of HTTP proxy
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1272
diff changeset
200 // "HttpProxy" : "192.168.0.1:3128"
88010d8e12cf Support of HTTP proxy
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1272
diff changeset
201 // "HttpProxy" : "proxyUser:proxyPassword@192.168.0.1:3128"
88010d8e12cf Support of HTTP proxy
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1272
diff changeset
202 "HttpProxy" : "",
683
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
203
1590
ba0226474e22 New configuration option: "HttpTimeout" to set the default timeout for HTTP requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1534
diff changeset
204 // Set the timeout for HTTP requests issued by Orthanc (in seconds).
ba0226474e22 New configuration option: "HttpTimeout" to set the default timeout for HTTP requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1534
diff changeset
205 "HttpTimeout" : 10,
ba0226474e22 New configuration option: "HttpTimeout" to set the default timeout for HTTP requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1534
diff changeset
206
1973
7bd4cb780feb Option "HttpsVerifyPeers" can be used to connect against self-signed HTTPS certificates
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1871
diff changeset
207 // 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
208 // 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
209 // 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
210 // security risks!
1592
d73124f6b439 configuration option HttpDescribeErrors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1590
diff changeset
211 // Reference: http://curl.haxx.se/docs/sslcerts.html
d73124f6b439 configuration option HttpDescribeErrors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1590
diff changeset
212 "HttpsVerifyPeers" : true,
d73124f6b439 configuration option HttpDescribeErrors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1590
diff changeset
213
d73124f6b439 configuration option HttpDescribeErrors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1590
diff changeset
214 // Path to the CA (certification authority) certificates to validate
d73124f6b439 configuration option HttpDescribeErrors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1590
diff changeset
215 // peers in HTTPS requests. From curl documentation ("--cacert"
d73124f6b439 configuration option HttpDescribeErrors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1590
diff changeset
216 // option): "Tells curl to use the specified certificate file to
d73124f6b439 configuration option HttpDescribeErrors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1590
diff changeset
217 // verify the peers. The file may contain multiple CA
d73124f6b439 configuration option HttpDescribeErrors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1590
diff changeset
218 // certificates. The certificate(s) must be in PEM format."
d73124f6b439 configuration option HttpDescribeErrors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1590
diff changeset
219 "HttpsCACertificates" : "",
d73124f6b439 configuration option HttpDescribeErrors
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1590
diff changeset
220
1590
ba0226474e22 New configuration option: "HttpTimeout" to set the default timeout for HTTP requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1534
diff changeset
221
683
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
222
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
223 /**
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
224 * Advanced options
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
225 **/
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
226
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
227 // 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
228 // entry must map an unique string to an unique number between 1024
53e045b5a8ec MIME content type can be associated to custom attachments (cf. "UserContentType")
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1765
diff changeset
229 // and 65535.
683
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
230 "UserMetadata" : {
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
231 // "Sample" : 1024
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
696
4c1860179cc5 dictionary of user-defined content types
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 695
diff changeset
234 // 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
235 // 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
236 // 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
237 // 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
238 "UserContentType" : {
4c1860179cc5 dictionary of user-defined content types
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 695
diff changeset
239 // "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
240 // "sample2" : [ 1025, "application/pdf" ]
696
4c1860179cc5 dictionary of user-defined content types
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 695
diff changeset
241 },
4c1860179cc5 dictionary of user-defined content types
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 695
diff changeset
242
683
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
243 // 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
244 // 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
245 "StableAge" : 60,
b01cc78caba4 possibility to disable the DICOM/HTTP servers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 683
diff changeset
246
690
2e67366aab83 case-insensitive matching of Application Entity Titles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 685
diff changeset
247 // 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
248 // 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
249 // case-sensitive matching.
695
c59bc408fb10 parameter to disable the computation of the MD5
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 690
diff changeset
250 "StrictAetComparison" : false,
c59bc408fb10 parameter to disable the computation of the MD5
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 690
diff changeset
251
c59bc408fb10 parameter to disable the computation of the MD5
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 690
diff changeset
252 // 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
253 // 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
254 // 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
255 // 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
256 "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
257
83489fddd8c5 Options to limit the number of results for an incoming C-FIND query
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 732
diff changeset
258 // 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
259 // 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
260 // 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
261 "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
262
83489fddd8c5 Options to limit the number of results for an incoming C-FIND query
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 732
diff changeset
263 // 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
264 // 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
265 "LimitFindInstances" : 0,
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 941
diff changeset
266
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 941
diff changeset
267 // 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
268 // 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
269 // 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
270 "LimitJobs" : 10,
e56c3ed8d738 Parameter to set the default encoding for DICOM files without SpecificCharacterSet
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1018
diff changeset
271
1142
952cf9b6be83 Configuration option to disable the logging of exported resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1135
diff changeset
272 // If this option is set to "false", Orthanc will not log the
952cf9b6be83 Configuration option to disable the logging of exported resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1135
diff changeset
273 // resources that are exported to other DICOM modalities of Orthanc
952cf9b6be83 Configuration option to disable the logging of exported resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1135
diff changeset
274 // peers in the URI "/exports". This is useful to prevent the index
952cf9b6be83 Configuration option to disable the logging of exported resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1135
diff changeset
275 // to grow indefinitely in auto-routing tasks.
952cf9b6be83 Configuration option to disable the logging of exported resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1135
diff changeset
276 "LogExportedResources" : true,
952cf9b6be83 Configuration option to disable the logging of exported resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1135
diff changeset
277
1283
6066529e34c8 HTTP keep-alive is deprecated
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1273
diff changeset
278 // Enable or disable HTTP Keep-Alive (deprecated). Set this option
1115
da56a7916e8a Experimental "KeepAlive" configuration option to enable HTTP Keep-Alive
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1090
diff changeset
279 // to "true" only in the case of high HTTP loads.
1135
67c3c1e4a6e0 index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1115
diff changeset
280 "KeepAlive" : false,
67c3c1e4a6e0 index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1115
diff changeset
281
67c3c1e4a6e0 index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1115
diff changeset
282 // If this option is set to "false", Orthanc will run in index-only
1668
de1413733c97 reconstructing main dicom tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1592
diff changeset
283 // mode. The DICOM files will not be stored on the drive. Note that
de1413733c97 reconstructing main dicom tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1592
diff changeset
284 // this option might prevent the upgrade to newer versions of Orthanc.
1284
21ea32170764 Option "DicomAssociationCloseDelay" to set delay before closing DICOM association
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1283
diff changeset
285 "StoreDicom" : true,
21ea32170764 Option "DicomAssociationCloseDelay" to set delay before closing DICOM association
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1283
diff changeset
286
21ea32170764 Option "DicomAssociationCloseDelay" to set delay before closing DICOM association
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1283
diff changeset
287 // DICOM associations are kept open as long as new DICOM commands
21ea32170764 Option "DicomAssociationCloseDelay" to set delay before closing DICOM association
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1283
diff changeset
288 // are issued. This option sets the number of seconds of inactivity
21ea32170764 Option "DicomAssociationCloseDelay" to set delay before closing DICOM association
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1283
diff changeset
289 // to wait before automatically closing a DICOM association. If set
21ea32170764 Option "DicomAssociationCloseDelay" to set delay before closing DICOM association
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1283
diff changeset
290 // to 0, the connection is closed immediately.
1374
a1745d9be6e9 CaseSensitivePN configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1347
diff changeset
291 "DicomAssociationCloseDelay" : 5,
a1745d9be6e9 CaseSensitivePN configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1347
diff changeset
292
1368
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1347
diff changeset
293 // Maximum number of query/retrieve DICOM requests that are
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1347
diff changeset
294 // maintained by Orthanc. The least recently used requests get
b22ba8c5edbe query retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1347
diff changeset
295 // deleted as new requests are issued.
1383
5c11c4e728eb integration mainline->query-retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1368 1382
diff changeset
296 "QueryRetrieveSize" : 10,
5c11c4e728eb integration mainline->query-retrieve
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1368 1382
diff changeset
297
1729
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1668
diff changeset
298 // When handling a C-Find SCP request, setting this flag to "true"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1668
diff changeset
299 // will enable case-sensitive match for PN value representation
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1668
diff changeset
300 // (such as PatientName). By default, the search is
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1668
diff changeset
301 // 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
302 "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
303
fefbe71c2272 Possibility to use PKCS#11 authentication for hardware security modules with Orthanc peers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2019
diff changeset
304 // 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
305 // 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
306 /**
fefbe71c2272 Possibility to use PKCS#11 authentication for hardware security modules with Orthanc peers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2019
diff changeset
307 "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
308 "Module" : "/usr/local/lib/libbeidpkcs11.so",
2030
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2022
diff changeset
309 "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
310 "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
311 "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
312 }
fefbe71c2272 Possibility to use PKCS#11 authentication for hardware security modules with Orthanc peers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2019
diff changeset
313 **/
1765
57b9e6890482 New configuration option: "Dictionary" to declare custom DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1729
diff changeset
314
2039
e33e0ae51d7b new configuration option AllowFindSopClassesInStudy
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2032
diff changeset
315 // If set to "true", Orthanc will handle "SOP Classes in Study"
e33e0ae51d7b new configuration option AllowFindSopClassesInStudy
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2032
diff changeset
316 // (0008,0062) in C-FIND requests. This option is turned off by
e33e0ae51d7b new configuration option AllowFindSopClassesInStudy
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2032
diff changeset
317 // default, as it requires intensive accesses to the hard drive.
e33e0ae51d7b new configuration option AllowFindSopClassesInStudy
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2032
diff changeset
318 "AllowFindSopClassesInStudy" : false,
e33e0ae51d7b new configuration option AllowFindSopClassesInStudy
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2032
diff changeset
319
2151
8cbb55089a1d New configuration option: "LoadPrivateDictionary"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2129
diff changeset
320 // 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
321 // 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
322 // DICOM file encoded using the Implicit VR Endian transfer syntax,
8cbb55089a1d New configuration option: "LoadPrivateDictionary"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2129
diff changeset
323 // and containing private tags. You can still list your private tags
8cbb55089a1d New configuration option: "LoadPrivateDictionary"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2129
diff changeset
324 // of interest in the "Dictionary" configuration option below.
8cbb55089a1d New configuration option: "LoadPrivateDictionary"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2129
diff changeset
325 "LoadPrivateDictionary" : true,
8cbb55089a1d New configuration option: "LoadPrivateDictionary"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2129
diff changeset
326
1765
57b9e6890482 New configuration option: "Dictionary" to declare custom DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1729
diff changeset
327 // 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
328 // 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
329 // 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
330 // 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
331 // 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
332 // 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
333 // 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
334 "Dictionary" : {
57b9e6890482 New configuration option: "Dictionary" to declare custom DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1729
diff changeset
335 // "0014,1020" : [ "DA", "ValidationExpiryDate", 1, 1 ]
2151
8cbb55089a1d New configuration option: "LoadPrivateDictionary"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2129
diff changeset
336 // "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
337 // "7053,1003" : [ "ST", "Original Image Filename", 1, 1, "Philips PET Private Group" ]
2151
8cbb55089a1d New configuration option: "LoadPrivateDictionary"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2129
diff changeset
338 // "2001,5f" : [ "SQ", "StackSequence", 1, 0, "Philips Imaging DD 001" ]
1765
57b9e6890482 New configuration option: "Dictionary" to declare custom DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1729
diff changeset
339 }
683
7bc5ccc550a1 switch from DOS to UNIX end of lines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 665
diff changeset
340 }