annotate Sphinx/source/users/docker.rst @ 995:5c8d2250b361

anon profile 2023b
author Alain Mazy <am@osimis.io>
date Wed, 06 Dec 2023 09:12:28 +0100
parents a6bf749b3c04
children fd3ad1ac1482
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
54
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 .. _docker:
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 .. highlight:: bash
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
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: 866
diff changeset
5 jodogne/orthanc Docker images
815f70009ec2 highlight osimis/orthanc docker images since jodogne/orthanc images are currently not up-to-date
Alain Mazy <am@osimis.io>
parents: 866
diff changeset
6 =============================
54
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7
481
4f076a3b9934 unanswered-forum.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 461
diff changeset
8 .. toctree::
4f076a3b9934 unanswered-forum.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 461
diff changeset
9 :hidden:
4f076a3b9934 unanswered-forum.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 461
diff changeset
10
4f076a3b9934 unanswered-forum.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 461
diff changeset
11 docker-osimis.rst
4f076a3b9934 unanswered-forum.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 461
diff changeset
12
4f076a3b9934 unanswered-forum.rst
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 461
diff changeset
13
54
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 .. contents::
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 :depth: 3
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 Introduction
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 ------------
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 `Docker images <https://en.wikipedia.org/wiki/Docker_(software)>`__
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 for the Orthanc core and its official plugins are freely available on
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 the `DockerHub platform <https://hub.docker.com/u/jodogne/>`__. The
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 source code of the corresponding Docker images is available on `GitHub
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 <https://github.com/jodogne/OrthancDocker>`__.
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26
229
c74f044dc3ce note about docker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 220
diff changeset
27 **Note about Orthanc vs. Osimis Docker images:**
c74f044dc3ce note about docker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 220
diff changeset
28
c74f044dc3ce note about docker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 220
diff changeset
29 * The ``jodogne/orthanc`` and ``jodogne/orthanc-plugins`` Docker
c74f044dc3ce note about docker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 220
diff changeset
30 images that are described on this page are always kept in sync with
c74f044dc3ce note about docker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 220
diff changeset
31 the latest releases of the Orthanc project, with a basic
c74f044dc3ce note about docker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 220
diff changeset
32 configuration system that is inherited from the Debian packages
759
94f5fc38b927 clarifications
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 741
diff changeset
33 (i.e. manual edition of the configuration files). These images are
94f5fc38b927 clarifications
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 741
diff changeset
34 most useful to **software developers and researchers**.
229
c74f044dc3ce note about docker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 220
diff changeset
35
358
011b01ccf52d fixing external hyperlinks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 336
diff changeset
36 * Our commercial partner `Osimis <https://www.osimis.io>`__ also
011b01ccf52d fixing external hyperlinks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 336
diff changeset
37 `publishes separated Docker images
759
94f5fc38b927 clarifications
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 741
diff changeset
38 <https://hub.docker.com/r/osimis/orthanc>`__. These
94f5fc38b927 clarifications
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 741
diff changeset
39 ``osimis/orthanc`` images are used by the technical team of Osimis
94f5fc38b927 clarifications
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 741
diff changeset
40 in order to provide professional support to their customers, with a
94f5fc38b927 clarifications
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 741
diff changeset
41 configuration system that can be tuned through **environment
94f5fc38b927 clarifications
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 741
diff changeset
42 variables** (which is very handy if using ``docker-compose`` or
94f5fc38b927 clarifications
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 741
diff changeset
43 Kubernetes). These images are not necessarily always in sync with
94f5fc38b927 clarifications
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 741
diff changeset
44 the Orthanc project, but they also include the :ref:`plugins edited
94f5fc38b927 clarifications
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 741
diff changeset
45 by Osimis <plugins-osimis>`, notably the Osimis Web viewer (that is
94f5fc38b927 clarifications
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 741
diff changeset
46 much more advanced than the Orthanc Web viewer) and the advanced
94f5fc38b927 clarifications
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 741
diff changeset
47 authorization plugin. A :ref:`specific page <docker-osimis>` is
94f5fc38b927 clarifications
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 741
diff changeset
48 available to describe how these images should be used. These images
94f5fc38b927 clarifications
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 741
diff changeset
49 are targeted at **ops teams**.
229
c74f044dc3ce note about docker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 220
diff changeset
50
c74f044dc3ce note about docker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 220
diff changeset
51 **Note for CentOS users:** The Docker environment might be difficult to
54
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
52 configure on your platform. Hints are available on the `Orthanc Users
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
53 discussion group
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
54 <https://groups.google.com/d/msg/orthanc-users/w-uPAknnRQc/-XhzBGSCAwAJ>`__.
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
55
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
56
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
57 Running the Orthanc core
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
58 ------------------------
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
59
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
60 The following command will start the core of Orthanc, with all the
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
61 plugins disabled::
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
62
363
9c28eeab2db6 removed sudo from docker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 358
diff changeset
63 $ docker run -p 4242:4242 -p 8042:8042 --rm jodogne/orthanc
54
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
64
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
65 Once Orthanc is running, use Mozilla Firefox at URL
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
66 http://localhost:8042/ to interact with Orthanc. The default username
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
67 is ``orthanc`` and its password is ``orthanc``.
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
68
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
69 The command above starts the mainline version of Orthanc, whose
69
03d35f985f26 update docker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 54
diff changeset
70 development is in continuous progress. Do not forget to regularly
03d35f985f26 update docker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 54
diff changeset
71 update the Docker image to benefit from the latest features::
03d35f985f26 update docker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 54
diff changeset
72
363
9c28eeab2db6 removed sudo from docker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 358
diff changeset
73 $ docker pull jodogne/orthanc
69
03d35f985f26 update docker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 54
diff changeset
74
03d35f985f26 update docker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 54
diff changeset
75 If more stability is required, you can select the official release of
03d35f985f26 update docker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 54
diff changeset
76 Orthanc to be run::
54
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
77
963
a6bf749b3c04 Orthanc 1.12.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 933
diff changeset
78 $ docker run -p 4242:4242 -p 8042:8042 --rm jodogne/orthanc:1.12.1
54
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
79
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
80 Passing additional command-line options (e.g. to make Orthanc verbose)
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
81 can be done as follows (note the ``/etc/orthanc`` option that is
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
82 required for Orthanc to find its configuration files)::
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
83
963
a6bf749b3c04 Orthanc 1.12.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 933
diff changeset
84 $ docker run -p 4242:4242 -p 8042:8042 --rm jodogne/orthanc:1.12.1 /etc/orthanc --verbose
54
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
85
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
86
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
87 Usage, with plugins enabled
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
88 ---------------------------
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
89
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
90 The following command will run the mainline version of the Orthanc
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
91 core, together with its :ref:`Web viewer <webviewer>`, its
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
92 :ref:`PostgreSQL support <postgresql>`, its :ref:`DICOMweb
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
93 implementation <dicomweb>`, and its :ref:`whole-slide imaging viewer
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
94 <wsi>`::
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
95
363
9c28eeab2db6 removed sudo from docker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 358
diff changeset
96 $ docker run -p 4242:4242 -p 8042:8042 --rm jodogne/orthanc-plugins
54
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
97
365
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 364
diff changeset
98 Or you can also start a specific version of Orthanc for more stability::
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 364
diff changeset
99
963
a6bf749b3c04 Orthanc 1.12.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 933
diff changeset
100 $ docker run -p 4242:4242 -p 8042:8042 --rm jodogne/orthanc-plugins:1.12.1
365
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 364
diff changeset
101
364
234de55ed125 usage of the python plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 363
diff changeset
102 If you have an interest in the :ref:`Python plugin <python-plugin>`,
234de55ed125 usage of the python plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 363
diff changeset
103 you can use the ``orthanc-python`` image. The latter image is a
234de55ed125 usage of the python plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 363
diff changeset
104 heavier version of the ``orthanc-plugins`` image, as it embeds the
234de55ed125 usage of the python plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 363
diff changeset
105 Python 3.7 interpreter. Here is how to start this image::
234de55ed125 usage of the python plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 363
diff changeset
106
365
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 364
diff changeset
107 $ docker run -p 4242:4242 -p 8042:8042 --rm jodogne/orthanc-python
963
a6bf749b3c04 Orthanc 1.12.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 933
diff changeset
108 $ docker run -p 4242:4242 -p 8042:8042 --rm jodogne/orthanc-python:1.12.1
364
234de55ed125 usage of the python plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 363
diff changeset
109
54
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
110
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
111 Fine-tuning the configuration
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
112 -----------------------------
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
113
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
114 For security reasons, you should at least protect your instance of
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
115 Orthanc by changing this default user, in the ``RegisteredUsers``
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
116 :ref:`configuration option <configuration>`. You will also probably
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
117 need to fine-tune other parameters, notably the list of the DICOM
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
118 modalities Orthanc knows about.
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
119
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
120 You can generate a custom configuration file for Orthanc as follows::
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
121
963
a6bf749b3c04 Orthanc 1.12.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 933
diff changeset
122 $ docker run --rm --entrypoint=cat jodogne/orthanc:1.12.1 /etc/orthanc/orthanc.json > /tmp/orthanc.json
54
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
123
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
124 Then, edit the just-generated file ``/tmp/orthanc.json`` and restart
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
125 Orthanc with your updated configuration::
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
126
963
a6bf749b3c04 Orthanc 1.12.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 933
diff changeset
127 $ docker run -p 4242:4242 -p 8042:8042 --rm -v /tmp/orthanc.json:/etc/orthanc/orthanc.json:ro jodogne/orthanc:1.12.1
54
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
128
384
e4b0a4d69f42 note about memory usage
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 382
diff changeset
129 *Remark:* These Docker images automatically set the environment
e4b0a4d69f42 note about memory usage
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 382
diff changeset
130 variable ``MALLOC_ARENA_MAX`` to ``5`` in order to :ref:`control
e4b0a4d69f42 note about memory usage
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 382
diff changeset
131 memory usage <scalability-memory>`. This default setting can be
e4b0a4d69f42 note about memory usage
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 382
diff changeset
132 overriden by providing the option ``-e MALLOC_ARENA_MAX=1`` when
386
801db4e1828c default
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 384
diff changeset
133 invoking ``docker run`` (the value ``0`` corresponds to the default
801db4e1828c default
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 384
diff changeset
134 value).
384
e4b0a4d69f42 note about memory usage
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 382
diff changeset
135
54
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
136
382
64b32cb19571 docker-compose
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 365
diff changeset
137 .. _docker-compose:
64b32cb19571 docker-compose
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 365
diff changeset
138
64b32cb19571 docker-compose
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 365
diff changeset
139 Configuration management using Docker Compose
64b32cb19571 docker-compose
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 365
diff changeset
140 ---------------------------------------------
64b32cb19571 docker-compose
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 365
diff changeset
141
64b32cb19571 docker-compose
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 365
diff changeset
142 Depending on the context, the `Docker Compose tool
64b32cb19571 docker-compose
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 365
diff changeset
143 <https://docs.docker.com/compose/>`__ might be easier to use than the
64b32cb19571 docker-compose
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 365
diff changeset
144 plain Docker tool, as it allows replacing long command lines as above,
64b32cb19571 docker-compose
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 365
diff changeset
145 by plain configuration files. The trick here is to provide the JSON
64b32cb19571 docker-compose
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 365
diff changeset
146 configuration files to Orthanc as `secrets
64b32cb19571 docker-compose
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 365
diff changeset
147 <https://docs.docker.com/compose/compose-file/#secrets>`__ (note that
64b32cb19571 docker-compose
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 365
diff changeset
148 the related option ``configs`` could in theory be better,
64b32cb19571 docker-compose
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 365
diff changeset
149 unfortunately it is only available to `Docker Swarm
64b32cb19571 docker-compose
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 365
diff changeset
150 <https://github.com/docker/compose/issues/5110>`__).
64b32cb19571 docker-compose
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 365
diff changeset
151
673
767c2550fa00 environment variable in docker compose
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 638
diff changeset
152 .. highlight:: yaml
382
64b32cb19571 docker-compose
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 365
diff changeset
153
64b32cb19571 docker-compose
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 365
diff changeset
154 First create the ``docker-compose.yml`` file as follows (this one uses
64b32cb19571 docker-compose
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 365
diff changeset
155 the `YAML file format <https://en.wikipedia.org/wiki/YAML>`__)::
64b32cb19571 docker-compose
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 365
diff changeset
156
64b32cb19571 docker-compose
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 365
diff changeset
157 version: '3.1' # Secrets are only available since this version of Docker Compose
64b32cb19571 docker-compose
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 365
diff changeset
158 services:
64b32cb19571 docker-compose
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 365
diff changeset
159 orthanc:
963
a6bf749b3c04 Orthanc 1.12.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 933
diff changeset
160 image: jodogne/orthanc-plugins:1.12.1
382
64b32cb19571 docker-compose
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 365
diff changeset
161 command: /run/secrets/ # Path to the configuration files (stored as secrets)
64b32cb19571 docker-compose
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 365
diff changeset
162 ports:
402
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 396
diff changeset
163 - 4242:4242
382
64b32cb19571 docker-compose
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 365
diff changeset
164 - 8042:8042
64b32cb19571 docker-compose
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 365
diff changeset
165 secrets:
673
767c2550fa00 environment variable in docker compose
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 638
diff changeset
166 - orthanc.json
767c2550fa00 environment variable in docker compose
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 638
diff changeset
167 environment:
767c2550fa00 environment variable in docker compose
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 638
diff changeset
168 - ORTHANC_NAME=HelloWorld
382
64b32cb19571 docker-compose
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 365
diff changeset
169 secrets:
64b32cb19571 docker-compose
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 365
diff changeset
170 orthanc.json:
64b32cb19571 docker-compose
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 365
diff changeset
171 file: orthanc.json
64b32cb19571 docker-compose
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 365
diff changeset
172
64b32cb19571 docker-compose
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 365
diff changeset
173 .. highlight:: json
64b32cb19571 docker-compose
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 365
diff changeset
174
64b32cb19571 docker-compose
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 365
diff changeset
175 Then, place the configuration file ``orthanc.json`` next to the
64b32cb19571 docker-compose
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 365
diff changeset
176 ``docker-compose.yml`` file. Here is a minimalist ``orthanc.json``::
64b32cb19571 docker-compose
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 365
diff changeset
177
64b32cb19571 docker-compose
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 365
diff changeset
178 {
673
767c2550fa00 environment variable in docker compose
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 638
diff changeset
179 "Name" : "${ORTHANC_NAME} in Docker Compose",
382
64b32cb19571 docker-compose
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 365
diff changeset
180 "RemoteAccessAllowed" : true
64b32cb19571 docker-compose
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 365
diff changeset
181 }
64b32cb19571 docker-compose
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 365
diff changeset
182
64b32cb19571 docker-compose
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 365
diff changeset
183 .. highlight:: bash
64b32cb19571 docker-compose
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 365
diff changeset
184
64b32cb19571 docker-compose
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 365
diff changeset
185 This single configuration file should contain all the required
64b32cb19571 docker-compose
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 365
diff changeset
186 configuration options for Orthanc and all its plugins. The container
64b32cb19571 docker-compose
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 365
diff changeset
187 can then be started as follows::
64b32cb19571 docker-compose
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 365
diff changeset
188
64b32cb19571 docker-compose
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 365
diff changeset
189 $ docker-compose up
64b32cb19571 docker-compose
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 365
diff changeset
190
673
767c2550fa00 environment variable in docker compose
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 638
diff changeset
191 Note how the `environment variable
767c2550fa00 environment variable in docker compose
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 638
diff changeset
192 <https://docs.docker.com/compose/environment-variables/>`__
767c2550fa00 environment variable in docker compose
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 638
diff changeset
193 ``ORTHANC_NAME`` has been used in order to easily adapt the
767c2550fa00 environment variable in docker compose
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 638
diff changeset
194 configuration of Orthanc. This results from the fact that Orthanc
767c2550fa00 environment variable in docker compose
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 638
diff changeset
195 injects :ref:`environment variables <orthanc-environment-variables>`
767c2550fa00 environment variable in docker compose
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 638
diff changeset
196 once reading the content of its configuration files (since Orthanc
767c2550fa00 environment variable in docker compose
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 638
diff changeset
197 1.5.0).
382
64b32cb19571 docker-compose
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 365
diff changeset
198
673
767c2550fa00 environment variable in docker compose
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 638
diff changeset
199
54
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
200 Making the Orthanc database persistent
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
201 --------------------------------------
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
202
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
203 The filesystem of Docker containers is volatile (its content is
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
204 deleted once the container stops). You can make the Orthanc database
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
205 persistent by mapping the ``/var/lib/orthanc/db`` folder of the
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
206 container to some path in the filesystem of your Linux host, e.g.::
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
207
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
208 $ mkdir /tmp/orthanc-db
963
a6bf749b3c04 Orthanc 1.12.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 933
diff changeset
209 $ docker run -p 4242:4242 -p 8042:8042 --rm -v /tmp/orthanc-db/:/var/lib/orthanc/db/ jodogne/orthanc:1.12.1
54
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
210
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
211
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
212 Whole-slide imaging support
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
213 ---------------------------
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
214
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
215 The ``orthanc-plugins`` image includes support for :ref:`microscopic
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
216 whole-slide imaging (WSI) <wsi>`. For instance, the following command
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
217 will start the WSI viewer plugin transparently together with Orthanc::
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
218
963
a6bf749b3c04 Orthanc 1.12.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 933
diff changeset
219 $ docker run -p 4242:4242 -p 8042:8042 --rm --name orthanc-wsi jodogne/orthanc-plugins:1.12.1
54
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
220
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
221 Note that we gave the name ``orthanc-wsi`` to this new Docker
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
222 container. Then, the Dicomizer command-line tool can be invoked as
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
223 follows::
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
224
963
a6bf749b3c04 Orthanc 1.12.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 933
diff changeset
225 $ docker run -t -i --rm --link=orthanc-wsi:orthanc --entrypoint=OrthancWSIDicomizer -v /tmp/Source.tif:/tmp/Source.tif:ro jodogne/orthanc-plugins:1.12.1 --username=orthanc --password=orthanc --orthanc=http://orthanc:8042/ /tmp/Source.tif
54
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
226
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
227 This command needs a few explanations:
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
228
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
229 * ``--link=orthanc-wsi:orthanc`` links the container running the
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
230 Dicomizer, to the Docker container running Orthanc that we started
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
231 just before.
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
232 * ``--entrypoint=OrthancWSIDicomizer`` specifies that the Dicomizer
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
233 must be run instead of the Orthanc server.
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
234 * ``-v /tmp/Source.tif:/tmp/Source.tif:ro`` maps the source image
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
235 ``/tmp/Source.tif`` on the host computer into the Orthanc container
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
236 as read-only file ``/tmp/Source.tif``.
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
237 * ``--orthanc=http://orthanc:8042/`` instructs the Dicomizer to push
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
238 images through the ``--link`` created above.
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
239 * ``--username=orthanc --password=orthanc`` correspond to the default
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
240 credentials of the ``orthanc-plugins`` image.
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
241
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
242 Obviously, you are free to add all the options you wish (check out the
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
243 ``--help`` flag to list these options). In particular, the
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
244 ``--dataset`` option allows to specify DICOM tags, in the JSON file
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
245 format, so as to include them in the resulting DICOM series (the
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
246 option ``--sample-dataset`` prints a sample JSON file that has the
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
247 expected format).
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
248
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
249 If you have a source image that is not a hierarchical TIFF, you must
358
011b01ccf52d fixing external hyperlinks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 336
diff changeset
250 instruct the Dicomizer to use `OpenSlide <https://openslide.org/>`__
011b01ccf52d fixing external hyperlinks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 336
diff changeset
251 to decode it by adding the ``--openslide`` option::
54
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
252
963
a6bf749b3c04 Orthanc 1.12.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 933
diff changeset
253 $ docker run -t -i --rm --link=orthanc-wsi:orthanc --entrypoint=OrthancWSIDicomizer -v /tmp/Source.svs:/tmp/Source.svs:ro jodogne/orthanc-plugins:1.12.1 --username=orthanc --password=orthanc --orthanc=http://orthanc:8042/ --openslide=libopenslide.so /tmp/Source.svs
54
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
254
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
255
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
256 PostgreSQL and Orthanc inside Docker
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
257 ------------------------------------
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
258
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
259 It is possible to run both Orthanc and PostgreSQL inside Docker. First, start the official PostgreSQL container::
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
260
363
9c28eeab2db6 removed sudo from docker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 358
diff changeset
261 $ docker run --name some-postgres -e POSTGRES_USER=postgres -e POSTGRES_PASSWORD=pgpassword --rm postgres
54
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
262
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
263 Open another shell, and create a database to host the Orthanc database::
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
264
363
9c28eeab2db6 removed sudo from docker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 358
diff changeset
265 $ docker run -it --link some-postgres:postgres --rm postgres sh -c 'echo "CREATE DATABASE orthanc;" | exec psql -h "$POSTGRES_PORT_5432_TCP_ADDR" -p "$POSTGRES_PORT_5432_TCP_PORT" -U postgres'
54
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
266
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
267 You will have to type the password (cf. the environment variable
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
268 ``POSTGRES_PASSWORD`` above that it set to ``pgpassword``). Then,
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
269 retrieve the IP and the port of the PostgreSQL container, together
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
270 with the default Orthanc configuration file::
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
271
363
9c28eeab2db6 removed sudo from docker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 358
diff changeset
272 $ docker inspect --format '{{ .NetworkSettings.IPAddress }}' some-postgres
9c28eeab2db6 removed sudo from docker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 358
diff changeset
273 $ docker inspect --format '{{ .NetworkSettings.Ports }}' some-postgres
963
a6bf749b3c04 Orthanc 1.12.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 933
diff changeset
274 $ docker run --rm --entrypoint=cat jodogne/orthanc-plugins:1.12.1 /etc/orthanc/orthanc.json > /tmp/orthanc.json
54
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
275
673
767c2550fa00 environment variable in docker compose
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 638
diff changeset
276 .. highlight:: text
54
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
277
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
278 Add the following section to ``/tmp/orthanc.json`` (adapting the
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
279 values Host and Port to what docker inspect said above)::
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
280
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
281 "PostgreSQL" : {
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
282 "EnableIndex" : true,
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
283 "EnableStorage" : true,
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
284 "Host" : "172.17.0.38",
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
285 "Port" : 5432,
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
286 "Database" : "orthanc",
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
287 "Username" : "postgres",
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
288 "Password" : "pgpassword"
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
289 }
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
290
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
291 .. highlight:: bash
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
292
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
293 Finally, you can start Orthanc::
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
294
963
a6bf749b3c04 Orthanc 1.12.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 933
diff changeset
295 $ docker run -p 4242:4242 -p 8042:8042 --rm -v /tmp/orthanc.json:/etc/orthanc/orthanc.json:ro jodogne/orthanc-plugins:1.12.1
54
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
296
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
297
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
298 Debugging
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
299 ---------
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
300
176
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 175
diff changeset
301 .. highlight:: text
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 175
diff changeset
302
54
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
303 For debugging purpose, you can start an interactive bash session as
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
304 follows::
bd0fbf1f0143 docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
305
963
a6bf749b3c04 Orthanc 1.12.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 933
diff changeset
306 $ docker run -i -t --rm --entrypoint=bash jodogne/orthanc:1.12.1
a6bf749b3c04 Orthanc 1.12.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 933
diff changeset
307 $ docker run -i -t --rm --entrypoint=bash jodogne/orthanc-plugins:1.12.1
175
2c87e18ace33 gdb and docker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 166
diff changeset
308
176
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 175
diff changeset
309 For developers and power users, the images ``jodogne/orthanc-debug``
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 175
diff changeset
310 contain the Orthanc core compiled in debug mode (i.e. with runtime
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 175
diff changeset
311 assertions enabled, and including debugging symbols). A ``gdb``
177
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 176
diff changeset
312 command-line session can be started as follows::
176
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 175
diff changeset
313
363
9c28eeab2db6 removed sudo from docker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 358
diff changeset
314 $ docker run -i -t --rm --entrypoint=bash --network=host --cap-add=SYS_PTRACE -p 4242:4242 -p 8042:8042 jodogne/orthanc-debug
176
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 175
diff changeset
315 # gdb --args Orthanc /etc/orthanc/ --verbose
175
2c87e18ace33 gdb and docker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 166
diff changeset
316
184
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 183
diff changeset
317 Exceptions can be automatically caught by launching ``gdb`` as follows::
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 183
diff changeset
318
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 183
diff changeset
319 # gdb --ex 'catch t' --ex r --ex bt --args ./Orthanc /etc/orthanc/ --verbose
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 183
diff changeset
320
176
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 175
diff changeset
321 Note that:
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 175
diff changeset
322
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 175
diff changeset
323 * The plugins are not available in this image yet.
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 175
diff changeset
324
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 175
diff changeset
325 * The Orthanc source code can be found in folder ``/root/orthanc``.
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 175
diff changeset
326
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 175
diff changeset
327 * The build artifacts can be found in folder ``/root/orthanc/Build``.
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 175
diff changeset
328
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 175
diff changeset
329 * This command launches the mainline version. To start a released version,
963
a6bf749b3c04 Orthanc 1.12.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 933
diff changeset
330 use e.g. ``jodogne/orthanc-debug:1.12.1``.