Mercurial > hg > orthanc-book

annotate Sphinx/source/users/docker-osimis.rst @ 848:dd3f89d1ab0f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
fix
author Alain Mazy <am@osimis.io>
date Thu, 19 May 2022 09:06:24 +0200
parents e0d5dbbbde99
children ce84b3b381f0
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
830
21a522ca4ce9 osimis/orthanc Docker: links to Github
Alain Mazy <am@osimis.io>
parents: 792
diff changeset
81 Orthanc settings. Therefore, there are some `exceptions <https://github.com/orthanc-server/orthanc-builder/blob/master/docker/orthanc/env-var-non-standards.json>`__ to this rule
497
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
775
eab354bfeb9b osimis/docker: added log env var
Alain Mazy <am@osimis.io>
parents: 767
diff changeset
97 - ``LOGDIR=/logs`` will start Orthanc with the ``--logdir=/logs`` option (introduced in 21.9.1)
eab354bfeb9b osimis/docker: added log env var
Alain Mazy <am@osimis.io>
parents: 767
diff changeset
98 - ``LOGFILE=/logs`` will start Orthanc with the ``--logfile=/logs/orthanc.log`` option (introduced in 21.9.1)
497
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
99 - ``MALLOC_ARENA_MAX=10`` will :ref:`control memory usage <scalability-memory>`
575
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 549
diff changeset
100 - ``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
101 - ``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
102
497
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
103 Configuration files
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
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
106 .. highlight:: yaml
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
107
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
108 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
109 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
110
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
111 FROM osimis/orthanc
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
112 COPY orthanc.json /etc/orthanc/
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
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
115 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
116
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
117 version: "3.3"
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
118 services:
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
119 orthanc-file-in-secrets:
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
120 image: osimis/orthanc
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
121 depends_on: [index-db]
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
122 ports: ["8201:8042"]
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
123 environment:
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
124 VERBOSE_STARTUP: "true"
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
125
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
126 secrets:
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
127 - orthanc.secret.json
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
128
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
129 secrets:
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
130 orthanc.secret.json:
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
131 file: orthanc.secret.json
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
132
575
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 549
diff changeset
133 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
134
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
135 version: "3.3"
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
136 services:
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
137 orthanc-file-in-env-var:
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
138 image: osimis/orthanc
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
139 depends_on: [index-db]
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
140 ports: ["8200:8042"]
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
141 environment:
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
142 VERBOSE_ENABLED: "true"
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
143 OSIMIS_WEB_VIEWER1_PLUGIN_ENABLED: "true"
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
144
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
145 ORTHANC_JSON: |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
146 {
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
147 "Name": "orthanc-file-in-env-var",
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
148 "PostgreSQL" : {
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
149 "Host": "index-db",
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
150 "Password": "pg-password"
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
151 },
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
152 "RegisteredUsers": {
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
153 "demo": "demo"
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
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
158 Docker secrets
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
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
161 .. highlight:: yaml
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
162
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
163 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
164 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
165 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
166 environment variable is considered as an environment variable::
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
167
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
168 version: "3.3"
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
169 services:
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
170 orthanc-with-direct-secret:
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
171 image: osimis/orthanc
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
172 depends_on: [index-db]
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
173 ports: ["8003:8042"]
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
174 environment:
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
175 ORTHANC__NAME: "orthanc-with-direct-secret"
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
176 VERBOSE_ENABLED: "true"
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
177
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
178 OSIMIS_WEB_VIEWER1_PLUGIN_ENABLED: "true"
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
179
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
180 ORTHANC__POSTGRESQL__HOST: "index-db"
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
181 ORTHANC__REGISTERED_USERS: |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
182 {"demo": "demo"}
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
183
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
184 secrets:
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
185 - ORTHANC__POSTGRESQL__PASSWORD
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
186 secrets:
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
187 ORTHANC__POSTGRESQL__PASSWORD:
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
188 file: ORTHANC__POSTGRESQL__PASSWORD
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
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
191 Mixing configuration
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
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
194 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
195 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
196 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
197 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
198
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
199 - JSON files from ``/etc/orthanc/``
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
200 - 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
201 by Docker)
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
202 - environment variables
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
203 - secret environment variables
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
204
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
205 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
206 are applied (see below).
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
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
209 Default configuration
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
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
212 .. highlight:: json
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
213
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
214 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
215 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
216 executable or the plugin library.
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
217
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
218 .. 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
219
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
220 Orthanc non-standard defaults::
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 {
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
223 "StorageDirectory" : "/var/lib/orthanc/db",
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
224
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
225 "RemoteAccessAllowed": true,
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
226 "AuthenticationEnabled": true,
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
227
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
228 "HttpsCACertificates" : "/etc/ssl/certs/ca-certificates.crt",
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
229
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
230 "Plugins" : ["/usr/share/orthanc/plugins/"]
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
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
233
575
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 549
diff changeset
234 Default Lua scripts
497
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
235 -------------------
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
236
575
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 549
diff changeset
237 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
238 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
239 configuration if you want to use them.
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
240
830
21a522ca4ce9 osimis/orthanc Docker: links to Github
Alain Mazy <am@osimis.io>
parents: 792
diff changeset
241 `/lua-scripts/filter-http-tools-reset.lua <https://github.com/orthanc-server/orthanc-builder/blob/master/docker/orthanc/filter-http-tools-reset.lua>`__
497
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
242 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
243 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
244 callback that might conflict with your scripts.
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
245
785
4ff2c6ff472a health check in docker images
Alain Mazy <am@osimis.io>
parents: 781
diff changeset
246 Healthcheck probe
4ff2c6ff472a health check in docker images
Alain Mazy <am@osimis.io>
parents: 781
diff changeset
247 -----------------
4ff2c6ff472a health check in docker images
Alain Mazy <am@osimis.io>
parents: 781
diff changeset
248
830
21a522ca4ce9 osimis/orthanc Docker: links to Github
Alain Mazy <am@osimis.io>
parents: 792
diff changeset
249 In version 21.10.0, the `/probes/test-aliveness.py <https://github.com/orthanc-server/orthanc-builder/blob/master/docker/orthanc/test-aliveness.py>`__
785
4ff2c6ff472a health check in docker images
Alain Mazy <am@osimis.io>
parents: 781
diff changeset
250 script has been added in order to perform healthchecks. Check the doc in the script itself for more details.
4ff2c6ff472a health check in docker images
Alain Mazy <am@osimis.io>
parents: 781
diff changeset
251 A sample configuration is also available in `this sample <https://bitbucket.org/osimis/orthanc-setup-samples/src/8016d140a237a892db703aac4782307c46732847/docker/tls-mutual-auth/docker-compose.yml#lines-51>`__
4ff2c6ff472a health check in docker images
Alain Mazy <am@osimis.io>
parents: 781
diff changeset
252
497
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
253
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
254 Plugins
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 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
258 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
259 specific environment variable.
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 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
262 (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
263
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 .. 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
266
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
267
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 | Plugin | Environment variable | Default configuration |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
270 +==================================================+==================================================+====================================================================================================+
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
271 | **Authorization** | ``AUTHORIZATION_PLUGIN_ENABLED`` | |
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 | **ConnectivityChecks** | ``CONNECTIVITY_CHECKS_PLUGIN_ENABLED`` | |
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 | **DicomWeb** | ``DICOM_WEB_PLUGIN_ENABLED`` | .. code-block:: json |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
276 | | | |
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 | | | "DicomWeb": { |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
279 | | | "Enable": true |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
280 | | | } |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
281 | | | } |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
282 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
283 | **Gdcm** | ``GDCM_PLUGIN_ENABLED`` | .. code-block:: json |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
284 | | Note: enabled by default | |
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 | | | "Gdcm": { |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
287 | | | "Throttling": 4, |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
288 | | | "RestrictTransferSyntaxes": [ |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
289 | | | "1.2.840.10008.1.2.4.90", |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
290 | | | "1.2.840.10008.1.2.4.91", |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
291 | | | "1.2.840.10008.1.2.4.92", |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
292 | | | "1.2.840.10008.1.2.4.93" |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
293 | | | ] |
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 | | | } |
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 | **OrthancWebViewer** | ``ORTHANC_WEB_VIEWER_PLUGIN_ENABLED`` | |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
298 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
767
9130cb19dc4d updated docker osimis plugins
Alain Mazy <am@osimis.io>
parents: 749
diff changeset
299 | **StoneWebViewer** | ``STONE_WEB_VIEWER_PLUGIN_ENABLED`` | |
549
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 497
diff changeset
300 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
497
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
301 | **OsimisWebViewerBasic** | ``OSIMIS_WEB_VIEWER1_PLUGIN_ENABLED`` | |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
302 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
303 | **OsimisWebViewerBasicAlpha** | ``OSIMIS_WEB_VIEWER1_ALPHA_PLUGIN_ENABLED`` | |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
304 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
305 | **PostgreSQL** | ``POSTGRESQL_PLUGIN_ENABLED`` | .. code-block:: json |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
306 | | | |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
307 | | | { |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
308 | | | "PostgreSQL": { |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
309 | | | "EnableIndex": true, |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
310 | | | "EnableStorage": false, |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
311 | | | "Port": 5432, |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
312 | | | "Host": "HOST MUST BE DEFINED", |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
313 | | | "Database": "postgres", |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
314 | | | "Username": "postgres", |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
315 | | | "Password": "postgres", |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
316 | | | "EnableSsl": false, |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
317 | | | "Lock": false |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
318 | | | } |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
319 | | | } |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
320 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
321 | **MySQL** | ``MYSQL_PLUGIN_ENABLED`` | .. code-block:: json |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
322 | | | |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
323 | | | { |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
324 | | | "MySQL": { |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
325 | | | "EnableIndex": true, |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
326 | | | "EnableStorage": false, |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
327 | | | "Port": 3306, |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
328 | | | "Host": "HOST MUST BE DEFINED", |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
329 | | | "Database": "mysql", |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
330 | | | "Username": "root", |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
331 | | | "Password": "mysql", |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
332 | | | "Lock": false |
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 | | | } |
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 | **Python** | ``PYTHON_PLUGIN_ENABLED`` | |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
337 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
338 | **ServeFolders** | ``SERVE_FOLDERS_PLUGIN_ENABLED`` | |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
339 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
340 | **Transfers** | ``TRANSFERS_PLUGIN_ENABLED`` | |
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 | **Worklists** | ``WORKLISTS_PLUGIN_ENABLED`` | .. code-block:: json |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
343 | | | |
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 | | | "Worklists": { |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
346 | | | "Enable": true, |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
347 | | | "Database": "/var/lib/orthanc/worklists" |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
348 | | | } |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
349 | | | } |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
350 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
841
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
351 | **Housekeeper** | ``HOUSEKEEPER_PLUGIN_ENABLED`` | .. code-block:: json |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
352 | | | |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
353 | | | { |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
354 | | | "Housekeeper": { |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
355 | | | "Enable": false |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
356 | | | } |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
357 | | | } |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
358 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
767
9130cb19dc4d updated docker osimis plugins
Alain Mazy <am@osimis.io>
parents: 749
diff changeset
359 | **Wsi** | ``WSI_PLUGIN_ENABLED`` | |
497
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
360 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
767
9130cb19dc4d updated docker osimis plugins
Alain Mazy <am@osimis.io>
parents: 749
diff changeset
361 | **Odbc** | ``ODBC_PLUGIN_ENABLED`` | .. code-block:: json |
749
4ae741e351ab osimis docker - ODBC_PLUGIN_ENABLED
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 743
diff changeset
362 | | | |
4ae741e351ab osimis docker - ODBC_PLUGIN_ENABLED
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 743
diff changeset
363 | | | { |
4ae741e351ab osimis docker - ODBC_PLUGIN_ENABLED
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 743
diff changeset
364 | | | "Odbc": { |
4ae741e351ab osimis docker - ODBC_PLUGIN_ENABLED
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 743
diff changeset
365 | | | "EnableIndex": true, |
4ae741e351ab osimis docker - ODBC_PLUGIN_ENABLED
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 743
diff changeset
366 | | | "EnableStorage": false, |
4ae741e351ab osimis docker - ODBC_PLUGIN_ENABLED
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 743
diff changeset
367 | | | "IndexConnectionString": "MUST BE DEFINED", |
4ae741e351ab osimis docker - ODBC_PLUGIN_ENABLED
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 743
diff changeset
368 | | | "StorageConnectionString": "MUST BE DEFINED" |
4ae741e351ab osimis docker - ODBC_PLUGIN_ENABLED
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 743
diff changeset
369 | | | } |
4ae741e351ab osimis docker - ODBC_PLUGIN_ENABLED
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 743
diff changeset
370 | | | } |
4ae741e351ab osimis docker - ODBC_PLUGIN_ENABLED
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 743
diff changeset
371 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
767
9130cb19dc4d updated docker osimis plugins
Alain Mazy <am@osimis.io>
parents: 749
diff changeset
372 | **Tcia** | ``TCIA_PLUGIN_ENABLED`` | .. code-block:: json |
9130cb19dc4d updated docker osimis plugins
Alain Mazy <am@osimis.io>
parents: 749
diff changeset
373 | | | |
9130cb19dc4d updated docker osimis plugins
Alain Mazy <am@osimis.io>
parents: 749
diff changeset
374 | | | { |
9130cb19dc4d updated docker osimis plugins
Alain Mazy <am@osimis.io>
parents: 749
diff changeset
375 | | | "Tcia": { |
9130cb19dc4d updated docker osimis plugins
Alain Mazy <am@osimis.io>
parents: 749
diff changeset
376 | | | "Enable": true |
9130cb19dc4d updated docker osimis plugins
Alain Mazy <am@osimis.io>
parents: 749
diff changeset
377 | | | } |
9130cb19dc4d updated docker osimis plugins
Alain Mazy <am@osimis.io>
parents: 749
diff changeset
378 | | | } |
9130cb19dc4d updated docker osimis plugins
Alain Mazy <am@osimis.io>
parents: 749
diff changeset
379 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
781
ededfacf9a8d new index plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 775
diff changeset
380 | **Indexer** | ``INDEXER_PLUGIN_ENABLED`` | .. code-block:: json |
ededfacf9a8d new index plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 775
diff changeset
381 | | | |
ededfacf9a8d new index plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 775
diff changeset
382 | | | { |
ededfacf9a8d new index plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 775
diff changeset
383 | | | "Indexer": { |
ededfacf9a8d new index plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 775
diff changeset
384 | | | "Enable": true |
ededfacf9a8d new index plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 775
diff changeset
385 | | | } |
ededfacf9a8d new index plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 775
diff changeset
386 | | | } |
ededfacf9a8d new index plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 775
diff changeset
387 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
841
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
388 | **Neuro** | ``NEURO_PLUGIN_ENABLED`` | .. code-block:: json |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
389 | | | |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
390 | | | { |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
391 | | | "Neuro": { |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
392 | | | "Enable": true |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
393 | | | } |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
394 | | | } |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
395 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
396 | **AzureBlobStorage** | ``AZURE_BLOB_STORAGE_PLUGIN_ENABLED`` | .. code-block:: json |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
397 | | | |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
398 | | | { |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
399 | | | "AzureBlobStorage": { |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
400 | | | "ConnectionString": "MUST BE DEFINED BY YOU", |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
401 | | | "ContainerName": "MUST BE DEFINED BY YOU" |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
402 | | | } |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
403 | | | } |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
404 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
405 | **AwsS3Storage** | ``AWS_S3_STORAGE_PLUGIN_ENABLED`` | .. code-block:: json |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
406 | | | |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
407 | | | { |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
408 | | | "AwsS3Storage": { |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
409 | | | "BucketName": "MUST BE DEFINED BY YOU", |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
410 | | | "Region": "MUST BE DEFINED BY YOU" |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
411 | | | } |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
412 | | | } |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
413 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
414 | **GoogleCloudStorage** | ``GOOGLE_CLOUD_STORAGE_PLUGIN_ENABLED`` | .. code-block:: json |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
415 | | | |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
416 | | | { |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
417 | | | "GoogleCloudStorage": { |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
418 | | | "ServiceAccountFile": "MUST BE DEFINED BY YOU", |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
419 | | | "BucketName": "MUST BE DEFINED BY YOU" |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
420 | | | } |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
421 | | | } |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
422 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
423 | **OrthancExplorer2** | ``ORTHANC_EXPLORER_2_ENABLED`` | .. code-block:: json |
848
Alain Mazy <am@osimis.io>
parents: 841
diff changeset
424 | | Note: enabled by default | |
841
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
425 | | | { |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
426 | | | "OrthancExplorer2": { |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
427 | | | "Enable": true, |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
428 | | | "IsDefaultOrthancUI": false |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
429 | | | } |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
430 | | | } |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
431 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
497
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
432
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
433 Under the hood
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
434 --------------
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
435
830
21a522ca4ce9 osimis/orthanc Docker: links to Github
Alain Mazy <am@osimis.io>
parents: 792
diff changeset
436 The source code that is used to generate the image can be found `here <https://github.com/orthanc-server/orthanc-builder/blob/master/docker/orthanc/Dockerfile>`__.
497
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
437
830
21a522ca4ce9 osimis/orthanc Docker: links to Github
Alain Mazy <am@osimis.io>
parents: 792
diff changeset
438 The Python script that is used at startup can be found `here <https://github.com/orthanc-server/orthanc-builder/blob/master/docker/orthanc/generateConfiguration.py>`__