annotate Sphinx/source/users/debian-packages.rst @ 535:a3f1ddc56b6e

added debian/ubuntu package doc
author Alain Mazy <alain@mazy.be>
date Wed, 04 Nov 2020 09:54:11 +0100
parents
children cdfdedcd078b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
535
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
1 .. _debian-packages:
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
2 .. highlight:: bash
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
3
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
4
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
5 Orthanc packages for Debian/Ubuntu
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
6 ==================================
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
7
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
8 .. toctree::
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
9 :hidden:
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
10
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
11 docker-osimis.rst
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
12
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
13
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
14 .. contents::
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
15 :depth: 3
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
16
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
17
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
18 Introduction
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
19 ------------
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
20
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
21 Orthanc is available as offical `Debian
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
22 <https://packages.debian.org/search?keywords=orthanc&searchon=names&exact=1&suite=all&section=all>`__
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
23 and `Ubuntu
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
24 <https://packages.ubuntu.com/search?keywords=orthanc&searchon=names&suite=all&section=all>`__
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
25 packages. Most of the official plugins are also available as separate packages.
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
26
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
27 Note that the installed versions depend on the OS version. If you absolutely need
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
28 the latest Orthanc version, you should:
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
29
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
30 * Use the latest `unstable Debian release <https://wiki.debian.org/DebianUnstable>`__.
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
31
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
32 * Use the `LSB binaries <https://lsb.orthanc-server.com/>`__.
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
33
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
34 * Use :ref:`Docker <docker>`.
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
35
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
36 * :ref:`Compile Orthanc by yourself <compiling>`.
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
37
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
38 * Advanced users: :ref:`replace the binaries from the package by the LSB binaries <replace-binaries>`.
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
39
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
40 Installation
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
41 ------------
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
42
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
43 Prerequisite: make sure to update your package definition before installing::
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
44
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
45 $ sudo apt update
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
46
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
47 To install Orthanc and its plugins::
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
48
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
49 $ sudo apt install orthanc
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
50 $ sudo apt install orthanc-dicomweb
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
51 $ sudo apt install orthanc-gdcm
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
52 $ sudo apt install orthanc-imagej
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
53 $ sudo apt install orthanc-mysql
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
54 $ sudo apt install orthanc-postgresql
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
55 $ sudo apt install orthanc-python
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
56 $ sudo apt install orthanc-webviewer
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
57 $ sudo apt install orthanc-wsi
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
58
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
59 Starting/Stopping the service
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
60 -----------------------------
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
61
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
62 Once installed, Orthanc is started as a service. To start/stop/restart, use::
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
63
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
64 $ sudo service orthanc start
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
65 $ sudo service orthanc stop
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
66 $ sudo service orthanc restart
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
67
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
68
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
69 Accessing the logs
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
70 ------------------
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
71
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
72 :ref:`Logs <log>` are available in ``/var/log/orthanc/``.
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
73
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
74
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
75 Configuration
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
76 -------------
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
77
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
78 Orthanc reads its :ref:`configuration file
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
79 <configuration>` from the ``/etc/orthanc/`` folder.
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
80
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
81
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
82
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
83 Replacing the package from the service by the LSB binaries
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
84 ----------------------------------------------------------
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
85
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
86 .. _replace-binaries:
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
87
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
88 If you're stuck with an old version of Orthanc, you may try to
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
89 replace the binaries by the LSB binaries. Note that there might
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
90 be some inconsistencies between the plugins version and you should
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
91 do that at your own risk.
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
92
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
93 This can be done with this sequence of commands::
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
94
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
95 $ sudo service orthanc stop
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
96 $ sudo wget https://lsb.orthanc-server.com/orthanc/1.8.0/Orthanc --output-document /usr/sbin/Orthanc
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
97 $ sudo rm -f /usr/share/orthanc/plugins/*.so
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
98 $ sudo wget https://lsb.orthanc-server.com/orthanc/1.8.0/libServeFolders.so --output-document /usr/share/orthanc/plugins/libServeFolders.so
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
99 $ sudo wget https://lsb.orthanc-server.com/orthanc/1.8.0/libModalityWorklists.so --output-document /usr/share/orthanc/plugins/libModalityWorklists.so
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
100 $
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
101 $ sudo wget https://lsb.orthanc-server.com/plugin-dicom-web/1.3/libOrthancDicomWeb.so --output-document /usr/share/orthanc/plugins/libOrthancDicomWeb.so
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
102 $ ...
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
103 $ sudo service orthanc restart
a3f1ddc56b6e added debian/ubuntu package doc
Alain Mazy <alain@mazy.be>
parents:
diff changeset
104