Mercurial > hg > orthanc-book

annotate Sphinx/source/users/docker-osimis.rst @ 962:5df222ddd7d1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
fix links to setup-samples
author Alain Mazy <am@osimis.io>
date Wed, 28 Jun 2023 09:23:16 +0200
parents 91273763cb94
children 7f21ad59dffb b00f7426db52
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
882
815f70009ec2 highlight osimis/orthanc docker images since jodogne/orthanc images are currently not up-to-date
Alain Mazy <am@osimis.io>
parents: 875
diff changeset
5 osimis/orthanc Docker images
497
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
857
ce84b3b381f0 osimis images 'full'
Alain Mazy <am@osimis.io>
parents: 848
diff changeset
11 .. warning::
497
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
12
857
ce84b3b381f0 osimis images 'full'
Alain Mazy <am@osimis.io>
parents: 848
diff changeset
13 Starting from the ``22.6.1`` release, we are providing 2 types of images:
ce84b3b381f0 osimis images 'full'
Alain Mazy <am@osimis.io>
parents: 848
diff changeset
14
ce84b3b381f0 osimis images 'full'
Alain Mazy <am@osimis.io>
parents: 848
diff changeset
15 - the default image with the usual tag: e.g ``22.6.1``
ce84b3b381f0 osimis images 'full'
Alain Mazy <am@osimis.io>
parents: 848
diff changeset
16 - the full image with a e.g ``22.6.1-full`` tag
ce84b3b381f0 osimis images 'full'
Alain Mazy <am@osimis.io>
parents: 848
diff changeset
17
ce84b3b381f0 osimis images 'full'
Alain Mazy <am@osimis.io>
parents: 848
diff changeset
18 The default image is suitable for 99.9% of users.
ce84b3b381f0 osimis images 'full'
Alain Mazy <am@osimis.io>
parents: 848
diff changeset
19
ce84b3b381f0 osimis images 'full'
Alain Mazy <am@osimis.io>
parents: 848
diff changeset
20 You should use the full image only if you need to use one of these:
ce84b3b381f0 osimis images 'full'
Alain Mazy <am@osimis.io>
parents: 848
diff changeset
21
ce84b3b381f0 osimis images 'full'
Alain Mazy <am@osimis.io>
parents: 848
diff changeset
22 - the Azure Blob storage plugin
ce84b3b381f0 osimis images 'full'
Alain Mazy <am@osimis.io>
parents: 848
diff changeset
23 - the Google Cloud storage plugin
ce84b3b381f0 osimis images 'full'
Alain Mazy <am@osimis.io>
parents: 848
diff changeset
24 - the ODBC plugin with SQL Server (msodbcsql18 is preinstalled)
ce84b3b381f0 osimis images 'full'
Alain Mazy <am@osimis.io>
parents: 848
diff changeset
25
ce84b3b381f0 osimis images 'full'
Alain Mazy <am@osimis.io>
parents: 848
diff changeset
26
ce84b3b381f0 osimis images 'full'
Alain Mazy <am@osimis.io>
parents: 848
diff changeset
27 .. warning::
ce84b3b381f0 osimis images 'full'
Alain Mazy <am@osimis.io>
parents: 848
diff changeset
28 This documentation applies to ``osimis/orthanc`` images from the ``20.4.2`` version.
497
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
29
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
30 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
31 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
32
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
33 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
34 Google Cloud Platform configuration.
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
35
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
36 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
37 encouraging you to update to the new namings since the backward compatibility
857
ce84b3b381f0 osimis images 'full'
Alain Mazy <am@osimis.io>
parents: 848
diff changeset
38 might be removed at any time.
497
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
39
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
40
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
41 Introduction
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
42 ------------
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
43
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
44 Our commercial partner `Osimis <https://www.osimis.io>`__
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
45 `publishes separated Docker images
883
Alain Mazy <am@osimis.io>
parents: 882
diff changeset
46 <https://hub.docker.com/r/osimis/orthanc>`__.
497
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
47 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
48 provide a configuration system through:
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
49
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
50 - environment variables
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
51 - Docker secrets
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
52 - classical configuration files
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
53 - a mix of these options
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
54
947
0b89127439b1 new orthanc-setup-samples repo
Alain Mazy <am@osimis.io>
parents: 926
diff changeset
55 This `repository <https://github.com/orthanc-server/orthanc-setup-samples/src>`__
497
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
56 contains lots of examples on how to use these images. In particular,
962
5df222ddd7d1 fix links to setup-samples
Alain Mazy <am@osimis.io>
parents: 960
diff changeset
57 `this example <https://github.com/orthanc-server/orthanc-setup-samples/tree/master/docker/all-usages/docker-compose.yml>`__
497
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
58 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
59 configuration in Orthanc.
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
60
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
61
575
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 549
diff changeset
62 Environment variables
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 549
diff changeset
63 ---------------------
497
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
64
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
65 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
66 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
67 configuration parameter, listing all these environment variable would be
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
68 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
69
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
70 +---------------------------+----------------------------------------------+----------------------------------------------------------------+
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
71 | Orthanc configuration | Environment variable | Sample value |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
72 +===========================+==============================================+================================================================+
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
73 | StableAge | ORTHANC__STABLE_AGE | ``30`` |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
74 +---------------------------+----------------------------------------------+----------------------------------------------------------------+
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
75 | DicomWeb.Root | ORTHANC__DICOM_WEB__ROOT | ``/dicom-web/`` |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
76 +---------------------------+----------------------------------------------+----------------------------------------------------------------+
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
77 | 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
78 +---------------------------+----------------------------------------------+----------------------------------------------------------------+
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 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
81 (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
82
575
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 549
diff changeset
83 - 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
84 ``DicomWeb.StudiesMetadata`` now becomes ``Dicom_Web.Studies_Metadata``
575
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 549
diff changeset
85 - 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
86 a double underscore ``__``. ``Dicom_Web.Studies_Metadata`` now becomes
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
87 ``Dicom_Web__Studies_Metadata``
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
88 - capitalize all letters. ``Dicom_Web__Studies_Metadata`` now becomes
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
89 ``DICOM_WEB__STUDIES_METADATA``
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
90 - 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
91 ``ORTHANC__DICOM_WEB__STUDIES_METADATA``
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
92
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
93 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
94 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
95 that are however quite intuitive.
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
96
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
97 Special environment variables
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
98 -----------------------------
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
99
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
100 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
101 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
102
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
103 - ``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
104 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
105 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
106 in your logs
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
107 - ``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
108 - ``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
109 - ``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
110 - ``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
111 - ``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
112 - ``MALLOC_ARENA_MAX=10`` will :ref:`control memory usage <scalability-memory>`
575
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 549
diff changeset
113 - ``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
114 - ``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.
875
1006435326a7 new env var for osimis/orthanc
Alain Mazy <am@osimis.io>
parents: 862
diff changeset
115 - ``FORCE_HOST_ID`` and ``GENERATE_HOST_ID_IF_MISSING`` can be used to control the content of /etc/hostid (introduced in 22.9.1).
1006435326a7 new env var for osimis/orthanc
Alain Mazy <am@osimis.io>
parents: 862
diff changeset
116 DCMTK calls gethostid() when generating DICOM UIDs (used, e.g, in modifications/anonymizations).
1006435326a7 new env var for osimis/orthanc
Alain Mazy <am@osimis.io>
parents: 862
diff changeset
117 When /etc/hostid is missing, the system tries to generate it from the IP of the system.
1006435326a7 new env var for osimis/orthanc
Alain Mazy <am@osimis.io>
parents: 862
diff changeset
118 On some system, in particular circumstances, we have observed that the system performs a DNS query
1006435326a7 new env var for osimis/orthanc
Alain Mazy <am@osimis.io>
parents: 862
diff changeset
119 to get the IP of the system. This DNS can timeout (after multiple with retries) and, in particular cases,
1006435326a7 new env var for osimis/orthanc
Alain Mazy <am@osimis.io>
parents: 862
diff changeset
120 we have observed a delay of 40 seconds to generate a single DICOM UID in Orthanc.
1006435326a7 new env var for osimis/orthanc
Alain Mazy <am@osimis.io>
parents: 862
diff changeset
121 Therefore, if /etc/hostid is missing, the startup script creates it and fill it with a random number (default behaviour).
1006435326a7 new env var for osimis/orthanc
Alain Mazy <am@osimis.io>
parents: 862
diff changeset
122 This behaviour can still be deactivated by defining ``GENERATE_HOST_ID_IF_MISSING=false``.
1006435326a7 new env var for osimis/orthanc
Alain Mazy <am@osimis.io>
parents: 862
diff changeset
123 The host id can also be forced by defining ``FORCE_HOST_ID``.
1006435326a7 new env var for osimis/orthanc
Alain Mazy <am@osimis.io>
parents: 862
diff changeset
124
1006435326a7 new env var for osimis/orthanc
Alain Mazy <am@osimis.io>
parents: 862
diff changeset
125
1006435326a7 new env var for osimis/orthanc
Alain Mazy <am@osimis.io>
parents: 862
diff changeset
126
497
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
127 Configuration files
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
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
130 .. highlight:: yaml
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
131
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
132 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
133 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
134
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
135 FROM osimis/orthanc
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
136 COPY orthanc.json /etc/orthanc/
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
137
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
138
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
139 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
140
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
141 version: "3.3"
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
142 services:
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
143 orthanc-file-in-secrets:
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
144 image: osimis/orthanc
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
145 depends_on: [index-db]
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
146 ports: ["8201:8042"]
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
147 environment:
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
148 VERBOSE_STARTUP: "true"
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
149
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
150 secrets:
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
151 - orthanc.secret.json
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
152
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
153 secrets:
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
154 orthanc.secret.json:
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
155 file: orthanc.secret.json
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
156
575
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 549
diff changeset
157 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
158
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
159 version: "3.3"
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
160 services:
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
161 orthanc-file-in-env-var:
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
162 image: osimis/orthanc
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
163 depends_on: [index-db]
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
164 ports: ["8200:8042"]
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
165 environment:
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
166 VERBOSE_ENABLED: "true"
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
167 OSIMIS_WEB_VIEWER1_PLUGIN_ENABLED: "true"
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
168
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
169 ORTHANC_JSON: |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
170 {
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
171 "Name": "orthanc-file-in-env-var",
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
172 "PostgreSQL" : {
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
173 "Host": "index-db",
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
174 "Password": "pg-password"
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
175 },
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
176 "RegisteredUsers": {
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
177 "demo": "demo"
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
178 }
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
179 }
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
180
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
181
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
182 Docker secrets
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
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
185 .. highlight:: yaml
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
186
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
187 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
188 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
189 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
190 environment variable is considered as an environment variable::
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
191
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
192 version: "3.3"
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
193 services:
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
194 orthanc-with-direct-secret:
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
195 image: osimis/orthanc
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
196 depends_on: [index-db]
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
197 ports: ["8003:8042"]
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
198 environment:
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
199 ORTHANC__NAME: "orthanc-with-direct-secret"
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
200 VERBOSE_ENABLED: "true"
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
201
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
202 OSIMIS_WEB_VIEWER1_PLUGIN_ENABLED: "true"
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
203
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
204 ORTHANC__POSTGRESQL__HOST: "index-db"
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
205 ORTHANC__REGISTERED_USERS: |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
206 {"demo": "demo"}
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 secrets:
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
209 - ORTHANC__POSTGRESQL__PASSWORD
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
210 secrets:
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
211 ORTHANC__POSTGRESQL__PASSWORD:
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
212 file: ORTHANC__POSTGRESQL__PASSWORD
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
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
215 Mixing configuration
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
216 --------------------
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
217
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
218 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
219 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
220 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
221 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
222
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
223 - JSON files from ``/etc/orthanc/``
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
224 - 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
225 by Docker)
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
226 - environment variables
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
227 - secret environment variables
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
228
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
229 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
230 are applied (see below).
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 Default configuration
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
234 ---------------------
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
235
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
236 .. highlight:: json
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
237
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
238 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
239 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
240 executable or the plugin library.
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
241
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
242 .. 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
243
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
244 Orthanc non-standard defaults::
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
245
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
246 {
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
247 "StorageDirectory" : "/var/lib/orthanc/db",
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
248
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
249 "RemoteAccessAllowed": true,
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
250 "AuthenticationEnabled": true,
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
251
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
252 "HttpsCACertificates" : "/etc/ssl/certs/ca-certificates.crt",
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" : ["/usr/share/orthanc/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
575
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 549
diff changeset
258 Default Lua scripts
497
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
259 -------------------
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
260
575
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 549
diff changeset
261 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
262 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
263 configuration if you want to use them.
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
264
830
21a522ca4ce9 osimis/orthanc Docker: links to Github
Alain Mazy <am@osimis.io>
parents: 792
diff changeset
265 `/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
266 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
267 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
268 callback that might conflict with your scripts.
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
269
785
4ff2c6ff472a health check in docker images
Alain Mazy <am@osimis.io>
parents: 781
diff changeset
270 Healthcheck probe
4ff2c6ff472a health check in docker images
Alain Mazy <am@osimis.io>
parents: 781
diff changeset
271 -----------------
4ff2c6ff472a health check in docker images
Alain Mazy <am@osimis.io>
parents: 781
diff changeset
272
830
21a522ca4ce9 osimis/orthanc Docker: links to Github
Alain Mazy <am@osimis.io>
parents: 792
diff changeset
273 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
274 script has been added in order to perform healthchecks. Check the doc in the script itself for more details.
947
0b89127439b1 new orthanc-setup-samples repo
Alain Mazy <am@osimis.io>
parents: 926
diff changeset
275 A sample configuration is also available in `this sample <https://github.com/orthanc-server/orthanc-setup-samples/src/8016d140a237a892db703aac4782307c46732847/docker/tls-mutual-auth/docker-compose.yml#lines-51>`__
785
4ff2c6ff472a health check in docker images
Alain Mazy <am@osimis.io>
parents: 781
diff changeset
276
497
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 Plugins
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
279 -------
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 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
282 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
283 specific environment variable.
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
284
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
285 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
286 (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
287
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
288
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
289 .. 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
290
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
291
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
292 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
293 | Plugin | Environment variable | Default configuration |
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 | **Authorization** | ``AUTHORIZATION_PLUGIN_ENABLED`` | |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
296 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
297 | **ConnectivityChecks** | ``CONNECTIVITY_CHECKS_PLUGIN_ENABLED`` | |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
298 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
299 | **DicomWeb** | ``DICOM_WEB_PLUGIN_ENABLED`` | .. code-block:: json |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
300 | | | |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
301 | | | { |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
302 | | | "DicomWeb": { |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
303 | | | "Enable": true |
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 | | | } |
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 | **Gdcm** | ``GDCM_PLUGIN_ENABLED`` | .. code-block:: json |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
308 | | Note: enabled by default | |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
309 | | | { |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
310 | | | "Gdcm": { |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
311 | | | "Throttling": 4, |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
312 | | | "RestrictTransferSyntaxes": [ |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
313 | | | "1.2.840.10008.1.2.4.90", |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
314 | | | "1.2.840.10008.1.2.4.91", |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
315 | | | "1.2.840.10008.1.2.4.92", |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
316 | | | "1.2.840.10008.1.2.4.93" |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
317 | | | ] |
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 | **OrthancWebViewer** | ``ORTHANC_WEB_VIEWER_PLUGIN_ENABLED`` | |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
322 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
767
9130cb19dc4d updated docker osimis plugins
Alain Mazy <am@osimis.io>
parents: 749
diff changeset
323 | **StoneWebViewer** | ``STONE_WEB_VIEWER_PLUGIN_ENABLED`` | |
549
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 497
diff changeset
324 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
497
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
325 | **OsimisWebViewerBasic** | ``OSIMIS_WEB_VIEWER1_PLUGIN_ENABLED`` | |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
326 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
327 | **OsimisWebViewerBasicAlpha** | ``OSIMIS_WEB_VIEWER1_ALPHA_PLUGIN_ENABLED`` | |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
328 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
329 | **PostgreSQL** | ``POSTGRESQL_PLUGIN_ENABLED`` | .. code-block:: json |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
330 | | | |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
331 | | | { |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
332 | | | "PostgreSQL": { |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
333 | | | "EnableIndex": true, |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
334 | | | "EnableStorage": false, |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
335 | | | "Port": 5432, |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
336 | | | "Host": "HOST MUST BE DEFINED", |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
337 | | | "Database": "postgres", |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
338 | | | "Username": "postgres", |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
339 | | | "Password": "postgres", |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
340 | | | "EnableSsl": false, |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
341 | | | "Lock": false |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
342 | | | } |
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 | **MySQL** | ``MYSQL_PLUGIN_ENABLED`` | .. code-block:: json |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
346 | | | |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
347 | | | { |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
348 | | | "MySQL": { |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
349 | | | "EnableIndex": true, |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
350 | | | "EnableStorage": false, |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
351 | | | "Port": 3306, |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
352 | | | "Host": "HOST MUST BE DEFINED", |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
353 | | | "Database": "mysql", |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
354 | | | "Username": "root", |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
355 | | | "Password": "mysql", |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
356 | | | "Lock": false |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
357 | | | } |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
358 | | | } |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
359 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
360 | **Python** | ``PYTHON_PLUGIN_ENABLED`` | |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
361 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
362 | **ServeFolders** | ``SERVE_FOLDERS_PLUGIN_ENABLED`` | |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
363 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
364 | **Transfers** | ``TRANSFERS_PLUGIN_ENABLED`` | |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
365 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
366 | **Worklists** | ``WORKLISTS_PLUGIN_ENABLED`` | .. code-block:: json |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
367 | | | |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
368 | | | { |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
369 | | | "Worklists": { |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
370 | | | "Enable": true, |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
371 | | | "Database": "/var/lib/orthanc/worklists" |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
372 | | | } |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
373 | | | } |
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
374 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
841
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
375 | **Housekeeper** | ``HOUSEKEEPER_PLUGIN_ENABLED`` | .. code-block:: json |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
376 | | | |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
377 | | | { |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
378 | | | "Housekeeper": { |
862
71e339681c6b delayed deletion
Alain Mazy <am@osimis.io>
parents: 857
diff changeset
379 | | | "Enable": true |
71e339681c6b delayed deletion
Alain Mazy <am@osimis.io>
parents: 857
diff changeset
380 | | | } |
71e339681c6b delayed deletion
Alain Mazy <am@osimis.io>
parents: 857
diff changeset
381 | | | } |
71e339681c6b delayed deletion
Alain Mazy <am@osimis.io>
parents: 857
diff changeset
382 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
71e339681c6b delayed deletion
Alain Mazy <am@osimis.io>
parents: 857
diff changeset
383 | **DelayedDeletion** | ``DELAYED_DELETION_PLUGIN_ENABLED`` | .. code-block:: json |
71e339681c6b delayed deletion
Alain Mazy <am@osimis.io>
parents: 857
diff changeset
384 | | | |
71e339681c6b delayed deletion
Alain Mazy <am@osimis.io>
parents: 857
diff changeset
385 | | | { |
71e339681c6b delayed deletion
Alain Mazy <am@osimis.io>
parents: 857
diff changeset
386 | | | "DelayedDeletion": { |
71e339681c6b delayed deletion
Alain Mazy <am@osimis.io>
parents: 857
diff changeset
387 | | | "Enable": true |
841
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
388 | | | } |
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 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
960
91273763cb94 updated env var
Alain Mazy <am@osimis.io>
parents: 947
diff changeset
391 | **MultitenantDicom** | ``MULTITENANT_DICOM_PLUGIN_ENABLED`` | |
91273763cb94 updated env var
Alain Mazy <am@osimis.io>
parents: 947
diff changeset
392 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
767
9130cb19dc4d updated docker osimis plugins
Alain Mazy <am@osimis.io>
parents: 749
diff changeset
393 | **Wsi** | ``WSI_PLUGIN_ENABLED`` | |
497
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
394 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
767
9130cb19dc4d updated docker osimis plugins
Alain Mazy <am@osimis.io>
parents: 749
diff changeset
395 | **Odbc** | ``ODBC_PLUGIN_ENABLED`` | .. code-block:: json |
749
4ae741e351ab osimis docker - ODBC_PLUGIN_ENABLED
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 743
diff changeset
396 | | | |
4ae741e351ab osimis docker - ODBC_PLUGIN_ENABLED
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 743
diff changeset
397 | | | { |
4ae741e351ab osimis docker - ODBC_PLUGIN_ENABLED
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 743
diff changeset
398 | | | "Odbc": { |
4ae741e351ab osimis docker - ODBC_PLUGIN_ENABLED
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 743
diff changeset
399 | | | "EnableIndex": true, |
4ae741e351ab osimis docker - ODBC_PLUGIN_ENABLED
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 743
diff changeset
400 | | | "EnableStorage": false, |
4ae741e351ab osimis docker - ODBC_PLUGIN_ENABLED
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 743
diff changeset
401 | | | "IndexConnectionString": "MUST BE DEFINED", |
4ae741e351ab osimis docker - ODBC_PLUGIN_ENABLED
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 743
diff changeset
402 | | | "StorageConnectionString": "MUST BE DEFINED" |
4ae741e351ab osimis docker - ODBC_PLUGIN_ENABLED
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 743
diff changeset
403 | | | } |
4ae741e351ab osimis docker - ODBC_PLUGIN_ENABLED
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 743
diff changeset
404 | | | } |
4ae741e351ab osimis docker - ODBC_PLUGIN_ENABLED
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 743
diff changeset
405 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
767
9130cb19dc4d updated docker osimis plugins
Alain Mazy <am@osimis.io>
parents: 749
diff changeset
406 | **Tcia** | ``TCIA_PLUGIN_ENABLED`` | .. code-block:: json |
9130cb19dc4d updated docker osimis plugins
Alain Mazy <am@osimis.io>
parents: 749
diff changeset
407 | | | |
9130cb19dc4d updated docker osimis plugins
Alain Mazy <am@osimis.io>
parents: 749
diff changeset
408 | | | { |
9130cb19dc4d updated docker osimis plugins
Alain Mazy <am@osimis.io>
parents: 749
diff changeset
409 | | | "Tcia": { |
9130cb19dc4d updated docker osimis plugins
Alain Mazy <am@osimis.io>
parents: 749
diff changeset
410 | | | "Enable": true |
9130cb19dc4d updated docker osimis plugins
Alain Mazy <am@osimis.io>
parents: 749
diff changeset
411 | | | } |
9130cb19dc4d updated docker osimis plugins
Alain Mazy <am@osimis.io>
parents: 749
diff changeset
412 | | | } |
9130cb19dc4d updated docker osimis plugins
Alain Mazy <am@osimis.io>
parents: 749
diff changeset
413 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
781
ededfacf9a8d new index plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 775
diff changeset
414 | **Indexer** | ``INDEXER_PLUGIN_ENABLED`` | .. code-block:: json |
ededfacf9a8d new index plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 775
diff changeset
415 | | | |
ededfacf9a8d new index plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 775
diff changeset
416 | | | { |
ededfacf9a8d new index plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 775
diff changeset
417 | | | "Indexer": { |
ededfacf9a8d new index plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 775
diff changeset
418 | | | "Enable": true |
ededfacf9a8d new index plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 775
diff changeset
419 | | | } |
ededfacf9a8d new index plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 775
diff changeset
420 | | | } |
ededfacf9a8d new index plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 775
diff changeset
421 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
841
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
422 | **Neuro** | ``NEURO_PLUGIN_ENABLED`` | .. code-block:: json |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
423 | | | |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
424 | | | { |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
425 | | | "Neuro": { |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
426 | | | "Enable": true |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
427 | | | } |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
428 | | | } |
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 | **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
431 | | | |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
432 | | | { |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
433 | | | "AzureBlobStorage": { |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
434 | | | "ConnectionString": "MUST BE DEFINED BY YOU", |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
435 | | | "ContainerName": "MUST BE DEFINED BY YOU" |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
436 | | | } |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
437 | | | } |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
438 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
439 | **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
440 | | | |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
441 | | | { |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
442 | | | "AwsS3Storage": { |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
443 | | | "BucketName": "MUST BE DEFINED BY YOU", |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
444 | | | "Region": "MUST BE DEFINED BY YOU" |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
445 | | | } |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
446 | | | } |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
447 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
448 | **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
449 | | | |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
450 | | | { |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
451 | | | "GoogleCloudStorage": { |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
452 | | | "ServiceAccountFile": "MUST BE DEFINED BY YOU", |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
453 | | | "BucketName": "MUST BE DEFINED BY YOU" |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
454 | | | } |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
455 | | | } |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
456 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
457 | **OrthancExplorer2** | ``ORTHANC_EXPLORER_2_ENABLED`` | .. code-block:: json |
848
Alain Mazy <am@osimis.io>
parents: 841
diff changeset
458 | | Note: enabled by default | |
841
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
459 | | | { |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
460 | | | "OrthancExplorer2": { |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
461 | | | "Enable": true, |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
462 | | | "IsDefaultOrthancUI": false |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
463 | | | } |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
464 | | | } |
e0d5dbbbde99 new housekeeper plugin in osimis images
Alain Mazy <am@osimis.io>
parents: 830
diff changeset
465 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
960
91273763cb94 updated env var
Alain Mazy <am@osimis.io>
parents: 947
diff changeset
466 | **VolView** | ``VOLVIEW_PLUGIN_ENABLED`` | |
926
6e61cb5edf4c volview in oe2 and docker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 883
diff changeset
467 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
960
91273763cb94 updated env var
Alain Mazy <am@osimis.io>
parents: 947
diff changeset
468 | **Ohif** | ``OHIF_PLUGIN_ENABLED`` | |
91273763cb94 updated env var
Alain Mazy <am@osimis.io>
parents: 947
diff changeset
469 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
91273763cb94 updated env var
Alain Mazy <am@osimis.io>
parents: 947
diff changeset
470
926
6e61cb5edf4c volview in oe2 and docker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 883
diff changeset
471
497
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
472 Under the hood
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
473 --------------
a4e36bf97da3 dos2unix docker-osimis.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 492
diff changeset
474
830
21a522ca4ce9 osimis/orthanc Docker: links to Github
Alain Mazy <am@osimis.io>
parents: 792
diff changeset
475 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
476
830
21a522ca4ce9 osimis/orthanc Docker: links to Github
Alain Mazy <am@osimis.io>
parents: 792
diff changeset
477 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>`__