# HG changeset patch
# User Sebastien Jodogne <s.jodogne@gmail.com>
# Date 1468482439 -7200
# Node ID f99aa6a6f0c98caa7f7ab055cdd756397f5d840f
# Parent  6d02b30fd8a94227ec01789b63cf024b818cf4c6
Generating an Exploitable Log

diff -r 6d02b30fd8a9 -r f99aa6a6f0c9 Sphinx/source/faq.rst
--- a/Sphinx/source/faq.rst	Wed Jul 13 17:35:11 2016 +0200
+++ b/Sphinx/source/faq.rst	Thu Jul 14 09:47:19 2016 +0200
@@ -36,6 +36,7 @@
 .. toctree::
    :maxdepth: 1
 
+   faq/log.rst
    faq/orthanc-ids.rst
    faq/versioning.rst
    faq/debian-daemon.rst
diff -r 6d02b30fd8a9 -r f99aa6a6f0c9 Sphinx/source/faq/dicom.rst
--- a/Sphinx/source/faq/dicom.rst	Wed Jul 13 17:35:11 2016 +0200
+++ b/Sphinx/source/faq/dicom.rst	Thu Jul 14 09:47:19 2016 +0200
@@ -35,7 +35,8 @@
 
 * Restart Orthanc with the ``--verbose`` option at command line, and
   carefully inspect the log. This might provide immediate debugging
-  information.
+  information. Make sure to read :ref:`how to generate an exploitable
+  log <log>`.
 * Issue a :ref:`DICOM C-Echo <dicom-echo>` from each modality to make
   sure the DICOM protocol is properly configured (sending a C-Echo
   from Orthanc Explorer is possible starting with Orthanc 0.9.3, in
@@ -55,6 +56,7 @@
 * Specify the operating system, the vendor, the DICOM software, and
   the version of each modality.
 * Attach sample DICOM files, possibly anonymized.
-* Attach the log of the two modalities. The log must be generated with
-  the ``--trace`` command-line option as far as Orthanc is concerned.
+* Attach the log of the two modalities. The :ref:`log must be
+  generated <log>` with the ``--trace`` command-line option as far as
+  Orthanc is concerned.
 * Attach any screenshot that is useful to understand the problem.
diff -r 6d02b30fd8a9 -r f99aa6a6f0c9 Sphinx/source/faq/log.rst
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Sphinx/source/faq/log.rst	Thu Jul 14 09:47:19 2016 +0200
@@ -0,0 +1,63 @@
+.. _log:
+
+Generating an Exploitable Log
+-----------------------------
+
+For your log to be exploitable by the Orthanc community, you must
+generate them with the ``--verbose`` or ``--trace``. If you are using
+Orthanc at the command-line, simply add these flags and redirect the
+standard outputs to some log file. 
+
+However, if you use packaged versions of Orthanc that runs the server
+in background, you will have to manually start Orthanc. The sections
+below explain how to achieve this goal with the officially supported
+packages.
+
+
+Under Windows
+^^^^^^^^^^^^^
+
+Under Windows, if you used the official installer:
+
+1. Download the `precompiled command-line version
+   <http://www.orthanc-server.com/download-windows.php>`__ of Orthanc.
+
+2. Stop the Orthanc service. The actual process depends on your
+   version of Windows.
+
+3. Copy the just-downloaded ``Orthanc-1.1.0-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``).
+
+4. Type in a command-line shell, to generate the ``Orthanc.log`` file::
+
+   $ cd C:\Temp
+   $ Orthanc-1.1.0-Release.exe --verbose Configuration.json > Orthanc.log 2<&1
+
+5. Restart the Orthanc service.
+
+
+Under Debian GNU/Linux
+^^^^^^^^^^^^^^^^^^^^^^
+
+1. Stop the Orthanc service::
+
+   $ sudo /etc/init.d/orthanc stop
+
+2. Manually start Orthanc (using the same configuration as the
+   service) and generate the log::
+
+   $ sudo -u orthanc /usr/sbin/Orthanc --verbose /etc/orthanc/ > Orthanc.log 2>&1
+
+3. Restart the Orthanc service::
+
+   $ sudo /etc/init.d/orthanc start
+
+
+Under Docker
+^^^^^^^^^^^^
+
+The command-line to be used is::
+
+  $ sudo docker run -a stderr -p 4242:4242 -p 8042:8042 --rm jodogne/orthanc --verbose /etc/orthanc > Orthanc.log 2>&1