Mercurial > hg > orthanc-book

comparison Sphinx/source/users/docker-osimis.rst @ 395:d44f6f93a987

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
osimis/orthanc doc update
author Alain Mazy <alain@mazy.be>
date Tue, 21 Apr 2020 17:03:46 +0200
parents 43c5a1274740
children 7d219d619fb0
comparison
equal deleted inserted replaced
394:ea7428e3761a 395:d44f6f93a987
34 shows all the way that can be used to generate the same 34 shows all the way that can be used to generate the same
35 configuration in Orthanc. 35 configuration in Orthanc.
36 36
37 Note that these images have been re-written in April 2020. The documentation 37 Note that these images have been re-written in April 2020. The documentation
38 for older images is still available `here <https://osimis.atlassian.net/wiki/spaces/OKB/pages/26738689/How+to+use+osimis+orthanc+Docker+images#Howtouseosimis/orthancDockerimages>`__ 38 for older images is still available `here <https://osimis.atlassian.net/wiki/spaces/OKB/pages/26738689/How+to+use+osimis+orthanc+Docker+images#Howtouseosimis/orthancDockerimages>`__
39 The new images are backward compatible with the previous images except for the
40 Google Cloud Platform configuration.
41 However, if you're still using legacy environment variables, you'll get some warning
42 encouraging you to update to the new namings since the backward compatibility
43 might be removed one day (currently planed in June 2021).
44
39 45
40 Environmnent variables 46 Environmnent variables
41 ---------------------- 47 ----------------------
42 48
43 Any part of the Orthanc configuration file can be configured through an 49 Any part of the Orthanc configuration file can be configured through an
66 - capitalize all letters. ``Dicom_Web__Studies_Metadata`` now becomes 72 - capitalize all letters. ``Dicom_Web__Studies_Metadata`` now becomes
67 ``DICOM_WEB__STUDIES_METADATA`` 73 ``DICOM_WEB__STUDIES_METADATA``
68 - add ``ORTHANC__`` in front. ``DICOM_WEB__STUDIES_METADATA`` now becomes 74 - add ``ORTHANC__`` in front. ``DICOM_WEB__STUDIES_METADATA`` now becomes
69 ``ORTHANC__DICOM_WEB__STUDIES_METADATA`` 75 ``ORTHANC__DICOM_WEB__STUDIES_METADATA``
70 76
77 Note that, this automatic rule might fail because of 2 capital letters one after each other in some
78 Orthanc configurations. Therefore, there are some `exceptions <https://bitbucket.org/osimis/orthanc-builder/src/orthanc-dyn-build/docker/orthanc/env-var-non-standards.json>`__ to this rule
79 that are however quite intuitive.
71 80
72 Special environment variables 81 Special environment variables
73 ----------------------------- 82 -----------------------------
74 83
75 Other environment variables are not related to the Orthanc configuration file 84 Other environment variables are not related to the Orthanc configuration file
82 - ``VERBOSE_ENABLED=true`` will start Orthanc with the ``--verbose`` option 91 - ``VERBOSE_ENABLED=true`` will start Orthanc with the ``--verbose`` option
83 - ``TRACE_ENABLED=true`` will start Orthanc with the ``--trace`` option 92 - ``TRACE_ENABLED=true`` will start Orthanc with the ``--trace`` option
84 - ``NO_JOBS=true`` will start Orthanc with the ``--no-jobs`` option 93 - ``NO_JOBS=true`` will start Orthanc with the ``--no-jobs`` option
85 - ``UNLOCK=true`` will start Orthanc with the ``--unlock`` option 94 - ``UNLOCK=true`` will start Orthanc with the ``--unlock`` option
86 - ``MALLOC_ARENA_MAX=10`` will :ref:`control memory usage <scalability-memory>` 95 - ``MALLOC_ARENA_MAX=10`` will :ref:`control memory usage <scalability-memory>`
87 96 - ``ORTHANC_JSON`` can be used to pass a json "root" configuration (see below).
88 97
89 Configuration files 98 Configuration files
90 ------------------- 99 -------------------
91 100
92 .. highlight:: yaml 101 .. highlight:: yaml
250 | **OrthancWebViewer** | ``ORTHANC_WEB_VIEWER_PLUGIN_ENABLED`` | | 259 | **OrthancWebViewer** | ``ORTHANC_WEB_VIEWER_PLUGIN_ENABLED`` | |
251 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+ 260 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
252 | **OsimisWebViewerBasic** | ``OSIMIS_WEB_VIEWER1_PLUGIN_ENABLED`` | | 261 | **OsimisWebViewerBasic** | ``OSIMIS_WEB_VIEWER1_PLUGIN_ENABLED`` | |
253 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+ 262 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
254 | **OsimisWebViewerBasicAlpha** | ``OSIMIS_WEB_VIEWER1_ALPHA_PLUGIN_ENABLED`` | | 263 | **OsimisWebViewerBasicAlpha** | ``OSIMIS_WEB_VIEWER1_ALPHA_PLUGIN_ENABLED`` | |
255 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+ 264 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
256 | **PostgreSQL** | ``POSTGRESQL_PLUGIN_ENABLED`` | .. code-block:: json | 265 | **PostgreSQL** | ``POSTGRESQL_PLUGIN_ENABLED`` | .. code-block:: json |
257 | | | | 266 | | | |
258 | | | { | 267 | | | { |
259 | | | "PostgreSQL": { | 268 | | | "PostgreSQL": { |
260 | | | "EnableIndex": true, | 269 | | | "EnableIndex": true, |
261 | | | "EnableStorage": false, | 270 | | | "EnableStorage": false, |
262 | | | "Port": 5432, | 271 | | | "Port": 5432, |
263 | | | "Host": "HOST MUST BE DEFINED", | 272 | | | "Host": "HOST MUST BE DEFINED", |
264 | | | "Database": "postgres", | 273 | | | "Database": "postgres", |
265 | | | "Username": "postgres", | 274 | | | "Username": "postgres", |
266 | | | "Password": "postgres", | 275 | | | "Password": "postgres", |
267 | | | "EnableSsl": false, | 276 | | | "EnableSsl": false, |
268 | | | "Lock": false | 277 | | | "Lock": false |
269 | | | } | 278 | | | } |
270 | | | } | 279 | | | } |
271 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+ 280 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
272 | **ServeFolders** | ``SERVE_FOLDERS_PLUGIN_ENABLED`` | | 281 | **MySQL** | ``MYSQL_PLUGIN_ENABLED`` | .. code-block:: json |
273 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+ 282 | | | |
274 | **Transfers** | ``TRANSFERS_PLUGIN_ENABLED`` | | 283 | | | { |
275 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+ 284 | | | "MySQL": { |
276 | **Worklists** | ``WORKLISTS_PLUGIN_ENABLED`` | .. code-block:: json | 285 | | | "EnableIndex": true, |
277 | | | | 286 | | | "EnableStorage": false, |
278 | | | { | 287 | | | "Port": 3306, |
279 | | | "Worklists": { | 288 | | | "Host": "HOST MUST BE DEFINED", |
280 | | | "Enable": true, | 289 | | | "Database": "mysql", |
281 | | | "Database": "/var/lib/orthanc/worklists" | 290 | | | "Username": "root", |
282 | | | } | 291 | | | "Password": "mysql", |
283 | | | } | 292 | | | "Lock": false |
284 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+ 293 | | | } |
285 | **Wsi** | ``WSI_PLUGIN_ENABLED`` | | 294 | | | } |
286 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+ 295 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
296 | **Python** | ``PYTHON_PLUGIN_ENABLED`` | |
297 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
298 | **ServeFolders** | ``SERVE_FOLDERS_PLUGIN_ENABLED`` | |
299 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
300 | **Transfers** | ``TRANSFERS_PLUGIN_ENABLED`` | |
301 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
302 | **Worklists** | ``WORKLISTS_PLUGIN_ENABLED`` | .. code-block:: json |
303 | | | |
304 | | | { |
305 | | | "Worklists": { |
306 | | | "Enable": true, |
307 | | | "Database": "/var/lib/orthanc/worklists" |
308 | | | } |
309 | | | } |
310 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
311 | **Wsi** | ``WSI_PLUGIN_ENABLED`` | |
312 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
313 Under the hood
314 --------------
315
316 The source code that is used to generate the image can be found `here <https://bitbucket.org/osimis/orthanc-builder/src/orthanc-dyn-build/docker/orthanc/Dockerfile>`__.
317
318 The python script that is used at startup can be found `here <https://bitbucket.org/osimis/orthanc-builder/src/orthanc-dyn-build/docker/orthanc/generateConfiguration.py>`__