Mercurial > hg > orthanc-book

annotate Sphinx/source/users/docker-osimis.rst @ 749:4ae741e351ab

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
osimis docker - ODBC_PLUGIN_ENABLED
author Sebastien Jodogne <s.jodogne@gmail.com>
date Fri, 13 Aug 2021 09:33:00 +0200
parents 7bda641d5d40
children 9130cb19dc4d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
497
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
1 .. _docker-osimis:
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
2 .. highlight:: bash
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
3
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
4
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
5 Osimis Orthanc Docker images
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
6 ============================
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
7
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
8 .. contents::
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
9 :depth: 3
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
10
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
11
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
12 .. warning:: This documentation applies to ``osimis/orthanc`` images from the ``20.4.2`` version.
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
13
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
14 Note that these images have been re-written in April 2020. The documentation
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
15 for older images is still available `here <https://osimis.atlassian.net/wiki/spaces/OKB/pages/26738689/How+to+use+osimis+orthanc+Docker+images#Howtouseosimis/orthancDockerimages>`__
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
16
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
17 The new images are backward compatible with the previous images except for the
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
18 Google Cloud Platform configuration.
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
19
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
20 However, if you're still using legacy environment variables, you'll get some warning
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
21 encouraging you to update to the new namings since the backward compatibility
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
22 might be removed one day (currently planed in June 2021).
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
23
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
24
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
25 Introduction
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
26 ------------
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
27
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
28 Our commercial partner `Osimis <https://www.osimis.io>`__
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
29 `publishes separated Docker images
636
0e9f934fff44 fix path to DockerHub Osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 575
diff changeset
30 <https://hub.docker.com/r/osimis/orthanc>`__
497
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
31 that are used by their technical team in order to provide professional
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
32 support to their customers.
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
33
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
34 These images have been designed to be used with ``docker-compose`` and
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
35 provide a configuration system through:
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
36
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
37 - environment variables
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
38 - Docker secrets
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
39 - classical configuration files
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
40 - a mix of these options
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
41
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
42 This `repository <https://bitbucket.org/osimis/orthanc-setup-samples/src>`__
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
43 contains lots of examples on how to use these images. In particular,
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
44 `this example <https://bitbucket.org/osimis/orthanc-setup-samples/src/master/docker/all-usages/docker-compose.yml>`__
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
45 shows all the way that can be used to generate the same
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
46 configuration in Orthanc.
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
47
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
48
575
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 549
diff changeset
49 Environment variables
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 549
diff changeset
50 ---------------------
497
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
51
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
52 Any part of the Orthanc configuration file can be configured through an
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
53 environment variable. Now that Orthanc and its plugins have hundreds of
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
54 configuration parameter, listing all these environment variable would be
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
55 too long. That's why we have defined a standard way of naming the variable:
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
56
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
57 +---------------------------+----------------------------------------------+----------------------------------------------------------------+
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
58 | Orthanc configuration | Environment variable | Sample value |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
59 +===========================+==============================================+================================================================+
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
60 | StableAge | ORTHANC__STABLE_AGE | ``30`` |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
61 +---------------------------+----------------------------------------------+----------------------------------------------------------------+
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
62 | DicomWeb.Root | ORTHANC__DICOM_WEB__ROOT | ``/dicom-web/`` |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
63 +---------------------------+----------------------------------------------+----------------------------------------------------------------+
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
64 | DicomWeb.Servers | ORTHANC__DICOM_WEB__SERVERS | ``{"sample": [ "http://127.0.0.1/dicom-web/"]}`` |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
65 +---------------------------+----------------------------------------------+----------------------------------------------------------------+
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
66
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
67 To find out an environment variable name from an Orthanc setting
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
68 (i.e. ``DicomWeb.StudiesMetadata`` is the ``path`` to a setting):
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
69
575
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 549
diff changeset
70 - whenever a word contains a capital letter, insert an underscore ``_`` in front.
497
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
71 ``DicomWeb.StudiesMetadata`` now becomes ``Dicom_Web.Studies_Metadata``
575
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 549
diff changeset
72 - whenever you go down one level in the JSON configuration, insert
497
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
73 a double underscore ``__``. ``Dicom_Web.Studies_Metadata`` now becomes
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
74 ``Dicom_Web__Studies_Metadata``
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
75 - capitalize all letters. ``Dicom_Web__Studies_Metadata`` now becomes
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
76 ``DICOM_WEB__STUDIES_METADATA``
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
77 - add ``ORTHANC__`` in front. ``DICOM_WEB__STUDIES_METADATA`` now becomes
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
78 ``ORTHANC__DICOM_WEB__STUDIES_METADATA``
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
79
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
80 Note that, this automatic rule might fail because of 2 capital letters one after each other in some
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
81 Orthanc settings. Therefore, there are some `exceptions <https://bitbucket.org/osimis/orthanc-builder/src/master/docker/orthanc/env-var-non-standards.json>`__ to this rule
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
82 that are however quite intuitive.
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
83
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
84 Special environment variables
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
85 -----------------------------
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
86
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
87 Other environment variables are not related to the Orthanc configuration file
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
88 but can be specified to control the way Orthanc is run.
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
89
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
90 - ``VERBOSE_STARTUP=true`` will allow you to debug the startup process and see
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
91 the configuration that has been provided to Orthanc. This setup should be
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
92 disabled in production since it might display secret information like passwords
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
93 in your logs
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
94 - ``VERBOSE_ENABLED=true`` will start Orthanc with the ``--verbose`` option
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
95 - ``TRACE_ENABLED=true`` will start Orthanc with the ``--trace`` option
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
96 - ``NO_JOBS=true`` will start Orthanc with the ``--no-jobs`` option
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
97 - ``UNLOCK=true`` will start Orthanc with the ``--unlock`` option
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
98 - ``MALLOC_ARENA_MAX=10`` will :ref:`control memory usage <scalability-memory>`
575
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 549
diff changeset
99 - ``ORTHANC_JSON`` can be used to pass a JSON "root" configuration (see below).
743
7bda641d5d40 BEFORE_ORTHANC_STARTUP_SCRIPT
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 687
diff changeset
100 - ``BEFORE_ORTHANC_STARTUP_SCRIPT`` can be used to `run a custom script <https://groups.google.com/g/orthanc-users/c/EXjTq2ZU1vw/m/02CwW1jzAQAJ>`__ before starting Orthanc.
7bda641d5d40 BEFORE_ORTHANC_STARTUP_SCRIPT
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 687
diff changeset
101
497
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
102 Configuration files
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
103 -------------------
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
104
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
105 .. highlight:: yaml
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
106
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
107 Configuration files should be stored in the ``/etc/orthanc/`` folder inside the Docker image.
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
108 This is done by building an image thanks to a ``Dockerfile``::
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
109
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
110 FROM osimis/orthanc
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
111 COPY orthanc.json /etc/orthanc/
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
112
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
113
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
114 Configuration files can also be passed as secrets as shown in this ``docker-compose.yml``::
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
115
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
116 version: "3.3"
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
117 services:
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
118 orthanc-file-in-secrets:
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
119 image: osimis/orthanc
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
120 depends_on: [index-db]
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
121 ports: ["8201:8042"]
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
122 environment:
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
123 VERBOSE_STARTUP: "true"
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
124
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
125 secrets:
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
126 - orthanc.secret.json
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
127
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
128 secrets:
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
129 orthanc.secret.json:
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
130 file: orthanc.secret.json
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
131
575
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 549
diff changeset
132 Finally, a whole configuration file can be passed as a JSON through the ``ORTHANC_JSON`` environment variable::
497
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
133
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
134 version: "3.3"
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
135 services:
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
136 orthanc-file-in-env-var:
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
137 image: osimis/orthanc
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
138 depends_on: [index-db]
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
139 ports: ["8200:8042"]
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
140 environment:
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
141 VERBOSE_ENABLED: "true"
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
142 OSIMIS_WEB_VIEWER1_PLUGIN_ENABLED: "true"
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
143
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
144 ORTHANC_JSON: |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
145 {
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
146 "Name": "orthanc-file-in-env-var",
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
147 "PostgreSQL" : {
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
148 "Host": "index-db",
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
149 "Password": "pg-password"
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
150 },
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
151 "RegisteredUsers": {
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
152 "demo": "demo"
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
153 }
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
154 }
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
155
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
156
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
157 Docker secrets
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
158 --------------
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
159
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
160 .. highlight:: yaml
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
161
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
162 When using your container in a ``Docker Swarm`` or ``Kubernetes`` environment,
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
163 it is usually advised to pass sensitive information through ``Docker Secrets``.
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
164 For this purpose, any secret whose name is similar to the name of an
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
165 environment variable is considered as an environment variable::
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
166
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
167 version: "3.3"
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
168 services:
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
169 orthanc-with-direct-secret:
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
170 image: osimis/orthanc
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
171 depends_on: [index-db]
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
172 ports: ["8003:8042"]
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
173 environment:
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
174 ORTHANC__NAME: "orthanc-with-direct-secret"
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
175 VERBOSE_ENABLED: "true"
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
176
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
177 OSIMIS_WEB_VIEWER1_PLUGIN_ENABLED: "true"
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
178
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
179 ORTHANC__POSTGRESQL__HOST: "index-db"
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
180 ORTHANC__REGISTERED_USERS: |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
181 {"demo": "demo"}
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
182
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
183 secrets:
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
184 - ORTHANC__POSTGRESQL__PASSWORD
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
185 secrets:
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
186 ORTHANC__POSTGRESQL__PASSWORD:
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
187 file: ORTHANC__POSTGRESQL__PASSWORD
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
188
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
189
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
190 Mixing configuration
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
191 --------------------
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
192
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
193 Parts of your configuration can be defined in a configuration file,
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
194 another part in an environment variable and yet another in a secret.
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
195 If the same setting is defined in multiple location, the latest one
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
196 will overwrite the first. Settings are evaluated in this order:
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
197
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
198 - JSON files from ``/etc/orthanc/``
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
199 - JSON files from ``/run/secrets`` (Docker secrets are copied there
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
200 by Docker)
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
201 - environment variables
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
202 - secret environment variables
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
203
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
204 At this point, if some settings have not been defined yet, some defaults
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
205 are applied (see below).
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
206
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
207
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
208 Default configuration
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
209 ---------------------
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
210
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
211 .. highlight:: json
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
212
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
213 Orthanc and each plugin might have some default settings that might
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
214 eventually be different from the defaults included in the Orthanc
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
215 executable or the plugin library.
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
216
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
217 .. below json is copied from orthanc-builder/docker/orthanc/orthanc-defaults.json
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
218
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
219 Orthanc non-standard defaults::
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
220
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
221 {
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
222 "StorageDirectory" : "/var/lib/orthanc/db",
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
223
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
224 "RemoteAccessAllowed": true,
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
225 "AuthenticationEnabled": true,
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
226
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
227 "HttpsCACertificates" : "/etc/ssl/certs/ca-certificates.crt",
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
228
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
229 "Plugins" : ["/usr/share/orthanc/plugins/"]
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
230 }
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
231
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
232
575
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 549
diff changeset
233 Default Lua scripts
497
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
234 -------------------
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
235
575
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 549
diff changeset
236 Some Lua scripts are already loaded in the image but are not configured to
497
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
237 be loaded by Orthanc automatically. You'll have to add them to the ``"LuaScripts"``
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
238 configuration if you want to use them.
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
239
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
240 `/lua-scripts/filter-http-tools-reset.lua <https://bitbucket.org/osimis/orthanc-builder/src/master/docker/orthanc/filter-http-tools-reset.lua>`__
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
241 can be used to regenerate the ``/tmp/orthanc.json`` configuration file that is loaded by Orthanc every time
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
242 you POST to ``/tools/reset``. Note that it declares an ``IncomingHttpRequestFilter``
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
243 callback that might conflict with your scripts.
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
244
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
245
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
246 Plugins
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
247 -------
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
248
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
249 Plugins are automatically enabled as soon as you define a setting
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
250 in their JSON section or as soon as you define to ``true`` their
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
251 specific environment variable.
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
252
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
253 Below is a list of all plugins, their environment variable and their default configuration
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
254 (only when their default configuration is different from the plugin defaults):
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
255
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
256
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
257 .. below table is obtained by running orthanc-builder/docker/orthanc/generatePluginDoc.py
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
258
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
259
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
260 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
261 | Plugin | Environment variable | Default configuration |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
262 +==================================================+==================================================+====================================================================================================+
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
263 | **Authorization** | ``AUTHORIZATION_PLUGIN_ENABLED`` | |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
264 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
265 | **ConnectivityChecks** | ``CONNECTIVITY_CHECKS_PLUGIN_ENABLED`` | |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
266 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
267 | **DicomWeb** | ``DICOM_WEB_PLUGIN_ENABLED`` | .. code-block:: json |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
268 | | | |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
269 | | | { |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
270 | | | "DicomWeb": { |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
271 | | | "Enable": true |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
272 | | | } |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
273 | | | } |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
274 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
275 | **Gdcm** | ``GDCM_PLUGIN_ENABLED`` | .. code-block:: json |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
276 | | Note: enabled by default | |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
277 | | | { |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
278 | | | "Gdcm": { |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
279 | | | "Throttling": 4, |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
280 | | | "RestrictTransferSyntaxes": [ |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
281 | | | "1.2.840.10008.1.2.4.90", |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
282 | | | "1.2.840.10008.1.2.4.91", |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
283 | | | "1.2.840.10008.1.2.4.92", |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
284 | | | "1.2.840.10008.1.2.4.93" |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
285 | | | ] |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
286 | | | } |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
287 | | | } |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
288 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
289 | **OrthancWebViewer** | ``ORTHANC_WEB_VIEWER_PLUGIN_ENABLED`` | |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
290 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
687
f4bbb4a7d78a fix environment variable to start the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 636
diff changeset
291 | **StoneWebViewer** (DICOMweb plugin is required) | ``STONE_WEB_VIEWER_PLUGIN_ENABLED`` | |
549
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 497
diff changeset
292 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
497
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
293 | **OsimisWebViewerBasic** | ``OSIMIS_WEB_VIEWER1_PLUGIN_ENABLED`` | |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
294 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
295 | **OsimisWebViewerBasicAlpha** | ``OSIMIS_WEB_VIEWER1_ALPHA_PLUGIN_ENABLED`` | |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
296 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
297 | **PostgreSQL** | ``POSTGRESQL_PLUGIN_ENABLED`` | .. code-block:: json |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
298 | | | |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
299 | | | { |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
300 | | | "PostgreSQL": { |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
301 | | | "EnableIndex": true, |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
302 | | | "EnableStorage": false, |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
303 | | | "Port": 5432, |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
304 | | | "Host": "HOST MUST BE DEFINED", |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
305 | | | "Database": "postgres", |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
306 | | | "Username": "postgres", |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
307 | | | "Password": "postgres", |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
308 | | | "EnableSsl": false, |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
309 | | | "Lock": false |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
310 | | | } |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
311 | | | } |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
312 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
313 | **MySQL** | ``MYSQL_PLUGIN_ENABLED`` | .. code-block:: json |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
314 | | | |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
315 | | | { |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
316 | | | "MySQL": { |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
317 | | | "EnableIndex": true, |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
318 | | | "EnableStorage": false, |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
319 | | | "Port": 3306, |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
320 | | | "Host": "HOST MUST BE DEFINED", |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
321 | | | "Database": "mysql", |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
322 | | | "Username": "root", |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
323 | | | "Password": "mysql", |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
324 | | | "Lock": false |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
325 | | | } |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
326 | | | } |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
327 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
328 | **Python** | ``PYTHON_PLUGIN_ENABLED`` | |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
329 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
330 | **ServeFolders** | ``SERVE_FOLDERS_PLUGIN_ENABLED`` | |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
331 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
332 | **Transfers** | ``TRANSFERS_PLUGIN_ENABLED`` | |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
333 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
334 | **Worklists** | ``WORKLISTS_PLUGIN_ENABLED`` | .. code-block:: json |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
335 | | | |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
336 | | | { |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
337 | | | "Worklists": { |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
338 | | | "Enable": true, |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
339 | | | "Database": "/var/lib/orthanc/worklists" |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
340 | | | } |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
341 | | | } |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
342 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
575
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 549
diff changeset
343 | **Whole-slide imaging** | ``WSI_PLUGIN_ENABLED`` | |
497
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
344 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
345 | **Osimis cloud** (synchronization plugin) | ``OSIMIS_CLOUD_PLUGIN_ENABLED`` | |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
346 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
749
4ae741e351ab osimis docker - ODBC_PLUGIN_ENABLED
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 743
diff changeset
347 | **ODBC** | ``ODBC_PLUGIN_ENABLED`` | .. code-block:: json |
4ae741e351ab osimis docker - ODBC_PLUGIN_ENABLED
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 743
diff changeset
348 | | | |
4ae741e351ab osimis docker - ODBC_PLUGIN_ENABLED
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 743
diff changeset
349 | | | { |
4ae741e351ab osimis docker - ODBC_PLUGIN_ENABLED
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 743
diff changeset
350 | | | "Odbc": { |
4ae741e351ab osimis docker - ODBC_PLUGIN_ENABLED
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 743
diff changeset
351 | | | "EnableIndex": true, |
4ae741e351ab osimis docker - ODBC_PLUGIN_ENABLED
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 743
diff changeset
352 | | | "EnableStorage": false, |
4ae741e351ab osimis docker - ODBC_PLUGIN_ENABLED
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 743
diff changeset
353 | | | "IndexConnectionString": "MUST BE DEFINED", |
4ae741e351ab osimis docker - ODBC_PLUGIN_ENABLED
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 743
diff changeset
354 | | | "StorageConnectionString": "MUST BE DEFINED" |
4ae741e351ab osimis docker - ODBC_PLUGIN_ENABLED
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 743
diff changeset
355 | | | } |
4ae741e351ab osimis docker - ODBC_PLUGIN_ENABLED
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 743
diff changeset
356 | | | } |
4ae741e351ab osimis docker - ODBC_PLUGIN_ENABLED
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 743
diff changeset
357 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
497
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
358
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
359 Under the hood
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
360 --------------
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
361
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
362 The source code that is used to generate the image can be found `here <https://bitbucket.org/osimis/orthanc-builder/src/master/docker/orthanc/Dockerfile>`__.
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
363
575
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 549
diff changeset
364 The Python script that is used at startup can be found `here <https://bitbucket.org/osimis/orthanc-builder/src/master/docker/orthanc/generateConfiguration.py>`__