Mercurial > hg > orthanc-book

comparison Sphinx/source/plugins/indexer.rst @ 810:c8afdaeb877a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
merge
author Alain Mazy <am@osimis.io>
date Mon, 14 Feb 2022 08:52:12 +0100
parents 57d1b1680e71
children 5c1ce758f748
comparison
equal deleted inserted replaced
809:23f21a00b03b 810:c8afdaeb877a
1 .. _indexer:
2
3
4 Folder Indexer plugin
5 =====================
6
7 .. contents::
8
9 This **official** plugin by the `ICTEAM institute of UCLouvain
10 <https://uclouvain.be/en/research-institutes/icteam>`__ uses Orthanc
11 to publish filesystems containing medical images as a DICOM modality.
12
13 The plugin continuously synchronizes the content of an Orthanc server
14 with the content of a filesystem, which can then be accessed, through
15 Orthanc, based on the :ref:`DICOM model of the real world <model-world>`.
16 The indexed DICOM resources are immediately available in a Web
17 interface and in a Web viewer, and can be queried/retrieved by DICOM
18 clients. The DICOM files are **not** copied, so this solution has a
19 very small footprint in terms of storage requirements.
20
21
22 Compilation
23 -----------
24
25 .. highlight:: bash
26
27 Official releases can be `downloaded from the Orthanc homepage
28 <https://www.orthanc-server.com/browse.php?path=/plugin-indexer>`__. As
29 an alternative, the `repository containing the source code
30 <https://hg.orthanc-server.com/orthanc-indexer/>`__ can be accessed using
31 Mercurial.
32
33 The procedure to compile this plugin is similar of that for the
34 :ref:`core of Orthanc <binaries>`. The following commands should work
35 for most UNIX-like distribution (including GNU/Linux)::
36
37 $ mkdir Build
38 $ cd Build
39 $ cmake .. -DSTATIC_BUILD=ON -DCMAKE_BUILD_TYPE=Release
40 $ make
41
42 The compilation will produce a shared library ``OrthancIndexer``
43 that contains the folder indexer plugin for Orthanc.
44
45 Pre-compiled Linux Standard Base (LSB) binaries `can be downloaded
46 <https://lsb.orthanc-server.com/plugin-indexer/>`__.
47
48 Pre-compiled binaries for Microsoft Windows and macOS `are also
49 available
50 <https://www.orthanc-server.com/browse.php?path=/plugin-indexer>`__.
51
52 Furthermore, the :ref:`Docker images <docker>`
53 ``jodogne/orthanc-plugins`` and ``osimis/orthanc`` also contain the
54 plugin.
55
56
57 Usage
58 -----
59
60 .. highlight:: json
61
62 Here is a minimal sample :ref:`configuration file <configuration>` to
63 use this plugin::
64
65 {
66 "Plugins" : [
67 "/home/user/OrthancIndexer/Build/libOrthancIndexer.so"
68 ],
69 "Indexer" : {
70 "Enable" : true,
71 "Folders" : [ "/home/user/DICOM" ], // List of folders to synchronize
72 "Interval" : 10 // Delay between two synchronizations
73 }
74 }
75
76 Orthanc must of course be restarted after the modification of its
77 configuration file.
78
79 Once Orthanc is started, the folders are transparently synchronized
80 without any further interaction. You can start Orthanc with the
81 ``--verbose-plugins`` command-line option in order to monitor the
82 synchronization process.
83
84 Some remarks:
85
86 * This plugin cannot be used together with other custom storage area
87 plugins (such as :ref:`cloud object storage <object-storage>`).
88
89 * Even if the folder indexer plugin is in use, you can still add other
90 DICOM files using the :ref:`REST API <rest>` or the :ref:`DICOM
91 network protocol <dicom-protocol>`. Such files would be stored in
92 the ``OrthancStorage`` :ref:`usual folder <orthanc-storage-area>`.
93