Mercurial > hg > orthanc-book

comparison Sphinx/source/users/configuration.rst @ 0:901e8961f46e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
initial commit
author Sebastien Jodogne <s.jodogne@gmail.com>
date Fri, 22 Apr 2016 12:57:38 +0200
parents
children cd6c91d3cef5
comparison
equal deleted inserted replaced
-1:000000000000 0:901e8961f46e
1 .. _configuration:
2 .. highlight:: bash
3
4 Configuration of Orthanc
5 ========================
6
7 Configuring Orthanc simply consists in copying and adapting the
8 `default configuration file
9 <https://bitbucket.org/sjodogne/orthanc/raw/Orthanc-1.0.0/Resources/Configuration.json>`_. This
10 file is in the `JSON <https://en.wikipedia.org/wiki/JSON>`_ file
11 format. You can generate a sample configuration file with the
12 following call::
13
14 $ Orthanc --config=Configuration.json
15
16 Then, start Orthanc by giving it the path to the modified
17 Configuration.json path as a command-line argument::
18
19 $ Orthanc ./Configuration.json
20
21 The default configuration file would:
22
23 * Create a DICOM server with the DICOM AET (Application Entity Title)
24 ``ORTHANC`` that listens on the port 4242.
25 * Create a HTTP server for the REST API that listens on the port 8042.
26 * Store the Orthanc database in a folder called ``OrthancStorage``.
27
28 To obtain more diagnostic, you can use the ``--verbose`` or the
29 ``--trace`` options::
30
31 $ Orthanc ./Configuration.json --verbose
32 $ Orthanc ./Configuration.json --trace
33
34 Starting with Orthanc 0.9.1, you can also start Orthanc with the path
35 to a directory. In such a case, Orthanc will load all the files with a
36 ``.json`` extension in this directory, and merge them to construct the
37 configuration file. This allows to split the global configuration into
38 several files.