Mercurial > hg > orthanc-book
annotate Sphinx/source/users/debian-packages.rst @ 1006:fd3ad1ac1482
docker image was upgraded
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Fri, 22 Dec 2023 15:21:38 +0100 |
parents | 2e103fb1fa11 |
children | a3436ae3709c |
rev | line source |
---|---|
536
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
1 .. _debian-packages: |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
2 .. highlight:: bash |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
3 |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
4 |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
5 Orthanc packages for Debian/Ubuntu |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
6 ================================== |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
7 |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
8 .. contents:: |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
9 :depth: 3 |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
10 |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
11 |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
12 Introduction |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
13 ------------ |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
14 |
741 | 15 Orthanc is available as an official `Debian package |
536
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
16 <https://packages.debian.org/search?keywords=orthanc&searchon=names&exact=1&suite=all§ion=all>`__ |
666 | 17 that is continuously updated by the Orthanc core developers in the |
18 `Debian Sid/unstable distribution | |
19 <https://wiki.debian.org/DebianUnstable>`__. This implies that Orthanc | |
20 is also available in the `Debian derivative distributions | |
536
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
21 <https://en.wikipedia.org/wiki/List_of_Linux_distributions#Debian-based>`__, |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
22 most notably in `Ubuntu |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
23 <https://packages.ubuntu.com/search?keywords=orthanc&searchon=names&suite=all§ion=all>`__. Most |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
24 of the official plugins are also available as separate packages. |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
25 |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
26 Note that the installed versions depend on the version of the Debian |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
27 distribution. If you absolutely need the latest Orthanc version, you |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
28 should: |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
29 |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
30 * Use the bleeding-edge `Debian unstable |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
31 <https://wiki.debian.org/DebianUnstable>`__, or use a Debian-based |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
32 distro that derives from unstable (such as Kali Linux). |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
33 |
993
05b106383b2a
migration to UCLouvain servers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
963
diff
changeset
|
34 * Use the `LSB binaries <https://orthanc.uclouvain.be/downloads/linux-standard-base/index.html>`__. |
536
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
35 |
888 | 36 * Use ``jodogne/orthanc`` :ref:`Docker images <docker>`. |
37 | |
882
815f70009ec2
highlight osimis/orthanc docker images since jodogne/orthanc images are currently not up-to-date
Alain Mazy <am@osimis.io>
parents:
872
diff
changeset
|
38 * Use ``osimis/orthanc`` :ref:`Docker images <docker-osimis>`. |
536
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
39 |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
40 * :ref:`Compile Orthanc by yourself <compiling>`. |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
41 |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
42 * Advanced users: :ref:`replace the binaries from the package by the |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
43 LSB binaries <lsb-replace-debian-binaries>`. |
666 | 44 |
45 | |
46 **Note about backporting:** Bringing a new version of Orthanc to an | |
47 older Ubuntu/Debian release (typically, a LTS release) is known as | |
48 "backporting". The process for initiating a backport in `Ubuntu | |
49 <https://wiki.ubuntu.com/UbuntuBackports>`__ or in `Debian | |
50 <https://backports.debian.org/>`__ is publicly available, but the core | |
51 developers of Orthanc will not do this packaging task by themselves | |
52 because of a limited bandwidth: You are kindly invited to contribute! | |
536
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
53 |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
54 |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
55 Installation |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
56 ------------ |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
57 |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
58 Prerequisite: make sure to update your package definition before installing:: |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
59 |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
60 $ sudo apt update |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
61 |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
62 To install Orthanc and its plugins:: |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
63 |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
64 $ sudo apt install orthanc |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
65 $ sudo apt install orthanc-dicomweb |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
66 $ sudo apt install orthanc-gdcm |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
67 $ sudo apt install orthanc-imagej |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
68 $ sudo apt install orthanc-mysql |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
69 $ sudo apt install orthanc-postgresql |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
70 $ sudo apt install orthanc-python |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
71 $ sudo apt install orthanc-webviewer |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
72 $ sudo apt install orthanc-wsi |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
73 |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
74 Starting/Stopping the service |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
75 ----------------------------- |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
76 |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
77 Once installed, Orthanc is started as a service. To start/stop/restart, use:: |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
78 |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
79 $ sudo service orthanc start |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
80 $ sudo service orthanc stop |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
81 $ sudo service orthanc restart |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
82 |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
83 |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
84 Accessing the logs |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
85 ------------------ |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
86 |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
87 :ref:`Logs <log>` are available in ``/var/log/orthanc/``. |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
88 |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
89 |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
90 Configuration |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
91 ------------- |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
92 |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
93 Orthanc reads its :ref:`configuration file |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
94 <configuration>` from the ``/etc/orthanc/`` folder. |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
95 |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
96 |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
97 |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
98 Replacing the package from the service by the LSB binaries |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
99 ---------------------------------------------------------- |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
100 |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
101 .. _lsb-replace-debian-binaries: |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
102 |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
103 If you're stuck with an old version of Orthanc, you may try to |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
104 replace the binaries by the LSB binaries. Note that there might |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
105 be some inconsistencies between the plugins version and you should |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
106 do that at your own risk. |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
107 |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
108 This can be done with this sequence of commands:: |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
109 |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
110 $ sudo service orthanc stop |
1000 | 111 $ sudo wget https://orthanc.uclouvain.be/downloads/linux-standard-base/orthanc/1.12.2/Orthanc --output-document /usr/sbin/Orthanc |
997 | 112 $ sudo chmod +x /usr/sbin/Orthanc |
536
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
113 $ sudo rm -f /usr/share/orthanc/plugins/*.so |
1000 | 114 $ sudo wget https://orthanc.uclouvain.be/downloads/linux-standard-base/orthanc/1.12.2/libServeFolders.so --output-document /usr/share/orthanc/plugins/libServeFolders.so |
115 $ sudo wget https://orthanc.uclouvain.be/downloads/linux-standard-base/orthanc/1.12.2/libModalityWorklists.so --output-document /usr/share/orthanc/plugins/libModalityWorklists.so | |
536
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
116 $ |
1000 | 117 $ sudo wget https://orthanc.uclouvain.be/downloads/linux-standard-base/orthanc-dicomweb/1.16/libOrthancDicomWeb.so --output-document /usr/share/orthanc/plugins/libOrthancDicomWeb.so |
536
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
118 $ ... |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
119 $ sudo service orthanc restart |
cdfdedcd078b
additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
535
diff
changeset
|
120 |