changeset 654:e66534972166

dciodvfy
author Sebastien Jodogne <s.jodogne@gmail.com>
date Wed, 28 Apr 2021 15:23:54 +0200
parents a63e0ef60327
children 35dde917804a
files Sphinx/source/faq/dicom.rst Sphinx/source/faq/troubleshooting.rst
diffstat 2 files changed, 43 insertions(+), 10 deletions(-) [+]
line wrap: on
line diff
--- a/Sphinx/source/faq/dicom.rst	Wed Apr 28 15:10:57 2021 +0200
+++ b/Sphinx/source/faq/dicom.rst	Wed Apr 28 15:23:54 2021 +0200
@@ -48,6 +48,8 @@
   the "Query/Retrieve" page).
 * If the two modalities succeed with C-Echo, but query/retrieve does not
   succeed, please carefully read the :ref:`dicom-move` section.
+* Check out the :ref:`more generic troubleshooting guide
+  <troubleshooting>`.
 
 As a last resort, please contact the `mailing list
 <https://groups.google.com/forum/#!forum/orthanc-users>`_ by sending a
--- a/Sphinx/source/faq/troubleshooting.rst	Wed Apr 28 15:10:57 2021 +0200
+++ b/Sphinx/source/faq/troubleshooting.rst	Wed Apr 28 15:23:54 2021 +0200
@@ -15,6 +15,7 @@
 
 Startup
 -------
+
 * If **Orthanc fails to start** with the error "**The TCP port of the DICOM 
   server is privileged or already in use**", this means another software is
   already using the port Orthanc is trying to use.  Usually, this means
@@ -32,6 +33,22 @@
   (it also checks for UDP socket using the same port) and Orthanc 1.3.0 might 
   display error messages that where not displayed by previous versions.
 
+  
+Validating DICOM files
+----------------------
+
+* Invalid DICOM files are often encountered in practice. Such files
+  can cause failures in Orthanc, or can prevent DICOM network
+  transfers. You can validate DICOM files by using the ``dciodvfy``
+  command-line tool (cf. `its documentation
+  <http://dclunie.com/dicom3tools/dciodvfy.html>`__) from the
+  `dicom3tools <https://www.dclunie.com/dicom3tools.html>`__ project
+  by David Clunie.
+
+  The core team of Orthanc will **only provide support for DICOM files
+  that are reported as valid** by ``dciodvfy``.
+
+  
 Orthanc Explorer
 ----------------
 
@@ -108,21 +125,35 @@
   CMake
   <https://hg.orthanc-server.com/orthanc/file/default/LinuxCompilation.txt>`__.
 
-Checking DICOM file integrity
------------------------------
-Orthanc stores, in its database, an `MD5 hash <https://en.wikipedia.org/wiki/MD5>`_ of the DICOM file contents.
+  
+Checking integrity of the storage area
+--------------------------------------
+
+.. highlight:: bash
 
-This MD5 corresponds to the hash of the DICOM file in memory, before it is written to the disk by Orthanc. This information is safely stored inside the database for any incoming DICOM file (provided that the ``StoreMD5ForAttachments`` configuration option is set to ``true``).
-
-It ispossible to ask Orthanc to check by itself whether the DICOM file was corrupted (i.e. to check whether the MD5 hash stored in the database corresponds to the hash of the file on the disk):
+Orthanc stores, in its database, an `MD5 hash
+<https://en.wikipedia.org/wiki/MD5>`_ of the files stored in its
+:ref:`storage area <orthanc-storage>` (that notably contains the DICOM
+files), provided that the ``StoreMD5ForAttachments`` configuration
+option is set to ``true``.
 
-``curl -X POST http://localhost:8042/instances/f257b066-f3992cc4-ca6a5e5f-3f8dcf3a-d4958939/attachments/dicom/verify-md5 -d ''``
+This MD5 corresponds to the hash of the stored files in memory, before
+they are written to the disk by Orthanc. This information is safely
+stored inside the database for any incoming file attachment.
 
-This MD5 may be different if errors occurred while the DICOM file was initially written to the storage, or if the file contents were tampered with afterwards.
+It is possible to ask Orthanc to check by itself whether some attachment
+file was corrupted (i.e. to check whether the MD5 hash stored in the
+database corresponds to the hash of the file on the disk)::
 
-You can retrieve the stored MD5 hash of a DICOM instance as follows:
+  $ curl -X POST http://localhost:8042/instances/f257b066-f3992cc4-ca6a5e5f-3f8dcf3a-d4958939/attachments/dicom/verify-md5 -d ''
 
-``curl http://localhost:8042/instances/f257b066-f3992cc4-ca6a5e5f-3f8dcf3a-d4958939/attachments/dicom/md5``
+This MD5 may be different if errors occurred while the DICOM file was
+initially written to the storage, or if the file contents were
+tampered with afterwards.
+
+You can retrieve the stored MD5 hash of a DICOM instance as follows::
+
+  $ curl http://localhost:8042/instances/f257b066-f3992cc4-ca6a5e5f-3f8dcf3a-d4958939/attachments/dicom/md5
 
 Windows-specific issues
 -----------------------