Mercurial > hg > orthanc-book
changeset 554:4f3a6145ae34
Orthanc 1.8.1
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Mon, 07 Dec 2020 17:48:33 +0100 |
parents | 608094adf405 |
children | 6fb469a3c382 |
files | Sphinx/source/developers/creating-plugins.rst Sphinx/source/developers/db-versioning.rst Sphinx/source/dicom-guide.rst Sphinx/source/faq/crash.rst Sphinx/source/faq/debugging.rst Sphinx/source/faq/dicom.rst Sphinx/source/faq/log.rst Sphinx/source/faq/orthanc-storage.rst Sphinx/source/faq/scalability.rst Sphinx/source/faq/security.rst Sphinx/source/plugins/python.rst Sphinx/source/users/advanced-rest.rst Sphinx/source/users/configuration.rst Sphinx/source/users/debian-packages.rst Sphinx/source/users/docker.rst Sphinx/source/users/man-orthanc.txt |
diffstat | 16 files changed, 99 insertions(+), 49 deletions(-) [+] |
line wrap: on
line diff
--- a/Sphinx/source/developers/creating-plugins.rst Mon Dec 07 10:22:43 2020 +0100 +++ b/Sphinx/source/developers/creating-plugins.rst Mon Dec 07 17:48:33 2020 +0100 @@ -83,7 +83,7 @@ that is part of the Orthanc source distribution: * `Plugins/Include/orthanc/OrthancCPlugin.h - <https://hg.orthanc-server.com/orthanc/file/Orthanc-1.8.0/OrthancServer/Plugins/Include/orthanc/OrthancCPlugin.h>`__ + <https://hg.orthanc-server.com/orthanc/file/Orthanc-1.8.1/OrthancServer/Plugins/Include/orthanc/OrthancCPlugin.h>`__ `Online documentation <https://sdk.orthanc-server.com/>`__ for this C header is available, as generated by `Doxygen @@ -97,8 +97,8 @@ ``HAS_ORTHANC_EXCEPTION`` is set to ``0``: * `Plugins/Samples/Common/OrthanPluginCppWrapper.h - <https://hg.orthanc-server.com/orthanc/file/Orthanc-1.8.0/OrthancServer/Plugins/Samples/Common/OrthancPluginCppWrapper.h>`__ + <https://hg.orthanc-server.com/orthanc/file/Orthanc-1.8.1/OrthancServer/Plugins/Samples/Common/OrthancPluginCppWrapper.h>`__ * `Plugins/Samples/Common/OrthanPluginCppWrapper.cpp - <https://hg.orthanc-server.com/orthanc/file/Orthanc-1.8.0/OrthancServer/Plugins/Samples/Common/OrthancPluginCppWrapper.cpp>`__ + <https://hg.orthanc-server.com/orthanc/file/Orthanc-1.8.1/OrthancServer/Plugins/Samples/Common/OrthancPluginCppWrapper.cpp>`__ * `Plugins/Samples/Common/OrthanPluginException.h - <https://hg.orthanc-server.com/orthanc/file/Orthanc-1.8.0/OrthancServer/Plugins/Samples/Common/OrthancPluginException.h>`__ + <https://hg.orthanc-server.com/orthanc/file/Orthanc-1.8.1/OrthancServer/Plugins/Samples/Common/OrthancPluginException.h>`__
--- a/Sphinx/source/developers/db-versioning.rst Mon Dec 07 10:22:43 2020 +0100 +++ b/Sphinx/source/developers/db-versioning.rst Mon Dec 07 17:48:33 2020 +0100 @@ -26,7 +26,7 @@ Version DB v2 DB v3 DB v4 DB v5 DB v6 =============================== ===== ===== ===== ===== ===== Mainline u u u x -Orthanc 0.9.5 - Orthanc 1.8.0 u u u x +Orthanc 0.9.5 - Orthanc 1.8.1 u u u x Orthanc 0.8.5 - Orthanc 0.9.4 u u x Orthanc 0.7.3 - Orthanc 0.8.4 u x Orthanc 0.4.0 - Orthanc 0.7.2 x
--- a/Sphinx/source/dicom-guide.rst Mon Dec 07 10:22:43 2020 +0100 +++ b/Sphinx/source/dicom-guide.rst Mon Dec 07 17:48:33 2020 +0100 @@ -657,7 +657,7 @@ $ getscu -v localhost 4242 -aec ORTHANC -k "0008,0052=STUDY" -k "0020,000d=1.2.840.113543.6.6.4.7.64067529866380271256212683512383713111129" -*Note:* As of Orthanc 1.8.0, Orthanc implements C-Get as a service +*Note:* As of Orthanc 1.8.1, Orthanc implements C-Get as a service class provider (SCP). Using C-Get as a service class user (SCU) is not currently supported in Orthanc.
--- a/Sphinx/source/faq/crash.rst Mon Dec 07 10:22:43 2020 +0100 +++ b/Sphinx/source/faq/crash.rst Mon Dec 07 17:48:33 2020 +0100 @@ -64,13 +64,13 @@ above <segfault-plugin>` is available as the ``crash.cpp`` file, here is a sample debug session:: - $ wget https://lsb.orthanc-server.com/orthanc/debug/1.8.0/Orthanc + $ wget https://lsb.orthanc-server.com/orthanc/debug/1.8.1/Orthanc $ chmod +x ./Orthanc $ gcc -fPIC -shared ./crash.cpp -I ~/orthanc/Plugins/Include -o crash.so $ ulimit -c unlimited $ echo '{ "Plugins" : ["crash.so"] }' > Configuration.json $ rm -f core ; ./Orthanc Configuration.json - W0427 15:43:24.215783 main.cpp:1436] Orthanc version: 1.8.0 + W0427 15:43:24.215783 main.cpp:1436] Orthanc version: 1.8.1 W0427 15:43:24.215910 main.cpp:1279] Performance warning: Non-release build, runtime debug assertions are turned on W0427 15:43:24.217585 OrthancConfiguration.cpp:61] Reading the configuration from: "Configuration.json" W0427 15:43:24.254733 main.cpp:700] Loading plugin(s) from: crash.so
--- a/Sphinx/source/faq/debugging.rst Mon Dec 07 10:22:43 2020 +0100 +++ b/Sphinx/source/faq/debugging.rst Mon Dec 07 17:48:33 2020 +0100 @@ -45,13 +45,13 @@ to debug Orthanc without compiling from sources. Here is a sample debug session:: - $ wget https://lsb.orthanc-server.com/orthanc/debug/1.8.0/Orthanc + $ wget https://lsb.orthanc-server.com/orthanc/debug/1.8.1/Orthanc $ chmod +x ./Orthanc $ gdb ./Orthanc Configuration.json (gdb) catch throw Catchpoint 1 (throw) (gdb) run - W0513 15:24:42.374349 main.cpp:1436] Orthanc version: 1.8.0 + W0513 15:24:42.374349 main.cpp:1436] Orthanc version: 1.8.1 ---> Reproduce your error case <--- Thread 15 "Orthanc" hit Catchpoint 1 (exception thrown), 0x00007ffff6de68bd in __cxa_throw () from /usr/lib/x86_64-linux-gnu/libstdc++.so.6 (gdb) backtrace
--- a/Sphinx/source/faq/dicom.rst Mon Dec 07 10:22:43 2020 +0100 +++ b/Sphinx/source/faq/dicom.rst Mon Dec 07 17:48:33 2020 +0100 @@ -13,7 +13,7 @@ * Turn off all the firewalls on the two computers (especially on Microsoft Windows). * Make sure the remote computer has `DICOM TLS encryption <https://www.dicomstandard.org/using/security/>`__ turned off (this - feature is not supported yet as of Orthanc 1.8.0). + feature is not supported yet as of Orthanc 1.8.1). * Write down on a paper the following information about each modality: * its IP address (avoid using symbolic names if possible to troubleshot any DNS problem),
--- a/Sphinx/source/faq/log.rst Mon Dec 07 10:22:43 2020 +0100 +++ b/Sphinx/source/faq/log.rst Mon Dec 07 17:48:33 2020 +0100 @@ -58,7 +58,7 @@ 2. Stop the Orthanc service. The actual process depends on your version of Windows. -3. Copy the just-downloaded ``Orthanc-1.8.0-Release.exe`` together +3. Copy the just-downloaded ``Orthanc-1.8.1-Release.exe`` together with your configuration file (that is by default located in ``C:\Orthanc\Configuration.json``) into the same folder (e.g. ``C:\Temp``). @@ -67,7 +67,7 @@ ``Orthanc.log`` file:: $ cd C:\Temp - $ Orthanc-1.8.0-Release.exe --verbose Configuration.json > Orthanc.log 2<&1 + $ Orthanc-1.8.1-Release.exe --verbose Configuration.json > Orthanc.log 2<&1 5. Once the log has been generated (by default, it is available as ``C:\Temp\Orthanc.log``), stop Orthanc and possibly restart the
--- a/Sphinx/source/faq/orthanc-storage.rst Mon Dec 07 10:22:43 2020 +0100 +++ b/Sphinx/source/faq/orthanc-storage.rst Mon Dec 07 17:48:33 2020 +0100 @@ -59,9 +59,9 @@ database schema is kept as simple as possible, and can be found in the following two files of the source code of Orthanc: `PrepareDatabase.sql -<https://hg.orthanc-server.com/orthanc/file/Orthanc-1.8.0/OrthancServer/Sources/Database/PrepareDatabase.sql>`__ +<https://hg.orthanc-server.com/orthanc/file/Orthanc-1.8.1/OrthancServer/Sources/Database/PrepareDatabase.sql>`__ and `InstallTrackAttachmentsSize.sql -<https://hg.orthanc-server.com/orthanc/file/Orthanc-1.8.0/OrthancServer/Sources/Database/InstallTrackAttachmentsSize.sql>`__. +<https://hg.orthanc-server.com/orthanc/file/Orthanc-1.8.1/OrthancServer/Sources/Database/InstallTrackAttachmentsSize.sql>`__. Direct access
--- a/Sphinx/source/faq/scalability.rst Mon Dec 07 10:22:43 2020 +0100 +++ b/Sphinx/source/faq/scalability.rst Mon Dec 07 17:48:33 2020 +0100 @@ -54,7 +54,7 @@ Here is a generic setup that should provide best performance in the presence of large databases: -* Make sure to use the latest release of Orthanc (1.8.0 at the time of +* Make sure to use the latest release of Orthanc (1.8.1 at the time of writing). * We suggest to use the latest release of the :ref:`PostgreSQL plugin @@ -178,7 +178,7 @@ Exclusive access to the DB ^^^^^^^^^^^^^^^^^^^^^^^^^^ -As of Orthanc 1.8.0, the internal code accessing the DB is still affected +As of Orthanc 1.8.1, the internal code accessing the DB is still affected by limitations induced by the SQLite engine that was the only one originally available at the beginning of the project: inside a single Orthanc process, there is no concurrent access to the DB. @@ -190,7 +190,7 @@ Also note that the core of Orthanc does not currently support the replay of database transactions, which is necessary to deal with conflicts between several instances of Orthanc that would simultaneously write -to the database. As a consequence, as of Orthanc 1.8.0, when connecting multiple +to the database. As a consequence, as of Orthanc 1.8.1, when connecting multiple Orthanc to a single database by setting ``Lock`` to ``false``, there should only be one instance of Orthanc acting as a writer and all the other instances of Orthanc acting as readers only. Be careful to set @@ -209,7 +209,7 @@ Latency ^^^^^^^ -As of Orthanc 1.8.0, Orthanc still performs quite a large number of small +As of Orthanc 1.8.1, Orthanc still performs quite a large number of small SQL requests. A simple request to a route like ``/studies/{id}`` can trigger 6 SQL queries.
--- a/Sphinx/source/faq/security.rst Mon Dec 07 10:22:43 2020 +0100 +++ b/Sphinx/source/faq/security.rst Mon Dec 07 17:48:33 2020 +0100 @@ -197,7 +197,7 @@ configuration of remote modalities. -**Remark:** As of Orthanc 1.8.0, `DICOM TLS encryption +**Remark:** As of Orthanc 1.8.1, `DICOM TLS encryption <https://www.dicomstandard.org/using/security/>`__ is not supported yet. As a temporary workaround, `it has been reported <https://www.digihunch.com/2020/11/medical-imaging-web-server-deployment-pipeline/>`__
--- a/Sphinx/source/plugins/python.rst Mon Dec 07 10:22:43 2020 +0100 +++ b/Sphinx/source/plugins/python.rst Mon Dec 07 17:48:33 2020 +0100 @@ -18,7 +18,7 @@ Python plugins have access to more features and a more consistent SDK than :ref:`Lua scripts <lua>`. The Python API is automatically generated from the `Orthanc plugin SDK in C -<https://hg.orthanc-server.com/orthanc/file/Orthanc-1.8.0/OrthancServer/Plugins/Include/orthanc/OrthancCPlugin.h>`__ +<https://hg.orthanc-server.com/orthanc/file/Orthanc-1.8.1/OrthancServer/Plugins/Include/orthanc/OrthancCPlugin.h>`__ using the `Clang <https://en.wikipedia.org/wiki/Clang>`__ compiler front-end.
--- a/Sphinx/source/users/advanced-rest.rst Mon Dec 07 10:22:43 2020 +0100 +++ b/Sphinx/source/users/advanced-rest.rst Mon Dec 07 17:48:33 2020 +0100 @@ -128,7 +128,7 @@ ``ErrorCode`` and ``ErrorDescription`` fields for more information. * ``Paused``: The job has been paused. * ``Retry``: The job has failed internally, and has been scheduled for - re-submission after a delay. As of Orthanc 1.8.0, this feature is not + re-submission after a delay. As of Orthanc 1.8.1, this feature is not used by any type of job. In order to wait for the end of an asynchronous call, the caller will @@ -193,7 +193,7 @@ Note how we retrieve the content of the archive by accessing the ``archive`` output of the job (check out the virtual method ``IJob::GetOutput()`` from the `source code -<https://hg.orthanc-server.com/orthanc/file/Orthanc-1.8.0/OrthancServer/Sources/ServerJobs/ArchiveJob.cpp>`__ +<https://hg.orthanc-server.com/orthanc/file/Orthanc-1.8.1/OrthancServer/Sources/ServerJobs/ArchiveJob.cpp>`__ of Orthanc). Here is the corresponding sequence of commands to generate a DICOMDIR @@ -202,7 +202,7 @@ $ curl http://localhost:8042/studies/27f7126f-4f66fb14-03f4081b-f9341db2-53925988/media -d '{"Asynchronous":true}' $ curl http://localhost:8042/jobs/6332be8a-0052-44fb-8cc2-ac959aeccad9/archive > a.zip -As of Orthanc 1.8.0, only the creation of a ZIP or a DICOMDIR archive +As of Orthanc 1.8.1, only the creation of a ZIP or a DICOMDIR archive produces such "outputs".
--- a/Sphinx/source/users/configuration.rst Mon Dec 07 10:22:43 2020 +0100 +++ b/Sphinx/source/users/configuration.rst Mon Dec 07 17:48:33 2020 +0100 @@ -7,7 +7,7 @@ Configuring Orthanc simply consists in providing a configuration file. Orthanc has numerous configuration that are documented in the `default configuration file -<https://hg.orthanc-server.com/orthanc/file/Orthanc-1.8.0/OrthancServer/Resources/Configuration.json>`_. This +<https://hg.orthanc-server.com/orthanc/file/Orthanc-1.8.1/OrthancServer/Resources/Configuration.json>`_. This file is in the `JSON <https://en.wikipedia.org/wiki/JSON>`_ file format. You can generate this file file with the following call::
--- a/Sphinx/source/users/debian-packages.rst Mon Dec 07 10:22:43 2020 +0100 +++ b/Sphinx/source/users/debian-packages.rst Mon Dec 07 17:48:33 2020 +0100 @@ -96,10 +96,10 @@ This can be done with this sequence of commands:: $ sudo service orthanc stop - $ sudo wget https://lsb.orthanc-server.com/orthanc/1.8.0/Orthanc --output-document /usr/sbin/Orthanc + $ sudo wget https://lsb.orthanc-server.com/orthanc/1.8.1/Orthanc --output-document /usr/sbin/Orthanc $ sudo rm -f /usr/share/orthanc/plugins/*.so - $ sudo wget https://lsb.orthanc-server.com/orthanc/1.8.0/libServeFolders.so --output-document /usr/share/orthanc/plugins/libServeFolders.so - $ sudo wget https://lsb.orthanc-server.com/orthanc/1.8.0/libModalityWorklists.so --output-document /usr/share/orthanc/plugins/libModalityWorklists.so + $ sudo wget https://lsb.orthanc-server.com/orthanc/1.8.1/libServeFolders.so --output-document /usr/share/orthanc/plugins/libServeFolders.so + $ sudo wget https://lsb.orthanc-server.com/orthanc/1.8.1/libModalityWorklists.so --output-document /usr/share/orthanc/plugins/libModalityWorklists.so $ $ sudo wget https://lsb.orthanc-server.com/plugin-dicom-web/1.3/libOrthancDicomWeb.so --output-document /usr/share/orthanc/plugins/libOrthancDicomWeb.so $ ...
--- a/Sphinx/source/users/docker.rst Mon Dec 07 10:22:43 2020 +0100 +++ b/Sphinx/source/users/docker.rst Mon Dec 07 17:48:33 2020 +0100 @@ -73,7 +73,7 @@ If more stability is required, you can select the official release of Orthanc to be run:: - $ docker run -p 4242:4242 -p 8042:8042 --rm jodogne/orthanc:1.8.0 + $ docker run -p 4242:4242 -p 8042:8042 --rm jodogne/orthanc:1.8.1 Passing additional command-line options (e.g. to make Orthanc verbose) can be done as follows (note the ``/etc/orthanc`` option that is @@ -95,7 +95,7 @@ Or you can also start a specific version of Orthanc for more stability:: - $ docker run -p 4242:4242 -p 8042:8042 --rm jodogne/orthanc-plugins:1.8.0 + $ docker run -p 4242:4242 -p 8042:8042 --rm jodogne/orthanc-plugins:1.8.1 If you have an interest in the :ref:`Python plugin <python-plugin>`, you can use the ``orthanc-python`` image. The latter image is a @@ -103,7 +103,7 @@ Python 3.7 interpreter. Here is how to start this image:: $ docker run -p 4242:4242 -p 8042:8042 --rm jodogne/orthanc-python - $ docker run -p 4242:4242 -p 8042:8042 --rm jodogne/orthanc-python:1.8.0 + $ docker run -p 4242:4242 -p 8042:8042 --rm jodogne/orthanc-python:1.8.1 Fine-tuning the configuration @@ -155,7 +155,7 @@ version: '3.1' # Secrets are only available since this version of Docker Compose services: orthanc: - image: jodogne/orthanc-plugins:1.8.0 + image: jodogne/orthanc-plugins:1.8.1 command: /run/secrets/ # Path to the configuration files (stored as secrets) ports: - 4242:4242 @@ -194,7 +194,7 @@ container to some path in the filesystem of your Linux host, e.g.:: $ mkdir /tmp/orthanc-db - $ docker run -p 4242:4242 -p 8042:8042 --rm -v /tmp/orthanc-db/:/var/lib/orthanc/db/ jodogne/orthanc:1.8.0 + $ docker run -p 4242:4242 -p 8042:8042 --rm -v /tmp/orthanc-db/:/var/lib/orthanc/db/ jodogne/orthanc:1.8.1 Whole-slide imaging support @@ -315,4 +315,4 @@ * The build artifacts can be found in folder ``/root/orthanc/Build``. * This command launches the mainline version. To start a released version, - use e.g. ``jodogne/orthanc-debug:1.8.0``. + use e.g. ``jodogne/orthanc-debug:1.8.1``.
--- a/Sphinx/source/users/man-orthanc.txt Mon Dec 07 10:22:43 2020 +0100 +++ b/Sphinx/source/users/man-orthanc.txt Mon Dec 07 17:48:33 2020 +0100 @@ -14,22 +14,31 @@ The "CONFIGURATION" argument can be a single file or a directory. In the case of a directory, all the JSON files it contains will be merged. If no configuration path is given on the command line, a set of default - parameters is used. Please refer to the Orthanc homepage for the full - instructions about how to use Orthanc <http://www.orthanc-server.com/>. + parameters is used. Please refer to the Orthanc Book for the full + instructions about how to use Orthanc + <http://book.orthanc-server.com/>. + + Pay attention to the fact that the order of the options is important. + Options are read left to right. In particular, options such as "--ver‐ + bose" can reset the value of other log-related options that were read + before. + + The recommended set of options to debug DICOM communications is "--ver‐ + bose --trace-dicom --logfile=dicom.log" Command-line options: --help display this help and exit --logdir=[dir] - directory where to store the log files (by default, the log is + directory where to store the log files (by default, the log is dumped to stderr) --logfile=[file] - file where to store the log of Orthanc (by default, the log is + file where to store the log of Orthanc (by default, the log is dumped to stderr) --config=[file] - create a sample configuration file and exit (if file is "-", + create a sample configuration file and exit (if "file" is "-", dumps to stdout) --errors @@ -42,32 +51,73 @@ highest verbosity in logs (for debug) --upgrade - allow Orthanc to upgrade the version of the database (beware - that the database will become incompatible with former versions + allow Orthanc to upgrade the version of the database (beware + that the database will become incompatible with former versions of Orthanc) --no-jobs - Don't restart the jobs that were stored during the last execu‐ + Don't restart the jobs that were stored during the last execu‐ tion of Orthanc --version output version information and exit + Fine-tuning of log categories: + --verbose-generic + be verbose in logs of category "generic" + + --trace-generic + use highest verbosity for logs of category "generic" + + --verbose-plugins + be verbose in logs of category "plugins" + + --trace-plugins + use highest verbosity for logs of category "plugins" + + --verbose-http + be verbose in logs of category "http" + + --trace-http + use highest verbosity for logs of category "http" + + --verbose-sqlite + be verbose in logs of category "sqlite" + + --trace-sqlite + use highest verbosity for logs of category "sqlite" + + --verbose-dicom + be verbose in logs of category "dicom" + + --trace-dicom use highest verbosity for logs of category "dicom" + + --verbose-jobs + be verbose in logs of category "jobs" + + --trace-jobs + use highest verbosity for logs of category "jobs" + + --verbose-lua be verbose in logs of category "lua" + + --trace-lua + use highest verbosity for logs of category "lua" + Exit status: - 0 if success, + 0 if success, - -1 if error (have a look at the logs). + -1 if error (have a look at the logs). AUTHOR Written by Sebastien Jodogne <s.jodogne@orthanc-labs.com> COPYRIGHT - Copyright © 2012-2016 Sebastien Jodogne, Medical Physics Department, + Copyright © 2012-2016 Sebastien Jodogne, Medical Physics Department, University Hospital of Liege (Belgium) - Copyright © 2017-2020 Osimis S.A. (Belgium) Licensing GPLv3+: GNU GPL - version 3 or later <http://gnu.org/licenses/gpl.html>, with OpenSSL + Copyright © 2017-2020 Osimis S.A. (Belgium) Licensing GPLv3+: GNU GPL + version 3 or later <http://gnu.org/licenses/gpl.html>, with OpenSSL exception. - This is free software: you are free to change and redistribute it. + This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law. -Orthanc 1.8.0 November 2020 ORTHANC(1) +Orthanc 1.8.1 December 2020 ORTHANC(1)