Mercurial > hg > orthanc-book

annotate Sphinx/source/users/debian-packages.rst @ 858:09be5f68aabf

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
dicom-web and MainDicomTags
author Alain Mazy <am@osimis.io>
date Thu, 23 Jun 2022 15:12:56 +0200
parents c29ac12e3160
children 3e8a3a900e9e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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
97e6a0431c5e Orthanc 1.9.6
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 735
diff changeset
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&section=all>`__
666
9461a56f225f backporting
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 638
diff changeset
17 that is continuously updated by the Orthanc core developers in the
9461a56f225f backporting
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 638
diff changeset
18 `Debian Sid/unstable distribution
9461a56f225f backporting
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 638
diff changeset
19 <https://wiki.debian.org/DebianUnstable>`__. This implies that Orthanc
9461a56f225f backporting
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 638
diff changeset
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&section=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
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
34 * Use the `LSB binaries <https://lsb.orthanc-server.com/>`__.
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
35
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
36 * Use :ref:`Docker <docker>`.
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
37
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
38 * :ref:`Compile Orthanc by yourself <compiling>`.
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 * 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
41 LSB binaries <lsb-replace-debian-binaries>`.
666
9461a56f225f backporting
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 638
diff changeset
42
9461a56f225f backporting
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 638
diff changeset
43
9461a56f225f backporting
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 638
diff changeset
44 **Note about backporting:** Bringing a new version of Orthanc to an
9461a56f225f backporting
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 638
diff changeset
45 older Ubuntu/Debian release (typically, a LTS release) is known as
9461a56f225f backporting
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 638
diff changeset
46 "backporting". The process for initiating a backport in `Ubuntu
9461a56f225f backporting
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 638
diff changeset
47 <https://wiki.ubuntu.com/UbuntuBackports>`__ or in `Debian
9461a56f225f backporting
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 638
diff changeset
48 <https://backports.debian.org/>`__ is publicly available, but the core
9461a56f225f backporting
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 638
diff changeset
49 developers of Orthanc will not do this packaging task by themselves
9461a56f225f backporting
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 638
diff changeset
50 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
51
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
52
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
53 Installation
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
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
56 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
57
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
58 $ sudo apt update
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 To install Orthanc and its plugins::
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 $ sudo apt install orthanc
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
63 $ sudo apt install orthanc-dicomweb
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
64 $ sudo apt install orthanc-gdcm
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
65 $ sudo apt install orthanc-imagej
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
66 $ sudo apt install orthanc-mysql
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
67 $ sudo apt install orthanc-postgresql
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
68 $ sudo apt install orthanc-python
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
69 $ sudo apt install orthanc-webviewer
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
70 $ sudo apt install orthanc-wsi
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
71
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
72 Starting/Stopping the service
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
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
75 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
76
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
77 $ sudo service orthanc start
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
78 $ sudo service orthanc stop
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
79 $ sudo service orthanc restart
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
80
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
81
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
82 Accessing the logs
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
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
85 :ref:`Logs <log>` are available in ``/var/log/orthanc/``.
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
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
88 Configuration
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
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
91 Orthanc reads its :ref:`configuration file
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
92 <configuration>` from the ``/etc/orthanc/`` folder.
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
93
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
94
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 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
97 ----------------------------------------------------------
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
98
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
99 .. _lsb-replace-debian-binaries:
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 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
102 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
103 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
104 do that at your own risk.
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
105
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
106 This can be done with this sequence of commands::
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 $ sudo service orthanc stop
839
c29ac12e3160 Orthanc-1.11.0
Alain Mazy <am@osimis.io>
parents: 825
diff changeset
109 $ sudo wget https://lsb.orthanc-server.com/orthanc/1.11.0/Orthanc --output-document /usr/sbin/Orthanc
536
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
110 $ sudo rm -f /usr/share/orthanc/plugins/*.so
839
c29ac12e3160 Orthanc-1.11.0
Alain Mazy <am@osimis.io>
parents: 825
diff changeset
111 $ sudo wget https://lsb.orthanc-server.com/orthanc/1.11.0/libServeFolders.so --output-document /usr/share/orthanc/plugins/libServeFolders.so
c29ac12e3160 Orthanc-1.11.0
Alain Mazy <am@osimis.io>
parents: 825
diff changeset
112 $ sudo wget https://lsb.orthanc-server.com/orthanc/1.11.0/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
113 $
719
8a247c645ac6 Orthanc 1.9.4
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 678
diff changeset
114 $ sudo wget https://lsb.orthanc-server.com/plugin-dicom-web/1.6/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
115 $ ...
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
116 $ sudo service orthanc restart
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
117