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