Mercurial > hg > orthanc-book
annotate Sphinx/source/users/cookbook.rst @ 711:4f658c25addd
bulk anonymization/modification
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Wed, 16 Jun 2021 17:05:36 +0200 |
parents | d5a646b2b421 |
children | db20ad016bc2 |
rev | line source |
---|---|
0 | 1 .. highlight:: bash |
2 .. _cookbook: | |
3 | |
4 Quickstart | |
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>`__. |
54
bd0fbf1f0143
docker documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
31
diff
changeset
|
19 * :ref:`Use Docker <docker>`. |
572 | 20 * On GNU/Linux, use precompiled packages for :ref:`Debian/Ubuntu |
573 | 21 <debian-packages>`, or for `openSUSE |
22 <https://software.opensuse.org/search?q=orthanc>`__ (courtesy of | |
23 Axel Braun). | |
574 | 24 * On GNU/Linux, use our `LSB binaries |
25 <https://lsb.orthanc-server.com/>`__ (Linux Standard Base), that | |
26 should easily and immediately run on most distributions. Those | |
27 binaries are statically linked together with all their third-party | |
669 | 28 dependencies. Don't forget to execute ``chmod +x ./Orthanc`` in |
29 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
|
30 * :ref:`Compile Orthanc by yourself <compiling>`. |
26 | 31 * External contributors are also maintaining `Vagrant VM for Orthanc |
358
011b01ccf52d
fixing external hyperlinks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
292
diff
changeset
|
32 <https://github.com/jodogne/OrthancContributed/blob/master/Links.md#user-content-vagrant>`__. |
0 | 33 |
34 | |
35 .. _orthanc-explorer: | |
36 | |
37 Opening Orthanc Explorer | |
38 ------------------------ | |
39 | |
40 The most straightforward way to use Orthanc consists in opening | |
41 **Orthanc Explorer**, the embedded administrative interface of | |
42 Orthanc, with a Web browser. Once Orthanc is running, open the | |
43 following URL: http://localhost:8042/app/explorer.html. Please note | |
44 that: | |
45 | |
46 * The port number 8042 depends on your :ref:`configuration | |
47 <configuration>`. | |
48 * Orthanc Explorer does not work with Microsoft Internet | |
49 Explorer. Please use Mozilla Firefox, Google Chrome, Apple Safari, | |
50 or `any WebKit-based Web browser <https://en.wikipedia.org/wiki/WebKit>`__. | |
51 | |
52 | |
53 Uploading DICOM files | |
54 --------------------- | |
55 | |
56 The Orthanc Explorer interface contains a user-friendly page to upload | |
57 DICOM files. You can reach the upload page at | |
58 http://localhost:8042/app/explorer.html#upload. Then, you can drag and | |
59 drop your DICOM files and click on the Upload button. | |
60 | |
61 You can `watch this video tutorial | |
62 <https://www.youtube.com/watch?v=4dOcXGMlcFo&hd=1>`__ that shows how | |
26 | 63 to upload files to Orthanc through Orthanc Explorer with Chromium. |
64 | |
65 **Important:** There is currently a `known issue | |
445
987fbbc2b59e
leaving bitbucket wrt. bug tracker
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
358
diff
changeset
|
66 <https://bugs.orthanc-server.com/show_bug.cgi?id=21>`__ that might |
987fbbc2b59e
leaving bitbucket wrt. bug tracker
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
358
diff
changeset
|
67 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
|
68 drag-and-drop. |
0 | 69 |
70 | |
71 Uploading through the DICOM protocol | |
72 ------------------------------------ | |
73 | |
74 Once Orthanc is up and running, any imaging modality can send | |
75 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
|
76 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
|
77 connect your modality to Orthanc. |
0 | 78 |
292
8aa416899db4
added a tuto to connect a modality to Orthanc
Alain Mazy <alain@mazy.be>
parents:
54
diff
changeset
|
79 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
|
80 `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
|
81 send DICOM images to Orthanc, for instance:: |
0 | 82 |
83 $ storescu -aec ORTHANC localhost 4242 *.dcm | |
84 | |
85 will send all the files with ".dcm" extension to the instance of | |
86 Orthanc that is running on the ``localhost``, whose application entity | |
87 title (AET) is ``ORTHANC``, and whose DICOM port is | |
88 ``4242``. Obviously, all these parameters depend on your | |
89 :ref:`configuration <configuration>`. Please check the :ref:`FAQ | |
90 <dicom>` if you encounter any problem. | |
91 | |
92 | |
93 Next steps | |
94 ---------- | |
95 | |
96 1. Read the general introduction ":ref:`dicom-guide`". | |
97 2. Have a look at your :ref:`configuration file <configuration>`. | |
98 3. Drive Orthanc through its :ref:`REST API <rest>`. | |
99 4. Automate DICOM tasks with :ref:`Lua scripts <lua>`. | |
100 |