Mercurial > hg > orthanc-book

annotate Sphinx/source/users/debian-packages.rst @ 537:2c8f4eca3cd2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
fix toctree
author Sebastien Jodogne <s.jodogne@gmail.com>
date Thu, 05 Nov 2020 07:36:18 +0100
parents cdfdedcd078b
children 4f3a6145ae34
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
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
15 Orthanc is available as an offical `Debian package
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>`__
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
17 that is continuously updated by the Orthanc core developers. This
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
18 implies that Orthanc is also available in the `Debian derivative
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
19 distributions
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
20 <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
21 most notably in `Ubuntu
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
22 <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
23 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
24
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
25 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
26 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
27 should:
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
28
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
29 * Use the bleeding-edge `Debian unstable
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
30 <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
31 distro that derives from unstable (such as Kali Linux).
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
32
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
33 * Use the `LSB binaries <https://lsb.orthanc-server.com/>`__.
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
34
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
35 * Use :ref:`Docker <docker>`.
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
36
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
37 * :ref:`Compile Orthanc by yourself <compiling>`.
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
38
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
39 * 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
40 LSB binaries <lsb-replace-debian-binaries>`.
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
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
43 Installation
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
44 ------------
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
45
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
46 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
47
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
48 $ sudo apt update
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
49
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
50 To install Orthanc and its plugins::
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 $ sudo apt install orthanc
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
53 $ sudo apt install orthanc-dicomweb
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
54 $ sudo apt install orthanc-gdcm
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
55 $ sudo apt install orthanc-imagej
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
56 $ sudo apt install orthanc-mysql
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
57 $ sudo apt install orthanc-postgresql
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
58 $ sudo apt install orthanc-python
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
59 $ sudo apt install orthanc-webviewer
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
60 $ sudo apt install orthanc-wsi
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 Starting/Stopping the service
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
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
65 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
66
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
67 $ sudo service orthanc start
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
68 $ sudo service orthanc stop
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
69 $ sudo service orthanc restart
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
70
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 Accessing the logs
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 :ref:`Logs <log>` are available in ``/var/log/orthanc/``.
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
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
78 Configuration
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
79 -------------
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 Orthanc reads its :ref:`configuration file
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
82 <configuration>` from the ``/etc/orthanc/`` folder.
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
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
86 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
87 ----------------------------------------------------------
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 .. _lsb-replace-debian-binaries:
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 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
92 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
93 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
94 do that at your own risk.
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 This can be done with this sequence of commands::
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 $ sudo service orthanc stop
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
99 $ sudo wget https://lsb.orthanc-server.com/orthanc/1.8.0/Orthanc --output-document /usr/sbin/Orthanc
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
100 $ sudo rm -f /usr/share/orthanc/plugins/*.so
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
101 $ sudo wget https://lsb.orthanc-server.com/orthanc/1.8.0/libServeFolders.so --output-document /usr/share/orthanc/plugins/libServeFolders.so
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
102 $ sudo wget https://lsb.orthanc-server.com/orthanc/1.8.0/libModalityWorklists.so --output-document /usr/share/orthanc/plugins/libModalityWorklists.so
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
103 $
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
104 $ sudo wget https://lsb.orthanc-server.com/plugin-dicom-web/1.3/libOrthancDicomWeb.so --output-document /usr/share/orthanc/plugins/libOrthancDicomWeb.so
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 $ sudo service orthanc restart
cdfdedcd078b additional info about debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 535
diff changeset
107