Mercurial > hg > orthanc-book
annotate Sphinx/source/users/cookbook.rst @ 1113:a588960a72e5 default tip
spelling
| author | Alain Mazy <am@orthanc.team> |
|---|---|
| date | Mon, 28 Oct 2024 09:23:08 +0100 |
| parents | c825cf4672f2 |
| children |
| rev | line source |
|---|---|
| 0 | 1 .. highlight:: bash |
| 2 .. _cookbook: | |
| 3 | |
|
1096
c825cf4672f2
quick start guide for windows
Alain Mazy <am@orthanc.team>
parents:
1080
diff
changeset
|
4 Quickstart (all platforms) |
| 0 | 5 ========== |
| 6 | |
| 7 .. contents:: | |
| 8 :depth: 2 | |
| 9 | |
| 10 | |
|
31
93bbfaf0e62c
worklist instructions migrated to a specific page, indexing of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
28
diff
changeset
|
11 .. _binaries: |
| 28 | 12 |
| 0 | 13 Obtaining binaries |
| 14 ------------------ | |
| 15 | |
| 16 To obtain the Orthanc binaries, you have several possibilities: | |
| 17 | |
|
358
011b01ccf52d
fixing external hyperlinks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
292
diff
changeset
|
18 * `Download pre-compiled packages <https://www.orthanc-server.com/download.php>`__. |
|
887
db16e0fffe67
re-indexing of the jodogne/orthanc Docker images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
882
diff
changeset
|
19 * Use ``jodogne/orthanc`` :ref:`Docker images <docker>`. |
|
1023
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
999
diff
changeset
|
20 * Use ``orthancteam/orthanc`` :ref:`Docker images <docker-orthancteam>`. |
| 572 | 21 * On GNU/Linux, use precompiled packages for :ref:`Debian/Ubuntu |
|
801
db20ad016bc2
standalone debian repository
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
669
diff
changeset
|
22 <debian-packages>` (courtesy of DebianMed and Sébastien Jodogne), or |
|
db20ad016bc2
standalone debian repository
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
669
diff
changeset
|
23 for `openSUSE <https://software.opensuse.org/search?q=orthanc>`__ |
|
db20ad016bc2
standalone debian repository
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
669
diff
changeset
|
24 (courtesy of Axel Braun). |
| 574 | 25 * On GNU/Linux, use our `LSB binaries |
|
993
05b106383b2a
migration to UCLouvain servers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
991
diff
changeset
|
26 <https://orthanc.uclouvain.be/downloads/linux-standard-base/index.html>`__ (Linux Standard Base), that |
| 574 | 27 should easily and immediately run on most distributions. Those |
| 28 binaries are statically linked together with all their third-party | |
| 669 | 29 dependencies. Don't forget to execute ``chmod +x ./Orthanc`` in |
| 30 order to be able to run the main Orthanc executable. | |
|
292
8aa416899db4
added a tuto to connect a modality to Orthanc
Alain Mazy <alain@mazy.be>
parents:
54
diff
changeset
|
31 * :ref:`Compile Orthanc by yourself <compiling>`. |
| 26 | 32 * External contributors are also maintaining `Vagrant VM for Orthanc |
|
358
011b01ccf52d
fixing external hyperlinks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
292
diff
changeset
|
33 <https://github.com/jodogne/OrthancContributed/blob/master/Links.md#user-content-vagrant>`__. |
| 0 | 34 |
|
801
db20ad016bc2
standalone debian repository
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
669
diff
changeset
|
35 .. highlight:: bash |
|
db20ad016bc2
standalone debian repository
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
669
diff
changeset
|
36 |
|
db20ad016bc2
standalone debian repository
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
669
diff
changeset
|
37 Furthermore, if you are running Debian 9 (stretch), Debian 10 |
| 958 | 38 (buster), Debian 11 (bullseye), Debian 12 (bookworm), Ubuntu 18.04 LTS |
| 39 (bionic), Ubuntu 20.04 LTS (focal), or Ubuntu 22.04 LTS (jammy) on an | |
| 40 **AMD64 architecture**, Sébastien Jodogne maintains a **standalone | |
| 41 Debian repository** that provides the latest versions of the LSB | |
|
925
897903f8deb8
added volview plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
42 binaries. For instance, here is how to install the :ref:`Stone Web |
|
897903f8deb8
added volview plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
43 viewer <stone_webviewer>` on a barebone Docker setup:: |
|
801
db20ad016bc2
standalone debian repository
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
669
diff
changeset
|
44 |
|
db20ad016bc2
standalone debian repository
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
669
diff
changeset
|
45 # docker run --rm -t -i -p 8042:8042 -p 4242:4242 debian:9 |
|
db20ad016bc2
standalone debian repository
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
669
diff
changeset
|
46 |
|
db20ad016bc2
standalone debian repository
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
669
diff
changeset
|
47 $ apt update |
|
db20ad016bc2
standalone debian repository
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
669
diff
changeset
|
48 $ DEBIAN_FRONTEND=noninteractive apt install -y software-properties-common wget curl nano gnupg apt-transport-https |
|
db20ad016bc2
standalone debian repository
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
669
diff
changeset
|
49 |
|
db20ad016bc2
standalone debian repository
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
669
diff
changeset
|
50 $ apt install --upgrade ca-certificates |
|
db20ad016bc2
standalone debian repository
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
669
diff
changeset
|
51 $ wget -qO - https://debian.orthanc-labs.com/archive.key | apt-key add - |
|
db20ad016bc2
standalone debian repository
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
669
diff
changeset
|
52 $ apt-add-repository "deb https://debian.orthanc-labs.com/ `grep VERSION_CODENAME /etc/os-release | cut -d'=' -f 2` main" |
|
db20ad016bc2
standalone debian repository
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
669
diff
changeset
|
53 |
|
db20ad016bc2
standalone debian repository
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
669
diff
changeset
|
54 $ apt clean && apt update |
|
db20ad016bc2
standalone debian repository
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
669
diff
changeset
|
55 $ apt install orthanc-stone-webviewer |
|
db20ad016bc2
standalone debian repository
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
669
diff
changeset
|
56 $ /etc/init.d/orthanc start |
|
db20ad016bc2
standalone debian repository
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
669
diff
changeset
|
57 |
|
803
f3caa014eb88
note about Python plugin in the standalone Debian repo
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
801
diff
changeset
|
58 Note that this standalone Debian repository **does not** contain the |
| 999 | 59 :ref:`Python plugin <python-plugin>` and the :ref:`Java plugin |
| 60 <java-plugin>`, because these plugins must be dynamically linked | |
| 61 against the system-wide version of your Python or Java runtime | |
| 62 environment. You should install the ``orthanc-python`` or | |
| 63 ``orthanc-java`` package from your native Debian/Ubuntu distribution | |
| 64 if available, or compile the plugin from sources. | |
|
801
db20ad016bc2
standalone debian repository
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
669
diff
changeset
|
65 |
| 0 | 66 |
| 67 .. _orthanc-explorer: | |
| 68 | |
| 69 Opening Orthanc Explorer | |
| 70 ------------------------ | |
| 71 | |
| 72 The most straightforward way to use Orthanc consists in opening | |
| 73 **Orthanc Explorer**, the embedded administrative interface of | |
| 74 Orthanc, with a Web browser. Once Orthanc is running, open the | |
| 75 following URL: http://localhost:8042/app/explorer.html. Please note | |
| 76 that: | |
| 77 | |
| 78 * The port number 8042 depends on your :ref:`configuration | |
| 79 <configuration>`. | |
| 80 * Orthanc Explorer does not work with Microsoft Internet | |
| 81 Explorer. Please use Mozilla Firefox, Google Chrome, Apple Safari, | |
| 82 or `any WebKit-based Web browser <https://en.wikipedia.org/wiki/WebKit>`__. | |
| 83 | |
| 1080 | 84 **Note** that, if you have installed Orthanc through the Windows Installer |
| 85 or through a Docker image, you very likely have access to the more user friendly | |
| 86 :ref:`Orthanc Explorer 2 <orthanc-explorer-2>` interface on | |
| 87 http://localhost:8042/ui/app/. | |
| 88 | |
| 0 | 89 |
| 90 Uploading DICOM files | |
| 91 --------------------- | |
| 92 | |
| 93 The Orthanc Explorer interface contains a user-friendly page to upload | |
| 94 DICOM files. You can reach the upload page at | |
| 95 http://localhost:8042/app/explorer.html#upload. Then, you can drag and | |
| 96 drop your DICOM files and click on the Upload button. | |
| 97 | |
| 98 You can `watch this video tutorial | |
| 99 <https://www.youtube.com/watch?v=4dOcXGMlcFo&hd=1>`__ that shows how | |
| 26 | 100 to upload files to Orthanc through Orthanc Explorer with Chromium. |
| 101 | |
| 102 **Important:** There is currently a `known issue | |
|
991
1316bc62b5d5
migration to UCLouvain servers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
958
diff
changeset
|
103 <https://orthanc.uclouvain.be/bugs/show_bug.cgi?id=21>`__ that might |
|
445
987fbbc2b59e
leaving bitbucket wrt. bug tracker
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
358
diff
changeset
|
104 prevent Mozilla Firefox to correctly upload all DICOM files if using |
|
987fbbc2b59e
leaving bitbucket wrt. bug tracker
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
358
diff
changeset
|
105 drag-and-drop. |
| 0 | 106 |
| 107 | |
| 108 Uploading through the DICOM protocol | |
| 109 ------------------------------------ | |
| 110 | |
| 111 Once Orthanc is up and running, any imaging modality can send | |
| 112 instances to Orthanc through the DICOM protocol (with the C-Store | |
|
292
8aa416899db4
added a tuto to connect a modality to Orthanc
Alain Mazy <alain@mazy.be>
parents:
54
diff
changeset
|
113 command). Check :ref:`this tutorial <configure-modality>` to |
|
8aa416899db4
added a tuto to connect a modality to Orthanc
Alain Mazy <alain@mazy.be>
parents:
54
diff
changeset
|
114 connect your modality to Orthanc. |
| 0 | 115 |
|
292
8aa416899db4
added a tuto to connect a modality to Orthanc
Alain Mazy <alain@mazy.be>
parents:
54
diff
changeset
|
116 You can also use the standard command-line tool ``storescu`` from the |
|
358
011b01ccf52d
fixing external hyperlinks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
292
diff
changeset
|
117 `DCMTK software <https://dicom.offis.de/dcmtk.php.en>`__ to manually |
|
011b01ccf52d
fixing external hyperlinks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
292
diff
changeset
|
118 send DICOM images to Orthanc, for instance:: |
| 0 | 119 |
| 120 $ storescu -aec ORTHANC localhost 4242 *.dcm | |
| 121 | |
| 122 will send all the files with ".dcm" extension to the instance of | |
| 123 Orthanc that is running on the ``localhost``, whose application entity | |
| 124 title (AET) is ``ORTHANC``, and whose DICOM port is | |
| 125 ``4242``. Obviously, all these parameters depend on your | |
| 126 :ref:`configuration <configuration>`. Please check the :ref:`FAQ | |
| 127 <dicom>` if you encounter any problem. | |
| 128 | |
| 129 | |
| 130 Next steps | |
| 131 ---------- | |
| 132 | |
| 133 1. Read the general introduction ":ref:`dicom-guide`". | |
| 134 2. Have a look at your :ref:`configuration file <configuration>`. | |
| 135 3. Drive Orthanc through its :ref:`REST API <rest>`. | |
| 136 4. Automate DICOM tasks with :ref:`Lua scripts <lua>`. | |
| 137 |