Mercurial > hg > orthanc-book

annotate Sphinx/source/users/replication.rst @ 46:12b204ee328d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
remark about replication
author Sebastien Jodogne <s.jodogne@gmail.com>
date Fri, 07 Oct 2016 08:07:24 +0200
parents 901e8961f46e
children 16d516fdc642
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 .. highlight:: bash
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 .. _replication:
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 Replication and upgrade
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5 =======================
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 This page explains how to replicate the content of one instance of
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 Orthanc to another instance of Orthanc. This is useful to **upgrade**
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 between :ref:`versions of the database schema <db-versioning>`, or to
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 create **mirrored DICOM servers**.
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 Note that if you only want to automatically upgrade the database for
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 successive versions of Orthanc, you most probably only have to add the
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 ``--upgrade`` command-line option while starting Orthanc.
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 Direct access to the filesystem
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 -------------------------------
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 The most direct way to replicate consists in using the
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 `ImportDicomFiles
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 <https://bitbucket.org/sjodogne/orthanc/src/default/Resources/Samples/ImportDicomFiles/ImportDicomFiles.py>`_
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 script of the Orthanc distribution. For instance, the following
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 command would recursively explore the content of the ``OrthancStorage``
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 folder (where Orthanc stores its DICOM files by default), and send
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26 each DICOM file inside this folder to the instance of Orthanc whose
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27 REST API is listening on ``http://192.168.0.2:8042``::
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 $ python ImportDicomFiles.py 192.168.0.2 8042 OrthancStorage
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31 This method will only succeed if:
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33 * The source Orthanc uses the default SQLite back-end of Orthanc (and
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34 not the `PostgreSQL plugin
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35 <http://www.orthanc-server.com/static.php?page=postgresql>`_, for
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36 instance),
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37 * You have command-line access to the source Orthanc, and
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38 * The transparent :ref:`compression` of the DICOM instances is
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39 disabled (cf. option ``StorageCompression`` in the
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40 :ref:`configuration file <configuration>`).
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41
46
12b204ee328d remark about replication
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
42 **Important remark:** Because of :ref:`the way Orthanc stores its
12b204ee328d remark about replication
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
43 database <orthanc-storage>` on the filesystem, it is *entirely normal*
12b204ee328d remark about replication
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
44 that the ``ImportDicomFiles.py`` script ends by saying that only half
12b204ee328d remark about replication
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
45 of the DICOM files were properly sent. This is because the JSON
12b204ee328d remark about replication
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
46 summaries are not DICOM files, and are thus rejected by the target
12b204ee328d remark about replication
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
47 Orthanc server. More information are available `on the discussion
12b204ee328d remark about replication
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
48 group
12b204ee328d remark about replication
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
49 <https://groups.google.com/d/msg/orthanc-users/Zlhtcpo76qQ/tp8EqaRCAQAJ>`__.
12b204ee328d remark about replication
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
50
12b204ee328d remark about replication
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
51
0
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
52 Generic replication
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
53 -------------------
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
54
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
55 If you cannot use the first method, you can use the `Replicate
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
56 <https://bitbucket.org/sjodogne/orthanc/src/default/Resources/Samples/Python/Replicate.py>`_
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
57 script of the Orthanc distribution. This script will use the REST API
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
58 of both the source and target instances of Orthanc. For instance::
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
59
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
60 $ python Replicate.py http://orthanc:password@localhost:8042/ http://192.168.0.2/
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
61
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
62 Obviously, contrarily to the first method, the source instance of
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
63 Orthanc must be up and running during the replication.