Mercurial > hg > orthanc-book

comparison Sphinx/source/users/support.rst @ 271:1173e40cbf35

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
support
author Sebastien Jodogne <s.jodogne@gmail.com>
date Wed, 28 Aug 2019 18:18:11 +0200
parents
children 3977ccfc318e
comparison
equal deleted inserted replaced
270:f29d75bc5c25 271:1173e40cbf35
1 .. _support:
2
3 Asking for support
4 ==================
5
6 .. _support-resources:
7
8 Analyzing your problem
9 ----------------------
10
11 When you face a problem, you should first check out the following
12 resources:
13
14 1. Make sure to :ref:`understand the basics of DICOM <dicom-guide>`.
15 2. Follow the :ref:`general troubleshooting guide <troubleshooting>`.
16 3. If the problem is related to the DICOM network protocol, follow
17 the :ref:`DICOM troubleshooting guide <dicom>`.
18 4. Have a look at **all** the :ref:`frequently asked questions (FAQs)
19 <faq>` that are already available in the Orthanc Book.
20 5. Make a search for similar problem previously discussed in the
21 `Orthanc Users discussion forum
22 <https://groups.google.com/forum/#!forum/orthanc-users>`__.
23 6. Check out the ``Pending changes in the mainline`` section of the
24 `NEWS file
25 <https://bitbucket.org/sjodogne/orthanc/src/default/NEWS>`__, as
26 your issue might already be solved in the mainline of Orthanc (i.e.
27 in the cutting-edge version of Orthanc since the last stable
28 official release).
29 7. Carefully read the `TODO file
30 <https://bitbucket.org/sjodogne/orthanc/src/default/TODO>`__ that
31 contains our roadmap, as you might be requesting a feature that is
32 currently pending in our backlog (i.e. not implemented yet).
33 8. Have a look for the issue in the `official bug tracker
34 <https://bitbucket.org/sjodogne/orthanc/issues?status=new&status=open>`__
35 (click on the ``All`` button, as your issue might already been solved).
36
37
38 Importantly, for all the features that are pending in the ``TODO``
39 file, if you are a company, please consider `buying professional
40 services <https://www.orthanc-server.com/orthanc-pro.php>`__ in order
41 to get the feature implemented faster.
42
43
44 .. _support-mwe:
45
46 Discussing a minimal working example
47 ------------------------------------
48
49 If none of these resources help, you can consider sending a message to
50 the `Orthanc Users discussion forum
51 <https://groups.google.com/forum/#!forum/orthanc-users>`__. In such a
52 situation, you **must** provide a `minimal working example
53 <https://en.wikipedia.org/wiki/Minimal_working_example>`__, which means that
54 you must provide all the following information:
55
56 * Context and full textual description of your issue. When talking
57 about DICOM networking issues, carefully describe the imaging
58 modalities into play (including their manufacturers) and your
59 network topology.
60 * Full :ref:`configuration files <configuration>`.
61 * Full logs as produced by Orthanc in :ref:`verbose mode <log>`.
62 * Sample DICOM files.
63 * A sequence of command lines that lead to your problem. These command
64 lines must only call commands that are available as free and
65 open-source software and that are cross-platform (:ref:`proprietary
66 software does not help <proprietary>`). The most useful commands are
67 `cURL <https://en.wikipedia.org/wiki/CURL>`__, `DCMTK
68 <https://dicom.offis.de/dcmtk.php.en>`__, `dicom3tools
69 <https://www.dclunie.com/dicom3tools.html>`__, `dcm4che command-line
70 tools <https://www.dcm4che.org/>`__, or Python scripts.
71 * If applicable, a screenshot is worth a thousands word.
72 * If you report a crash, if applicable, a :ref:`core file <crash>`.
73
74 All this information is mandatory, as it allows other members of the
75 Orthanc community to **reproduce your problem independently of your
76 setup**. If we can't reproduce your issue, we can't provide any
77 support!
78
79
80 .. _support-tracker:
81
82 Using the bug tracker
83 ---------------------
84
85 If you are **sure** that you are reporting a yet unknown bug, you can
86 consider directly introducing a `bug report on our issue tracker
87 <https://bitbucket.org/sjodogne/orthanc/issues/new>`__. Beware however
88 that your issue might be closed if too vague or if not reproducible.
89 As a consequence, it is advised to first use the discussion forum.