Mercurial > hg > orthanc-book

comparison Sphinx/source/plugins/indexer.rst @ 778:4707c55080c8

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
documentation of folder indexer plugin
author Sebastien Jodogne <s.jodogne@gmail.com>
date Fri, 24 Sep 2021 13:45:07 +0200
parents 3971710d9d45
children 15f017e7555b
comparison
equal deleted inserted replaced
777:5caf286f8a0a 778:4707c55080c8
1 .. _indexer: 1 .. _indexer:
2 2
3 3
4 Indexer plugin 4 Folder Indexer plugin
5 ============== 5 =====================
6 6
7 .. contents:: 7 .. contents::
8 8
9 Soon available. 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. This way, the filesystem is
15 automatically organized according to the :ref:`DICOM model of the real
16 world <model-world>`, without any manual intervention. The indexed
17 DICOM resources are immediately available in a Web interface and in a
18 Web viewer, and can be queried/retrieved by DICOM clients. The DICOM
19 files are **not** copied, so this solution has a very small footprint
20 in terms of storage requirements.
21
22
23 Compilation
24 -----------
25
26 .. highlight:: bash
27
28 Official releases can be `downloaded from the Orthanc homepage
29 <https://www.orthanc-server.com/browse.php?path=/plugin-indexer>`__. As
30 an alternative, the `repository containing the source code
31 <https://hg.orthanc-server.com/orthanc-indexer/>`__ can be accessed using
32 Mercurial.
33
34 The procedure to compile this plugin is similar of that for the
35 :ref:`core of Orthanc <binaries>`. The following commands should work
36 for most UNIX-like distribution (including GNU/Linux)::
37
38 $ mkdir Build
39 $ cd Build
40 $ cmake .. -DSTATIC_BUILD=ON -DCMAKE_BUILD_TYPE=Release
41 $ make
42
43 The compilation will produce a shared library ``OrthancIndexer``
44 that contains the folder indexer plugin for Orthanc.
45
46 Pre-compiled Linux Standard Base (LSB) binaries `can be downloaded
47 <https://lsb.orthanc-server.com/plugin-indexer/>`__.
48
49 Pre-compiled binaries for Microsoft Windows and macOS `are also
50 available
51 <https://www.orthanc-server.com/browse.php?path=/plugin-indexer>`__.
52
53 Furthermore, the :ref:`Docker images <docker>`
54 ``jodogne/orthanc-plugins`` and ``osimis/orthanc`` also contain the
55 plugin.
56
57
58 Usage
59 -----
60
61 .. highlight:: json
62
63 Here is a minimal sample :ref:`configuration file <configuration>` to
64 use this plugin::
65
66 {
67 "Plugins" : [
68 "/home/user/OrthancTcia/Build/libOrthancTcia.so"
69 ],
70 "Indexer" : {
71 "Enable" : true,
72 "Folders" : [ "/home/user/DICOM" ], // List of folders to synchronize
73 "Interval" : 10 // Delay between two synchronizations
74 }
75 }
76
77 Orthanc must of course be restarted after the modification of its
78 configuration file.
79
80 Once Orthanc is started, the folders are transparently synchronized
81 without any further interaction. You can start Orthanc with the
82 ``--verbose-plugins`` command-line option in order to monitor the
83 synchronization process.