annotate Sphinx/source/users/docker-osimis.rst @ 393:43c5a1274740

doc for osimis/orthanc images
author Alain Mazy <alain@mazy.be>
date Tue, 21 Apr 2020 15:23:50 +0200
parents
children d44f6f93a987
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
393
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
1 .. _docker-osimis:
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
2 .. highlight:: bash
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
3
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
4
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
5 Osimis Orthanc Docker images
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
6 ============================
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
7
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
8 .. contents::
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
9 :depth: 3
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
10
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
11
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
12 .. warning:: this is a preliminary documentation for images that are not publicly available yet
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
13
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
14 Introduction
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
15 ------------
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
16
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
17 Our commercial partner `Osimis <https://www.osimis.io>`__
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
18 `publishes separated Docker images
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
19 <https://hub.docker.com/repository/docker/osimis/orthanc>`__
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
20 that are used by their technical team in order to provide professional
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
21 support to their customers.
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
22
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
23 These images have been designed to be used with ``docker-compose`` and
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
24 provide a configuration system through:
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
25
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
26 - environment variables
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
27 - Docker secrets
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
28 - classical configuration files
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
29 - a mix of these options
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
30
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
31 This `repository <https://bitbucket.org/osimis/orthanc-setup-samples/src>`__
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
32 contains lots of examples on how to use these images. In particular,
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
33 `this example <https://bitbucket.org/osimis/orthanc-setup-samples/src/new-images/docker/all-usages/docker-compose.yml>`__
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
34 shows all the way that can be used to generate the same
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
35 configuration in Orthanc.
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
36
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
37 Note that these images have been re-written in April 2020. The documentation
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
38 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>`__
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
39
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
40 Environmnent variables
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
41 ----------------------
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
42
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
43 Any part of the Orthanc configuration file can be configured through an
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
44 environment variable. Now that Orthanc and its plugins have hundreds of
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
45 configuration parameter, listing all these environment variable would be
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
46 too long. That's why we have defined a standard way of naming the variable:
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
47
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
48 +---------------------------+----------------------------------------------+----------------------------------------------------------------+
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
49 | Orthanc configuration | Environment variable | Sample value |
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
50 +===========================+==============================================+================================================================+
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
51 | StableAge | ORTHANC__STABLE_AGE | ``30`` |
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
52 +---------------------------+----------------------------------------------+----------------------------------------------------------------+
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
53 | DicomWeb.Root | ORTHANC__DICOM_WEB__ROOT | ``/dicom-web/`` |
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
54 +---------------------------+----------------------------------------------+----------------------------------------------------------------+
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
55 | DicomWeb.Servers | ORTHANC__DICOM_WEB__SERVERS | ``{"sample": [ "http://127.0.0.1/dicom-web/"]}`` |
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
56 +---------------------------+----------------------------------------------+----------------------------------------------------------------+
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
57
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
58 To find out a environment variable name from an Orthanc configuration
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
59 (i.e. ``DicomWeb.StudiesMetadata`` is the ``path`` to a setting):
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
60
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
61 - everytime a word contains a capital letter, insert an underscore ``_`` in front.
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
62 ``DicomWeb.StudiesMetadata`` now becomes ``Dicom_Web.Studies_Metadata``
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
63 - everytime you go down one level in the json configuration, insert
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
64 a double underscore ``__``. ``Dicom_Web.Studies_Metadata`` now becomes
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
65 ``Dicom_Web__Studies_Metadata``
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
66 - capitalize all letters. ``Dicom_Web__Studies_Metadata`` now becomes
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
67 ``DICOM_WEB__STUDIES_METADATA``
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
68 - add ``ORTHANC__`` in front. ``DICOM_WEB__STUDIES_METADATA`` now becomes
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
69 ``ORTHANC__DICOM_WEB__STUDIES_METADATA``
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
70
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
71
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
72 Special environment variables
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
73 -----------------------------
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
74
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
75 Other environment variables are not related to the Orthanc configuration file
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
76 but can be specified to control the way Orthanc is run.
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
77
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
78 - ``VERBOSE_STARTUP=true`` will allow you to debug the startup process and see
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
79 the configuration that has been provided to Orthanc. This setup should be
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
80 disabled in production since it might display secret information like passwords
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
81 in your logs
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
82 - ``VERBOSE_ENABLED=true`` will start Orthanc with the ``--verbose`` option
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
83 - ``TRACE_ENABLED=true`` will start Orthanc with the ``--trace`` option
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
84 - ``NO_JOBS=true`` will start Orthanc with the ``--no-jobs`` option
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
85 - ``UNLOCK=true`` will start Orthanc with the ``--unlock`` option
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
86 - ``MALLOC_ARENA_MAX=10`` will :ref:`control memory usage <scalability-memory>`
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
87
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
88
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
89 Configuration files
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
90 -------------------
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
91
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
92 .. highlight:: yaml
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
93
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
94 Configuration files should be stored in the ``/etc/orthanc/`` folder inside the Docker image.
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
95 This is done by building an image thanks to a ``Dockerfile``::
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
96
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
97 FROM osimis/orthanc
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
98 COPY orthanc.json /etc/orthanc/
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
99
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
100
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
101 Configuration files can also be passed as secrets as shown in this ``docker-compose.yml``::
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
102
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
103 version: "3.3"
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
104 services:
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
105 orthanc-file-in-secrets:
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
106 image: osimis/orthanc
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
107 depends_on: [index-db]
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
108 ports: ["8201:8042"]
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
109 environment:
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
110 VERBOSE_STARTUP: "true"
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
111
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
112 secrets:
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
113 - orthanc.secret.json
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
114
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
115 secrets:
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
116 orthanc.secret.json:
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
117 file: orthanc.secret.json
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
118
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
119 Finaly, a whole configuration file can be passed as a JSON through the ``ORTHANC_JSON`` environment variable::
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
120
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
121 version: "3.3"
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
122 services:
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
123 orthanc-file-in-env-var:
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
124 image: osimis/orthanc
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
125 depends_on: [index-db]
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
126 ports: ["8200:8042"]
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
127 environment:
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
128 VERBOSE_ENABLED: "true"
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
129 OSIMIS_WEB_VIEWER1_PLUGIN_ENABLED: "true"
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
130
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
131 ORTHANC_JSON: |
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
132 {
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
133 "Name": "orthanc-file-in-env-var",
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
134 "PostgreSQL" : {
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
135 "Host": "index-db",
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
136 "Password": "pg-password"
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
137 },
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
138 "RegisteredUsers": {
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
139 "demo": "demo"
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
140 }
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
141 }
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
142
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
143
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
144 Docker secrets
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
145 --------------
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
146
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
147 .. highlight:: yaml
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
148
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
149 When using your container in a ``Docker Swarm`` or ``Kubernetes`` environment,
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
150 it is usually to pass sensitive information through ``Docker Secrets``.
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
151 For this purpose, any secret whose name is similar to the name of an
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
152 environment variable is considered as an environment variable::
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
153
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
154 version: "3.3"
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
155 services:
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
156 orthanc-with-direct-secret:
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
157 image: osimis/orthanc
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
158 depends_on: [index-db]
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
159 ports: ["8003:8042"]
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
160 environment:
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
161 ORTHANC__NAME: "orthanc-with-direct-secret"
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
162 VERBOSE_ENABLED: "true"
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
163
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
164 OSIMIS_WEB_VIEWER1_PLUGIN_ENABLED: "true"
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
165
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
166 ORTHANC__POSTGRESQL__HOST: "index-db"
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
167 ORTHANC__REGISTERED_USERS: |
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
168 {"demo": "demo"}
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
169
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
170 secrets:
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
171 - ORTHANC__POSTGRESQL__PASSWORD
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
172 secrets:
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
173 ORTHANC__POSTGRESQL__PASSWORD:
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
174 file: ORTHANC__POSTGRESQL__PASSWORD
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
175
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
176
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
177 Mixing configuration
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
178 --------------------
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
179
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
180 Parts of your configuration can be defined in a configuration file,
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
181 another part in an environment variable and yet another in a secret.
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
182 If the same setting is defined in multiple location, the latest one
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
183 will overwrite the first. Settings are evaluated in this order:
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
184
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
185 - JSON files from ``/etc/orthanc/``
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
186 - JSON files from ``/run/secrets`` (Docker secrets are copied there
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
187 by Docker)
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
188 - environment variables
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
189 - secret environment variables
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
190
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
191 At this point, if some settings have not been defined yet, some defaults
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
192 are applied (see below).
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
193
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
194
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
195 Default configuration
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
196 ---------------------
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
197
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
198 .. highlight:: json
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
199
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
200 Orthanc and each plugin might have some default settings that might
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
201 eventually be different from the defaults included in the Orthanc
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
202 executable or the plugin library.
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
203
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
204 .. below json is copied from orthanc-builder/docker/orthanc/orthanc-defaults.json
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
205
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
206 Orthanc non-standard defaults::
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
207
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
208 {
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
209 "StorageDirectory" : "/var/lib/orthanc/db",
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
210
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
211 "RemoteAccessAllowed": true,
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
212 "AuthenticationEnabled": true,
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
213
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
214 "HttpsCACertificates" : "/etc/ssl/certs/ca-certificates.crt",
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
215
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
216 "Plugins" : ["/usr/share/orthanc/plugins/"]
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
217 }
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
218
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
219
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
220 Plugins
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
221 -------
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
222
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
223 Plugins are automatically enabled as soon as you define a setting
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
224 in their JSON section or as soon as you define to ``true`` their
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
225 specific environment variable.
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
226
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
227 Below is a list of all plugins, their environment variable and their default configuration:
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
228
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
229
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
230 .. below table is obtained by running orthanc-builder/docker/orthanc/generatePluginDoc.py
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
231
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
232
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
233 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
234 | Plugin | Environment variable | Default configuration |
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
235 +==================================================+==================================================+====================================================================================================+
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
236 | **Authorization** | ``AUTHORIZATION_PLUGIN_ENABLED`` | |
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
237 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
238 | **ConnectivityChecks** | ``CONNECTIVITY_CHECKS_PLUGIN_ENABLED`` | |
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
239 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
240 | **DicomWeb** | ``DICOM_WEB_PLUGIN_ENABLED`` | .. code-block:: json |
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
241 | | | |
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
242 | | | { |
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
243 | | | "DicomWeb": { |
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
244 | | | "Enable": true |
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
245 | | | } |
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
246 | | | } |
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
247 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
248 | **GoogleCloudPlatform** | ``GOOGLE_CLOUD_PLATFORM_PLUGIN_ENABLED`` | |
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
249 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
250 | **OrthancWebViewer** | ``ORTHANC_WEB_VIEWER_PLUGIN_ENABLED`` | |
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
251 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
252 | **OsimisWebViewerBasic** | ``OSIMIS_WEB_VIEWER1_PLUGIN_ENABLED`` | |
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
253 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
254 | **OsimisWebViewerBasicAlpha** | ``OSIMIS_WEB_VIEWER1_ALPHA_PLUGIN_ENABLED`` | |
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
255 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
256 | **PostgreSQL** | ``POSTGRESQL_PLUGIN_ENABLED`` | .. code-block:: json |
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
257 | | | |
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
258 | | | { |
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
259 | | | "PostgreSQL": { |
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
260 | | | "EnableIndex": true, |
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
261 | | | "EnableStorage": false, |
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
262 | | | "Port": 5432, |
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
263 | | | "Host": "HOST MUST BE DEFINED", |
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
264 | | | "Database": "postgres", |
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
265 | | | "Username": "postgres", |
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
266 | | | "Password": "postgres", |
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
267 | | | "EnableSsl": false, |
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
268 | | | "Lock": false |
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
269 | | | } |
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
270 | | | } |
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
271 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
272 | **ServeFolders** | ``SERVE_FOLDERS_PLUGIN_ENABLED`` | |
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
273 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
274 | **Transfers** | ``TRANSFERS_PLUGIN_ENABLED`` | |
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
275 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
276 | **Worklists** | ``WORKLISTS_PLUGIN_ENABLED`` | .. code-block:: json |
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
277 | | | |
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
278 | | | { |
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
279 | | | "Worklists": { |
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
280 | | | "Enable": true, |
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
281 | | | "Database": "/var/lib/orthanc/worklists" |
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
282 | | | } |
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
283 | | | } |
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
284 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
285 | **Wsi** | ``WSI_PLUGIN_ENABLED`` | |
43c5a1274740 doc for osimis/orthanc images
Alain Mazy <alain@mazy.be>
parents:
diff changeset
286 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+