Mercurial > hg > orthanc-book
annotate Sphinx/source/users/support.rst @ 374:f5bbdabb04d9
merge
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Sun, 05 Apr 2020 10:25:51 +0200 |
| parents | d217af5e6cb3 |
| children | a3288fe6f84e |
| rev | line source |
|---|---|
| 271 | 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 | |
| 277 | 14 1. Make sure to :ref:`check all the content of the Orthanc Book |
| 15 <orthanc-book>`, and notably to :ref:`understand the basics of | |
| 16 DICOM <dicom-guide>`. | |
|
276
3977ccfc318e
read log before asking support
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
271
diff
changeset
|
17 2. Carefully read your :ref:`log files in verbose mode <log>`. |
|
3977ccfc318e
read log before asking support
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
271
diff
changeset
|
18 3. Follow the :ref:`general troubleshooting guide <troubleshooting>`. |
|
3977ccfc318e
read log before asking support
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
271
diff
changeset
|
19 4. If the problem is related to the DICOM network protocol, follow |
| 271 | 20 the :ref:`DICOM troubleshooting guide <dicom>`. |
|
276
3977ccfc318e
read log before asking support
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
271
diff
changeset
|
21 5. Have a look at **all** the :ref:`frequently asked questions (FAQs) |
| 271 | 22 <faq>` that are already available in the Orthanc Book. |
|
276
3977ccfc318e
read log before asking support
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
271
diff
changeset
|
23 6. Make a search for similar problem previously discussed in the |
| 271 | 24 `Orthanc Users discussion forum |
| 25 <https://groups.google.com/forum/#!forum/orthanc-users>`__. | |
|
276
3977ccfc318e
read log before asking support
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
271
diff
changeset
|
26 7. Check out the ``Pending changes in the mainline`` section of the |
| 271 | 27 `NEWS file |
| 360 | 28 <https://hg.orthanc-server.com/orthanc/file/default/NEWS>`__, as |
| 271 | 29 your issue might already be solved in the mainline of Orthanc (i.e. |
| 30 in the cutting-edge version of Orthanc since the last stable | |
| 31 official release). | |
|
276
3977ccfc318e
read log before asking support
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
271
diff
changeset
|
32 8. Carefully read the `TODO file |
| 360 | 33 <https://hg.orthanc-server.com/orthanc/file/default/TODO>`__ that |
| 271 | 34 contains our roadmap, as you might be requesting a feature that is |
| 35 currently pending in our backlog (i.e. not implemented yet). | |
|
276
3977ccfc318e
read log before asking support
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
271
diff
changeset
|
36 9. Have a look for the issue in the `official bug tracker |
| 271 | 37 <https://bitbucket.org/sjodogne/orthanc/issues?status=new&status=open>`__ |
| 38 (click on the ``All`` button, as your issue might already been solved). | |
| 39 | |
| 40 | |
| 41 Importantly, for all the features that are pending in the ``TODO`` | |
| 42 file, if you are a company, please consider `buying professional | |
| 43 services <https://www.orthanc-server.com/orthanc-pro.php>`__ in order | |
| 44 to get the feature implemented faster. | |
| 45 | |
| 46 | |
| 47 .. _support-mwe: | |
| 48 | |
| 49 Discussing a minimal working example | |
| 50 ------------------------------------ | |
| 51 | |
| 52 If none of these resources help, you can consider sending a message to | |
| 53 the `Orthanc Users discussion forum | |
| 54 <https://groups.google.com/forum/#!forum/orthanc-users>`__. In such a | |
| 55 situation, you **must** provide a `minimal working example | |
| 56 <https://en.wikipedia.org/wiki/Minimal_working_example>`__, which means that | |
| 57 you must provide all the following information: | |
| 58 | |
| 59 * Context and full textual description of your issue. When talking | |
| 60 about DICOM networking issues, carefully describe the imaging | |
| 61 modalities into play (including their manufacturers) and your | |
| 62 network topology. | |
| 63 * Full :ref:`configuration files <configuration>`. | |
| 64 * Full logs as produced by Orthanc in :ref:`verbose mode <log>`. | |
| 65 * Sample DICOM files. | |
| 66 * A sequence of command lines that lead to your problem. These command | |
| 321 | 67 lines must only use commands that are available as free and |
| 68 open-source software, that are cross-platform (:ref:`proprietary | |
| 69 software does not help <proprietary>`), and that are preferably | |
| 70 calls the :ref:`REST API of Orthanc <rest>`. The most useful | |
| 71 commands are `cURL <https://en.wikipedia.org/wiki/CURL>`__, `DCMTK | |
| 271 | 72 <https://dicom.offis.de/dcmtk.php.en>`__, `dicom3tools |
| 73 <https://www.dclunie.com/dicom3tools.html>`__, `dcm4che command-line | |
| 74 tools <https://www.dcm4che.org/>`__, or Python scripts. | |
| 75 * If applicable, a screenshot is worth a thousands word. | |
| 76 * If you report a crash, if applicable, a :ref:`core file <crash>`. | |
| 77 | |
| 78 All this information is mandatory, as it allows other members of the | |
| 79 Orthanc community to **reproduce your problem independently of your | |
| 80 setup**. If we can't reproduce your issue, we can't provide any | |
| 81 support! | |
| 82 | |
| 330 | 83 In addition, please note that the original author of Orthanc |
| 84 (Sébastien Jodogne), as a free software advocate, will only personally | |
| 85 deal with issues that are reproducible on recent GNU/Linux | |
| 86 distributions (typically, on Ubuntu 18.04 LTS or through Docker). | |
| 87 | |
| 271 | 88 |
| 89 .. _support-tracker: | |
| 90 | |
| 91 Using the bug tracker | |
| 92 --------------------- | |
| 93 | |
| 94 If you are **sure** that you are reporting a yet unknown bug, you can | |
| 95 consider directly introducing a `bug report on our issue tracker | |
| 96 <https://bitbucket.org/sjodogne/orthanc/issues/new>`__. Beware however | |
| 97 that your issue might be closed if too vague or if not reproducible. | |
| 98 As a consequence, it is advised to first use the discussion forum. |