Mercurial > hg > orthanc-book
annotate Sphinx/source/users/docker-orthancteam.rst @ 1112:ad26102adccc default tip
fix broken link
author | Alain Mazy <am@orthanc.team> |
---|---|
date | Wed, 23 Oct 2024 16:52:30 +0200 |
parents | 4f3709b36f8a |
children |
rev | line source |
---|---|
1023
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
1 .. _docker-orthancteam: |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
2 .. highlight:: bash |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
3 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
4 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
5 orthancteam/orthanc Docker images |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
6 ================================= |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
7 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
8 .. contents:: |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
9 :depth: 3 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
10 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
11 .. warning:: |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
12 Starting from February 2024, the ``osimis/orthanc`` Docker images have been renamed |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
13 into ``orthancteam/orthanc``. The ``osimis/orthanc`` images won't be updated anymore |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
14 therefore you should switch to the ``orthancteam/orthanc`` images. |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
15 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
16 Note that all old tags released prior to February 2024 have been copied into ``orthancteam/orthanc`` |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
17 as well so, even if you are using an old version, you should update the name in your setup. |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
18 The name is the only thing that has changed. The content and build procedure are identical. |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
19 |
1040 | 20 The ``orthancteam/orthanc`` images are updated regularly. The release notes are available `here <https://github.com/orthanc-server/orthanc-builder/blob/master/release-notes-docker-images.md>`__. |
21 | |
1023
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
22 .. warning:: |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
23 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
24 Starting from the ``22.6.1`` release, we are providing 2 types of images: |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
25 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
26 - the default image with the usual tag: e.g ``22.6.1`` |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
27 - the full image with a e.g ``22.6.1-full`` tag |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
28 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
29 The default image is suitable for 99.9% of users. |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
30 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
31 You should use the full image only if you need to use one of these: |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
32 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
33 - the Azure Blob storage plugin |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
34 - the Google Cloud storage plugin |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
35 - the ODBC plugin with SQL Server (msodbcsql18 is preinstalled) |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
36 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
37 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
38 Introduction |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
39 ------------ |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
40 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
41 Our commercial partner `Orthanc Team <https://orthanc.team>`__ |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
42 `publishes separated Docker images |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
43 <https://hub.docker.com/r/orthancteam/orthanc>`__. |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
44 These images have been designed to be used with ``docker-compose`` and |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
45 provide a configuration system through: |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
46 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
47 - environment variables |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
48 - Docker secrets |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
49 - classical configuration files |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
50 - a mix of these options |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
51 |
1102 | 52 A comparison against the ``jodogne/orthanc`` Docker images :ref:`is |
53 available <docker-jodogne-vs-orthanc-team>`. | |
54 | |
1112 | 55 This `repository <https://github.com/orthanc-server/orthanc-setup-samples/>`__ |
1023
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
56 contains lots of examples on how to use these images. In particular, |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
57 `this example <https://github.com/orthanc-server/orthanc-setup-samples/tree/master/docker/all-usages/docker-compose.yml>`__ |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
58 shows all the way that can be used to generate the same |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
59 configuration in Orthanc. |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
60 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
61 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
62 Environment variables |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
63 --------------------- |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
64 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
65 Any part of the Orthanc configuration file can be configured through an |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
66 environment variable. Now that Orthanc and its plugins have hundreds of |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
67 configuration parameter, listing all these environment variable would be |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
68 too long. That's why we have defined a standard way of naming the variable: |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
69 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
70 +---------------------------+----------------------------------------------+----------------------------------------------------------------+ |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
71 | Orthanc configuration | Environment variable | Sample value | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
72 +===========================+==============================================+================================================================+ |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
73 | StableAge | ORTHANC__STABLE_AGE | ``30`` | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
74 +---------------------------+----------------------------------------------+----------------------------------------------------------------+ |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
75 | DicomWeb.Root | ORTHANC__DICOM_WEB__ROOT | ``/dicom-web/`` | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
76 +---------------------------+----------------------------------------------+----------------------------------------------------------------+ |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
77 | DicomWeb.Servers | ORTHANC__DICOM_WEB__SERVERS | ``{"sample": [ "http://127.0.0.1/dicom-web/"]}`` | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
78 +---------------------------+----------------------------------------------+----------------------------------------------------------------+ |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
79 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
80 To find out an environment variable name from an Orthanc setting |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
81 (i.e. ``DicomWeb.StudiesMetadata`` is the ``path`` to a setting): |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
82 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
83 - whenever a word contains a capital letter, insert an underscore ``_`` in front. |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
84 ``DicomWeb.StudiesMetadata`` now becomes ``Dicom_Web.Studies_Metadata`` |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
85 - whenever you go down one level in the JSON configuration, insert |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
86 a double underscore ``__``. ``Dicom_Web.Studies_Metadata`` now becomes |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
87 ``Dicom_Web__Studies_Metadata`` |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
88 - capitalize all letters. ``Dicom_Web__Studies_Metadata`` now becomes |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
89 ``DICOM_WEB__STUDIES_METADATA`` |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
90 - add ``ORTHANC__`` in front. ``DICOM_WEB__STUDIES_METADATA`` now becomes |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
91 ``ORTHANC__DICOM_WEB__STUDIES_METADATA`` |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
92 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
93 Note that, this automatic rule might fail because of 2 capital letters one after each other in some |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
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 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
95 that are however quite intuitive. |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
96 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
97 Special environment variables |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
98 ----------------------------- |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
99 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
100 Other environment variables are not related to the Orthanc configuration file |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
101 but can be specified to control the way Orthanc is run. |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
102 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
103 - ``VERBOSE_STARTUP=true`` will allow you to debug the startup process and see |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
104 the configuration that has been provided to Orthanc. This setup should be |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
105 disabled in production since it might display secret information like passwords |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
106 in your logs |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
107 - ``VERBOSE_ENABLED=true`` will start Orthanc with the ``--verbose`` option |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
108 - ``TRACE_ENABLED=true`` will start Orthanc with the ``--trace`` option |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
109 - ``NO_JOBS=true`` will start Orthanc with the ``--no-jobs`` option |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
110 - ``LOGDIR=/logs`` will start Orthanc with the ``--logdir=/logs`` option (introduced in 21.9.1) |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
111 - ``LOGFILE=/logs`` will start Orthanc with the ``--logfile=/logs/orthanc.log`` option (introduced in 21.9.1) |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
112 - ``MALLOC_ARENA_MAX=10`` will :ref:`control memory usage <scalability-memory>` |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
113 - ``ORTHANC_JSON`` can be used to pass a JSON "root" configuration (see below). |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
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. |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
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). |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
116 DCMTK calls gethostid() when generating DICOM UIDs (used, e.g, in modifications/anonymizations). |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
117 When /etc/hostid is missing, the system tries to generate it from the IP of the system. |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
118 On some system, in particular circumstances, we have observed that the system performs a DNS query |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
119 to get the IP of the system. This DNS can timeout (after multiple with retries) and, in particular cases, |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
120 we have observed a delay of 40 seconds to generate a single DICOM UID in Orthanc. |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
121 Therefore, if /etc/hostid is missing, the startup script creates it and fill it with a random number (default behaviour). |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
122 This behaviour can still be deactivated by defining ``GENERATE_HOST_ID_IF_MISSING=false``. |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
123 The host id can also be forced by defining ``FORCE_HOST_ID``. |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
124 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
125 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
126 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
127 Configuration files |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
128 ------------------- |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
129 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
130 .. highlight:: yaml |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
131 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
132 Configuration files should be stored in the ``/etc/orthanc/`` folder inside the Docker image. |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
133 This is done by building an image thanks to a ``Dockerfile``:: |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
134 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
135 FROM orthancteam/orthanc |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
136 COPY orthanc.json /etc/orthanc/ |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
137 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
138 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
139 Configuration files can also be passed as secrets as shown in this ``docker-compose.yml``:: |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
140 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
141 version: "3.3" |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
142 services: |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
143 orthanc-file-in-secrets: |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
144 image: orthancteam/orthanc |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
145 depends_on: [index-db] |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
146 ports: ["8201:8042"] |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
147 environment: |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
148 VERBOSE_STARTUP: "true" |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
149 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
150 secrets: |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
151 - orthanc.secret.json |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
152 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
153 secrets: |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
154 orthanc.secret.json: |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
155 file: orthanc.secret.json |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
156 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
157 Finally, a whole configuration file can be passed as a JSON through the ``ORTHANC_JSON`` environment variable:: |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
158 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
159 version: "3.3" |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
160 services: |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
161 orthanc-file-in-env-var: |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
162 image: orthancteam/orthanc |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
163 depends_on: [index-db] |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
164 ports: ["8200:8042"] |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
165 environment: |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
166 VERBOSE_ENABLED: "true" |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
167 OSIMIS_WEB_VIEWER1_PLUGIN_ENABLED: "true" |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
168 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
169 ORTHANC_JSON: | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
170 { |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
171 "Name": "orthanc-file-in-env-var", |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
172 "PostgreSQL" : { |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
173 "Host": "index-db", |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
174 "Password": "pg-password" |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
175 }, |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
176 "RegisteredUsers": { |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
177 "demo": "demo" |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
178 } |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
179 } |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
180 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
181 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
182 Docker secrets |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
183 -------------- |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
184 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
185 .. highlight:: yaml |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
186 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
187 When using your container in a ``Docker Swarm`` or ``Kubernetes`` environment, |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
188 it is usually advised to pass sensitive information through ``Docker Secrets``. |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
189 For this purpose, any secret whose name is similar to the name of an |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
190 environment variable is considered as an environment variable:: |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
191 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
192 version: "3.3" |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
193 services: |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
194 orthanc-with-direct-secret: |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
195 image: orthancteam/orthanc |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
196 depends_on: [index-db] |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
197 ports: ["8003:8042"] |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
198 environment: |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
199 ORTHANC__NAME: "orthanc-with-direct-secret" |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
200 VERBOSE_ENABLED: "true" |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
201 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
202 OSIMIS_WEB_VIEWER1_PLUGIN_ENABLED: "true" |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
203 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
204 ORTHANC__POSTGRESQL__HOST: "index-db" |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
205 ORTHANC__REGISTERED_USERS: | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
206 {"demo": "demo"} |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
207 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
208 secrets: |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
209 - ORTHANC__POSTGRESQL__PASSWORD |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
210 secrets: |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
211 ORTHANC__POSTGRESQL__PASSWORD: |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
212 file: ORTHANC__POSTGRESQL__PASSWORD |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
213 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
214 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
215 Mixing configuration |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
216 -------------------- |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
217 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
218 Parts of your configuration can be defined in a configuration file, |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
219 another part in an environment variable and yet another in a secret. |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
220 If the same setting is defined in multiple location, the latest one |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
221 will overwrite the first. Settings are evaluated in this order: |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
222 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
223 - JSON files from ``/etc/orthanc/`` |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
224 - JSON files from ``/run/secrets`` (Docker secrets are copied there |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
225 by Docker) |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
226 - environment variables |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
227 - secret environment variables |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
228 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
229 At this point, if some settings have not been defined yet, some defaults |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
230 are applied (see below). |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
231 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
232 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
233 Default configuration |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
234 --------------------- |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
235 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
236 .. highlight:: json |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
237 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
238 Orthanc and each plugin might have some default settings that might |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
239 eventually be different from the defaults included in the Orthanc |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
240 executable or the plugin library. |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
241 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
242 .. below json is copied from orthanc-builder/docker/orthanc/orthanc-defaults.json |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
243 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
244 Orthanc non-standard defaults:: |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
245 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
246 { |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
247 "StorageDirectory" : "/var/lib/orthanc/db", |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
248 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
249 "RemoteAccessAllowed": true, |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
250 "AuthenticationEnabled": true, |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
251 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
252 "HttpsCACertificates" : "/etc/ssl/certs/ca-certificates.crt", |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
253 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
254 "Plugins" : ["/usr/share/orthanc/plugins/"] |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
255 } |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
256 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
257 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
258 Default Lua scripts |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
259 ------------------- |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
260 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
261 Some Lua scripts are already loaded in the image but are not configured to |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
262 be loaded by Orthanc automatically. You'll have to add them to the ``"LuaScripts"`` |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
263 configuration if you want to use them. |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
264 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
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>`__ |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
266 can be used to regenerate the ``/tmp/orthanc.json`` configuration file that is loaded by Orthanc every time |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
267 you POST to ``/tools/reset``. Note that it declares an ``IncomingHttpRequestFilter`` |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
268 callback that might conflict with your scripts. |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
269 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
270 Healthcheck probe |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
271 ----------------- |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
272 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
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>`__ |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
274 script has been added in order to perform healthchecks. Check the doc in the script itself for more details. |
1061 | 275 A sample configuration is also available in `this sample <https://github.com/orthanc-server/orthanc-setup-samples/tree/master/docker/health-check>`__ |
1023
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
276 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
277 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
278 Plugins |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
279 ------- |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
280 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
281 Plugins are automatically enabled as soon as you define a setting |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
282 in their JSON section or as soon as you define to ``true`` their |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
283 specific environment variable. |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
284 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
285 Below is a list of all plugins, their environment variable and their default configuration |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
286 (only when their default configuration is different from the plugin defaults): |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
287 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
288 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
289 .. below table is obtained by running orthanc-builder/docker/orthanc/generatePluginDoc.py |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
290 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
291 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
292 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+ |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
293 | Plugin | Environment variable | Default configuration | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
294 +==================================================+==================================================+====================================================================================================+ |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
295 | **Authorization** | ``AUTHORIZATION_PLUGIN_ENABLED`` | | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
296 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+ |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
297 | **ConnectivityChecks** | ``CONNECTIVITY_CHECKS_PLUGIN_ENABLED`` | | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
298 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+ |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
299 | **DicomWeb** | ``DICOM_WEB_PLUGIN_ENABLED`` | .. code-block:: json | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
300 | | | | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
301 | | | { | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
302 | | | "DicomWeb": { | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
303 | | | "Enable": true | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
304 | | | } | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
305 | | | } | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
306 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+ |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
307 | **Gdcm** | ``GDCM_PLUGIN_ENABLED`` | .. code-block:: json | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
308 | | Note: enabled by default | | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
309 | | | { | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
310 | | | "Gdcm": { | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
311 | | | "Throttling": 4, | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
312 | | | "RestrictTransferSyntaxes": [ | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
313 | | | "1.2.840.10008.1.2.4.90", | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
314 | | | "1.2.840.10008.1.2.4.91", | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
315 | | | "1.2.840.10008.1.2.4.92", | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
316 | | | "1.2.840.10008.1.2.4.93" | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
317 | | | ] | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
318 | | | } | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
319 | | | } | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
320 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+ |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
321 | **OrthancWebViewer** | ``ORTHANC_WEB_VIEWER_PLUGIN_ENABLED`` | | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
322 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+ |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
323 | **StoneWebViewer** | ``STONE_WEB_VIEWER_PLUGIN_ENABLED`` | | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
324 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+ |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
325 | **OsimisWebViewerBasic** | ``OSIMIS_WEB_VIEWER1_PLUGIN_ENABLED`` | | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
326 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+ |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
327 | **OsimisWebViewerBasicAlpha** | ``OSIMIS_WEB_VIEWER1_ALPHA_PLUGIN_ENABLED`` | | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
328 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+ |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
329 | **PostgreSQL** | ``POSTGRESQL_PLUGIN_ENABLED`` | .. code-block:: json | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
330 | | | | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
331 | | | { | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
332 | | | "PostgreSQL": { | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
333 | | | "EnableIndex": true, | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
334 | | | "EnableStorage": false, | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
335 | | | "Port": 5432, | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
336 | | | "Host": "HOST MUST BE DEFINED", | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
337 | | | "Database": "postgres", | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
338 | | | "Username": "postgres", | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
339 | | | "Password": "postgres", | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
340 | | | "EnableSsl": false, | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
341 | | | "Lock": false | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
342 | | | } | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
343 | | | } | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
344 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+ |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
345 | **MySQL** | ``MYSQL_PLUGIN_ENABLED`` | .. code-block:: json | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
346 | | | | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
347 | | | { | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
348 | | | "MySQL": { | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
349 | | | "EnableIndex": true, | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
350 | | | "EnableStorage": false, | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
351 | | | "Port": 3306, | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
352 | | | "Host": "HOST MUST BE DEFINED", | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
353 | | | "Database": "mysql", | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
354 | | | "Username": "root", | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
355 | | | "Password": "mysql", | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
356 | | | "Lock": false | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
357 | | | } | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
358 | | | } | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
359 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+ |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
360 | **Python** | ``PYTHON_PLUGIN_ENABLED`` | | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
361 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+ |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
362 | **ServeFolders** | ``SERVE_FOLDERS_PLUGIN_ENABLED`` | | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
363 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+ |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
364 | **Transfers** | ``TRANSFERS_PLUGIN_ENABLED`` | | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
365 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+ |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
366 | **Worklists** | ``WORKLISTS_PLUGIN_ENABLED`` | .. code-block:: json | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
367 | | | | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
368 | | | { | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
369 | | | "Worklists": { | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
370 | | | "Enable": true, | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
371 | | | "Database": "/var/lib/orthanc/worklists" | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
372 | | | } | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
373 | | | } | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
374 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+ |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
375 | **Housekeeper** | ``HOUSEKEEPER_PLUGIN_ENABLED`` | .. code-block:: json | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
376 | | | | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
377 | | | { | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
378 | | | "Housekeeper": { | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
379 | | | "Enable": true | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
380 | | | } | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
381 | | | } | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
382 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+ |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
383 | **DelayedDeletion** | ``DELAYED_DELETION_PLUGIN_ENABLED`` | .. code-block:: json | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
384 | | | | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
385 | | | { | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
386 | | | "DelayedDeletion": { | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
387 | | | "Enable": true | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
388 | | | } | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
389 | | | } | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
390 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+ |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
391 | **MultitenantDicom** | ``MULTITENANT_DICOM_PLUGIN_ENABLED`` | | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
392 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+ |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
393 | **Wsi** | ``WSI_PLUGIN_ENABLED`` | | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
394 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+ |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
395 | **Odbc** | ``ODBC_PLUGIN_ENABLED`` | .. code-block:: json | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
396 | | | | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
397 | | | { | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
398 | | | "Odbc": { | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
399 | | | "EnableIndex": true, | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
400 | | | "EnableStorage": false, | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
401 | | | "IndexConnectionString": "MUST BE DEFINED", | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
402 | | | "StorageConnectionString": "MUST BE DEFINED" | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
403 | | | } | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
404 | | | } | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
405 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+ |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
406 | **Tcia** | ``TCIA_PLUGIN_ENABLED`` | .. code-block:: json | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
407 | | | | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
408 | | | { | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
409 | | | "Tcia": { | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
410 | | | "Enable": true | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
411 | | | } | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
412 | | | } | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
413 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+ |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
414 | **Indexer** | ``INDEXER_PLUGIN_ENABLED`` | .. code-block:: json | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
415 | | | | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
416 | | | { | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
417 | | | "Indexer": { | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
418 | | | "Enable": true | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
419 | | | } | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
420 | | | } | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
421 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+ |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
422 | **Neuro** | ``NEURO_PLUGIN_ENABLED`` | .. code-block:: json | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
423 | | | | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
424 | | | { | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
425 | | | "Neuro": { | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
426 | | | "Enable": true | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
427 | | | } | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
428 | | | } | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
429 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+ |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
430 | **AzureBlobStorage** | ``AZURE_BLOB_STORAGE_PLUGIN_ENABLED`` | .. code-block:: json | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
431 | | | | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
432 | | | { | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
433 | | | "AzureBlobStorage": { | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
434 | | | "ConnectionString": "MUST BE DEFINED BY YOU", | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
435 | | | "ContainerName": "MUST BE DEFINED BY YOU" | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
436 | | | } | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
437 | | | } | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
438 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+ |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
439 | **AwsS3Storage** | ``AWS_S3_STORAGE_PLUGIN_ENABLED`` | .. code-block:: json | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
440 | | | | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
441 | | | { | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
442 | | | "AwsS3Storage": { | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
443 | | | "BucketName": "MUST BE DEFINED BY YOU", | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
444 | | | "Region": "MUST BE DEFINED BY YOU" | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
445 | | | } | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
446 | | | } | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
447 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+ |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
448 | **GoogleCloudStorage** | ``GOOGLE_CLOUD_STORAGE_PLUGIN_ENABLED`` | .. code-block:: json | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
449 | | | | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
450 | | | { | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
451 | | | "GoogleCloudStorage": { | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
452 | | | "ServiceAccountFile": "MUST BE DEFINED BY YOU", | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
453 | | | "BucketName": "MUST BE DEFINED BY YOU" | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
454 | | | } | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
455 | | | } | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
456 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+ |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
457 | **OrthancExplorer2** | ``ORTHANC_EXPLORER_2_ENABLED`` | .. code-block:: json | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
458 | | Note: enabled by default | | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
459 | | | { | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
460 | | | "OrthancExplorer2": { | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
461 | | | "Enable": true, | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
462 | | | "IsDefaultOrthancUI": false | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
463 | | | } | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
464 | | | } | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
465 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+ |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
466 | **VolView** | ``VOLVIEW_PLUGIN_ENABLED`` | | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
467 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+ |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
468 | **Ohif** | ``OHIF_PLUGIN_ENABLED`` | | |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
469 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+ |
1082 | 470 | **STL** | ``STL_PLUGIN_ENABLED`` | .. code-block:: json | |
471 | | | | | |
472 | | | { | | |
473 | | | "STL": { | | |
474 | | | "Enable": true | | |
475 | | | } | | |
476 | | | } | | |
1053
600547006d14
added STL_PLUGIN_ENABLED
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1040
diff
changeset
|
477 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+ |
1082 | 478 | **Java** | ``JAVA_PLUGIN_ENABLED`` | .. code-block:: json | |
479 | | | | | |
480 | | | { | | |
481 | | | "Java": { | | |
482 | | | "Enable": true, | | |
483 | | | "Classpath": "MUST BE DEFINED BY YOU", | | |
484 | | | "InitializationClass": "MUST BE DEFINED BY YOU" | | |
485 | | | } | | |
486 | | | } | | |
487 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+ | |
1023
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
488 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
489 Under the hood |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
490 -------------- |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
491 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
492 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>`__. |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
493 |
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
diff
changeset
|
494 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>`__ |