annotate Sphinx/source/users/configuration.rst @ 247:325dd3901547

ohif
author Sebastien Jodogne <s.jodogne@gmail.com>
date Sun, 19 May 2019 10:08:52 +0200
parents 90fe64396fb5
children a64197133114
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 .. _configuration:
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 .. highlight:: bash
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 Configuration of Orthanc
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5 ========================
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6
213
f40f7d15e6bb updated configuration file section
amazy
parents: 196
diff changeset
7 Configuring Orthanc simply consists in providing a configuration file.
f40f7d15e6bb updated configuration file section
amazy
parents: 196
diff changeset
8 Orthanc has numerous configuration that are documented in the `default
f40f7d15e6bb updated configuration file section
amazy
parents: 196
diff changeset
9 configuration file
220
90fe64396fb5 Orthanc 1.5.6
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 215
diff changeset
10 <https://bitbucket.org/sjodogne/orthanc/raw/Orthanc-1.5.6/Resources/Configuration.json>`_. This
0
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 file is in the `JSON <https://en.wikipedia.org/wiki/JSON>`_ file
213
f40f7d15e6bb updated configuration file section
amazy
parents: 196
diff changeset
12 format. You can generate this file file with the
0
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 following call::
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 $ Orthanc --config=Configuration.json
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 The default configuration file would:
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 * Create a DICOM server with the DICOM AET (Application Entity Title)
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 ``ORTHANC`` that listens on the port 4242.
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 * Create a HTTP server for the REST API that listens on the port 8042.
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 * Store the Orthanc database in a folder called ``OrthancStorage``.
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23
213
f40f7d15e6bb updated configuration file section
amazy
parents: 196
diff changeset
24 However, we recommend that you start from an empty configuration file
f40f7d15e6bb updated configuration file section
amazy
parents: 196
diff changeset
25 and only specify the options for which you don't wan't to use
214
amazy
parents: 213
diff changeset
26 the default value. In example, a simple configuration file would be::
213
f40f7d15e6bb updated configuration file section
amazy
parents: 196
diff changeset
27
f40f7d15e6bb updated configuration file section
amazy
parents: 196
diff changeset
28 {
f40f7d15e6bb updated configuration file section
amazy
parents: 196
diff changeset
29 "Name": "My archive",
f40f7d15e6bb updated configuration file section
amazy
parents: 196
diff changeset
30 "HttpPort": 80,
f40f7d15e6bb updated configuration file section
amazy
parents: 196
diff changeset
31 "DicomAet": "ARCHIVE",
f40f7d15e6bb updated configuration file section
amazy
parents: 196
diff changeset
32 "DicomPort": 104
f40f7d15e6bb updated configuration file section
amazy
parents: 196
diff changeset
33 }
f40f7d15e6bb updated configuration file section
amazy
parents: 196
diff changeset
34
f40f7d15e6bb updated configuration file section
amazy
parents: 196
diff changeset
35 It's also a very good practice to split your configuration files per topic.
214
amazy
parents: 213
diff changeset
36 In example, have a ``dicom.json`` for everything that is related to DICOM,
213
f40f7d15e6bb updated configuration file section
amazy
parents: 196
diff changeset
37 a ``http.json`` for all HTTP related configurations, one file per plugin...
f40f7d15e6bb updated configuration file section
amazy
parents: 196
diff changeset
38 This is how the configuration files are provided with the Windows Installer.
f40f7d15e6bb updated configuration file section
amazy
parents: 196
diff changeset
39
f40f7d15e6bb updated configuration file section
amazy
parents: 196
diff changeset
40 Once your configuration file is ready, start Orthanc by giving it the path to the
f40f7d15e6bb updated configuration file section
amazy
parents: 196
diff changeset
41 configuration file path as a command-line argument. If you use multiple configuration
f40f7d15e6bb updated configuration file section
amazy
parents: 196
diff changeset
42 files, you may provide the path to the folder containing all configuration files
f40f7d15e6bb updated configuration file section
amazy
parents: 196
diff changeset
43 (all ``.json`` files will be loaded)::
f40f7d15e6bb updated configuration file section
amazy
parents: 196
diff changeset
44
f40f7d15e6bb updated configuration file section
amazy
parents: 196
diff changeset
45 $ Orthanc ./Configuration.json
f40f7d15e6bb updated configuration file section
amazy
parents: 196
diff changeset
46 $ Orthanc ./config/
f40f7d15e6bb updated configuration file section
amazy
parents: 196
diff changeset
47
f40f7d15e6bb updated configuration file section
amazy
parents: 196
diff changeset
48
73
c742c8f9ffa3 encodings
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 72
diff changeset
49 *Remark:* When specifying paths under Microsoft Windows, backslashes
c742c8f9ffa3 encodings
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 72
diff changeset
50 (i.e. ``\``) should be either escaped by doubling them (as in ``\\``),
c742c8f9ffa3 encodings
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 72
diff changeset
51 or replaced by forward slashes (as in ``/``).
213
f40f7d15e6bb updated configuration file section
amazy
parents: 196
diff changeset
52 *Remark:* When installing Orthanc with the Windows Installer, you won't be
f40f7d15e6bb updated configuration file section
amazy
parents: 196
diff changeset
53 able to edit your files unless you start your editor with ``Run as administrator``.
f40f7d15e6bb updated configuration file section
amazy
parents: 196
diff changeset
54 We recommend to edit your configuration file with an editor such as `Notepad++ <https://notepad-plus-plus.org/>`_.
f40f7d15e6bb updated configuration file section
amazy
parents: 196
diff changeset
55 It shall warn you that this file can be edited only by an admin, and will suggest you
f40f7d15e6bb updated configuration file section
amazy
parents: 196
diff changeset
56 to restart Notepad++ as an admin such that you'll be able to save it.
73
c742c8f9ffa3 encodings
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 72
diff changeset
57
213
f40f7d15e6bb updated configuration file section
amazy
parents: 196
diff changeset
58
0
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
59 To obtain more diagnostic, you can use the ``--verbose`` or the
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
60 ``--trace`` options::
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
61
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
62 $ Orthanc ./Configuration.json --verbose
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
63 $ Orthanc ./Configuration.json --trace
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
64