Mercurial > hg > orthanc-book
annotate Sphinx/source/users/support.rst @ 990:27b75c653a8b
metrics
| author | Alain Mazy <am@osimis.io> |
|---|---|
| date | Tue, 21 Nov 2023 10:36:44 +0100 |
| parents | 6650b0ab177a |
| children | 1316bc62b5d5 |
| rev | line source |
|---|---|
| 271 | 1 .. _support: |
| 2 | |
| 3 Asking for support | |
| 4 ================== | |
| 5 | |
| 985 | 6 .. contents:: |
| 7 :depth: 3 | |
| 8 | |
| 9 | |
| 271 | 10 .. _support-resources: |
| 11 | |
| 12 Analyzing your problem | |
| 13 ---------------------- | |
| 14 | |
| 15 When you face a problem, you should first check out the following | |
| 16 resources: | |
| 17 | |
| 454 | 18 1. Make sure that you use the `latest version of Orthanc |
| 19 <http://www.orthanc-server.com/download.php>`__. | |
| 20 2. Make sure to :ref:`check all the content of the Orthanc Book | |
| 277 | 21 <orthanc-book>`, and notably to :ref:`understand the basics of |
| 22 DICOM <dicom-guide>`. | |
| 454 | 23 3. Carefully read your :ref:`log files in verbose mode <log>`. |
| 24 4. In the case of DICOM networking problems, carefully read the log | |
|
388
a3288fe6f84e
proprietary-support
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
360
diff
changeset
|
25 files from your remote modality. If you are :ref:`using Orthanc |
|
a3288fe6f84e
proprietary-support
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
360
diff
changeset
|
26 against a proprietary system <proprietary>`, contact the support |
|
a3288fe6f84e
proprietary-support
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
360
diff
changeset
|
27 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
|
28 setup issues. |
| 454 | 29 5. Follow the :ref:`general troubleshooting guide <troubleshooting>`. |
| 30 6. If the problem is related to the DICOM network protocol, follow | |
| 271 | 31 the :ref:`DICOM troubleshooting guide <dicom>`. |
| 454 | 32 7. Have a look at **all** the :ref:`frequently asked questions (FAQs) |
| 271 | 33 <faq>` that are already available in the Orthanc Book. |
| 454 | 34 8. Make a search for similar problem previously discussed in the |
| 271 | 35 `Orthanc Users discussion forum |
|
984
46e2941b57dd
replace link to google users group by link to discourse
Alain Mazy <am@osimis.io>
parents:
980
diff
changeset
|
36 <https://discourse.orthanc-server.org>`__. |
| 454 | 37 9. Check out the ``Pending changes in the mainline`` section of the |
| 271 | 38 `NEWS file |
| 360 | 39 <https://hg.orthanc-server.com/orthanc/file/default/NEWS>`__, as |
| 271 | 40 your issue might already be solved in the mainline of Orthanc (i.e. |
| 41 in the cutting-edge version of Orthanc since the last stable | |
| 42 official release). | |
| 454 | 43 10. Carefully read the `TODO file |
| 44 <https://hg.orthanc-server.com/orthanc/file/default/TODO>`__ that | |
| 45 contains our roadmap, as you might be requesting a feature that is | |
| 46 currently pending in our backlog (i.e. not implemented yet). | |
| 47 11. Look for similar issue in the `official bug tracker | |
|
445
987fbbc2b59e
leaving bitbucket wrt. bug tracker
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
389
diff
changeset
|
48 <https://bugs.orthanc-server.com/query.cgi>`__ (make sure to |
|
987fbbc2b59e
leaving bitbucket wrt. bug tracker
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
389
diff
changeset
|
49 select ``All`` in the ``Status`` field, as your issue might |
|
987fbbc2b59e
leaving bitbucket wrt. bug tracker
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
389
diff
changeset
|
50 already have been solved). |
| 271 | 51 |
| 52 | |
| 53 Importantly, for all the features that are pending in the ``TODO`` | |
| 54 file, if you are a company, please consider `buying professional | |
| 784 | 55 services <https://osimis.io/en/orthanc-support-contract>`__ in order to get |
| 454 | 56 the feature implemented faster. |
| 271 | 57 |
| 58 | |
| 59 .. _support-mwe: | |
| 60 | |
| 61 Discussing a minimal working example | |
| 62 ------------------------------------ | |
| 63 | |
| 64 If none of these resources help, you can consider sending a message to | |
| 65 the `Orthanc Users discussion forum | |
|
984
46e2941b57dd
replace link to google users group by link to discourse
Alain Mazy <am@osimis.io>
parents:
980
diff
changeset
|
66 <https://discourse.orthanc-server.org>`__. |
|
46e2941b57dd
replace link to google users group by link to discourse
Alain Mazy <am@osimis.io>
parents:
980
diff
changeset
|
67 In such a situation, you **must** provide a `minimal working example |
| 271 | 68 <https://en.wikipedia.org/wiki/Minimal_working_example>`__, which means that |
| 69 you must provide all the following information: | |
| 70 | |
| 71 * Context and full textual description of your issue. When talking | |
| 72 about DICOM networking issues, carefully describe the imaging | |
| 73 modalities into play (including their manufacturers) and your | |
| 74 network topology. | |
| 446 | 75 * The observed vs. expected results. |
| 271 | 76 * Full :ref:`configuration files <configuration>`. |
| 77 * Full logs as produced by Orthanc in :ref:`verbose mode <log>`. | |
| 78 * Sample DICOM files. | |
| 79 * A sequence of command lines that lead to your problem. These command | |
| 321 | 80 lines must only use commands that are available as free and |
| 81 open-source software, that are cross-platform (:ref:`proprietary | |
| 82 software does not help <proprietary>`), and that are preferably | |
| 83 calls the :ref:`REST API of Orthanc <rest>`. The most useful | |
| 84 commands are `cURL <https://en.wikipedia.org/wiki/CURL>`__, `DCMTK | |
|
655
35dde917804a
added command-line tools to ask support
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
637
diff
changeset
|
85 <https://dicom.offis.de/dcmtk.php.en>`__ (notably ``storescu``), |
|
35dde917804a
added command-line tools to ask support
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
637
diff
changeset
|
86 `dicom3tools <https://www.dclunie.com/dicom3tools.html>`__ (notably |
|
35dde917804a
added command-line tools to ask support
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
637
diff
changeset
|
87 ``dciodvfy``), `dcm4che command-line tools |
|
35dde917804a
added command-line tools to ask support
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
637
diff
changeset
|
88 <https://www.dcm4che.org/>`__ (notably ``storescu``), `GDCM |
|
35dde917804a
added command-line tools to ask support
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
637
diff
changeset
|
89 <http://gdcm.sourceforge.net/>`__ (notably ``gdcmscu``), or Python |
|
35dde917804a
added command-line tools to ask support
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
637
diff
changeset
|
90 scripts (notably using ``pydicom``). |
|
388
a3288fe6f84e
proprietary-support
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
360
diff
changeset
|
91 * 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
|
92 modality. |
| 389 | 93 * If applicable, a screenshot is worth a thousand words. |
| 271 | 94 * If you report a crash, if applicable, a :ref:`core file <crash>`. |
| 768 | 95 * The `OHIF viewer <https://ohif.org/>`__ can `connect to Orthanc |
| 96 <https://docs.ohif.org/history/v1/connecting-to-image-archives/orthanc-with-docker.html>`__ | |
| 97 using the DICOMweb plugin of Orthanc, but is a fully separate | |
| 98 project. As a consequence, questions regarding OHIF must be asked on | |
| 99 the `dedicated discussion group | |
| 100 <https://groups.google.com/g/cornerstone-platform>`__ or on the | |
| 769 | 101 `dedicated bug tracker |
| 102 <https://github.com/OHIF/Viewers/issues>`__. The core developers of | |
| 103 Orthanc will happily fix the :ref:`DICOMweb plugin <dicomweb>`, but | |
| 104 it is necessary for the reporter to identify the discrepancy wrt. | |
| 105 DICOMweb standard by providing a minimal working example as | |
| 106 explained above. | |
| 107 | |
| 271 | 108 |
| 109 All this information is mandatory, as it allows other members of the | |
| 110 Orthanc community to **reproduce your problem independently of your | |
| 111 setup**. If we can't reproduce your issue, we can't provide any | |
| 112 support! | |
| 113 | |
| 330 | 114 In addition, please note that the original author of Orthanc |
| 115 (Sébastien Jodogne), as a free software advocate, will only personally | |
| 116 deal with issues that are reproducible on recent GNU/Linux | |
| 117 distributions (typically, on Ubuntu 18.04 LTS or through Docker). | |
| 118 | |
| 271 | 119 |
| 985 | 120 .. _support-minquality: |
| 121 | |
| 122 Required minimal quality of a message in the Orthanc Users discussion forum | |
| 123 -------------------------------------------------------- | |
| 124 | |
| 125 While posting a message on the `Orthanc Users discussion forum | |
| 126 <https://discourse.orthanc-server.org>`__, you should not be surprised if | |
| 127 your message does not get any response if it does not meet these minimal | |
| 128 quality requirements: | |
| 129 | |
| 130 * Before posting, are you sure you have made everything possible to :ref:`analyze <support-resources>` | |
| 131 and solve the issue by yourself? This includes, searching the web or the forum | |
| 132 to see if the topic has already been discussed. | |
| 133 * :ref:`Describe your issue <support-mwe>` with as much details as possible. | |
| 134 * Review your message as if you were the one who should help you - | |
| 135 would you understand your problem? | |
| 136 * Be polite and respectful, say ``hello``, and adhere to the `code of conduct | |
| 137 <https://discourse.orthanc-server.org/faq>`__. | |
| 138 | |
| 139 | |
| 271 | 140 .. _support-tracker: |
| 141 | |
| 142 Using the bug tracker | |
| 143 --------------------- | |
| 144 | |
| 145 If you are **sure** that you are reporting a yet unknown bug, you can | |
| 146 consider directly introducing a `bug report on our issue tracker | |
|
445
987fbbc2b59e
leaving bitbucket wrt. bug tracker
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
389
diff
changeset
|
147 <https://bugs.orthanc-server.com/enter_bug.cgi>`__. Beware however |
| 271 | 148 that your issue might be closed if too vague or if not reproducible. |
|
984
46e2941b57dd
replace link to google users group by link to discourse
Alain Mazy <am@osimis.io>
parents:
980
diff
changeset
|
149 As a consequence, it is strongly advised to use the `Orthanc Users discussion forum |
|
46e2941b57dd
replace link to google users group by link to discourse
Alain Mazy <am@osimis.io>
parents:
980
diff
changeset
|
150 <https://discourse.orthanc-server.org>`__ in the |
| 774 | 151 first place. |
| 613 | 152 |
| 153 | |
| 154 .. _support-freelancers: | |
| 155 | |
| 156 Finding professional assistance | |
| 157 ------------------------------- | |
| 158 | |
| 159 If you face a problem you cannot solve by yourself, please follow this | |
| 160 decision chart: | |
| 161 | |
| 162 1. If you have a **reproducible issue** for which you can provide a | |
| 163 :ref:`minimal working example <support-mwe>` using only free and | |
| 164 open-source tools, use the `Orthanc Users discussion forum | |
|
984
46e2941b57dd
replace link to google users group by link to discourse
Alain Mazy <am@osimis.io>
parents:
980
diff
changeset
|
165 <https://discourse.orthanc-server.org>`__. |
| 613 | 166 |
| 901 | 167 2. If you need an **additional feature implemented in Orthanc**, and |
| 168 if you are ready to pay, get in touch with the `Orthanc Team | |
| 169 <https://orthanc.team>`__ or with `Osimis | |
| 170 <mailto:orthanc-support@osimis.io>`__, the commercial partners of | |
| 171 the Orthanc project. | |
| 613 | 172 |
| 900 | 173 3. If you are part of a **scientific team** and would like to setup a |
| 901 | 174 research project using Orthanc, including about AI, get in touch |
| 175 with `Sébastien Jodogne's research lab | |
| 176 <https://www.info.ucl.ac.be/~sjodogne/>`__ at the UCLouvain | |
| 177 university. | |
| 900 | 178 |
| 179 4. If you are not able to reproduce an issue by yourself, if you are | |
| 613 | 180 looking for personalized help related to deployments/training/..., |
| 181 or if you need **proximity support in your language/timezone**, | |
| 784 | 182 here is a list of freelancers/companies: |
| 613 | 183 |
| 637 | 184 * **Worldwide**: |
| 185 | |
|
834
0b35dcbb127c
merging Mazy & Crickboom into Orthanc.team
Alain Mazy <am@osimis.io>
parents:
832
diff
changeset
|
186 * `Orthanc Team (Alain Mazy & Benoît Crickboom) <https://orthanc.team>`__ (French/English, Belgium) |
| 637 | 187 |
| 188 * **Europe**: | |
| 189 | |
| 613 | 190 * `Adrian Schiopu <sc.callisto.srl@gmail.com>`__ (Romania) |
| 191 * `Krzysztof Turkiewicz <http://www.deeveeloop.pl/>`__ (Polish/English, Poland) | |
| 192 * `Salim Kanoun <https://github.com/salimkanoun>`__ (French/English/Arabic, France) | |
|
932
53bb4d4f8e56
updated stephen scotti
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
193 * `Stephen D. Scotti <https://www.medinformatics.eu>`__ (English, Austria) |
|
986
6650b0ab177a
added Yannick Lemarechal
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
985
diff
changeset
|
194 * `Yannick Lemaréchal <https://github.com/ylemarechal>`__ (French/English, France/Canada) |
| 613 | 195 |
| 196 * **North America**: | |
| 197 | |
| 198 * `Gabriel Couture <https://github.com/gacou54/>`__ (French/English, Canada) | |
| 199 * `Mohannad Hussain <https://www.linkedin.com/in/mohannadhussain/>`__ (English, Canada) | |
| 616 | 200 * `Oliver Tsai <mailto:oliver@futurepacs.com>`__ (English/Spanish/French, Toronto) |
|
986
6650b0ab177a
added Yannick Lemarechal
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
985
diff
changeset
|
201 * `Yannick Lemaréchal <https://github.com/ylemarechal>`__ (French/English, France/Canada) |
| 689 | 202 * `Yi Lu <https://www.linkedin.com/in/digihunch/>`__ (English, Canada) |
| 613 | 203 |
| 204 * **South America**: | |
| 205 | |
| 206 * `Claudio Arenas <mailto:dentista.arenas@gmail.com>`__ (Spanish/English, Chile) | |
|
876
9eae6d0b8032
added Fernando Sánchez
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
870
diff
changeset
|
207 * `Fernando Sánchez <https://integraper.com/?page_id=529>`__ (English/Spanish, Peru) |
| 613 | 208 * `Gustavo Fernandez <https://www.linkedin.com/in/gfernandezguirland/>`__ (Spanish/Portuguese, Uruguay) |
|
793
e1341328cd4a
added Ivan Kuschevatzky
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
791
diff
changeset
|
209 * `Iván Kuschevatzky <mailto:ivankuche@gmail.com>`__ (English/Spanish, Argentina) |
| 613 | 210 * `Luiz Eduardo Guida Valmont <https://www.linkedin.com/in/luizvalmont/>`__ (English/Portuguese, Brazil) |
| 211 * `William Sanchez Luis <mailto:williamsanchezluis@gmail.com>`__ (English/Spanish, Venezuela) | |
| 212 | |
|
894
08ea0a05acba
added africa support
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
876
diff
changeset
|
213 * **Africa**: |
|
08ea0a05acba
added africa support
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
876
diff
changeset
|
214 |
|
08ea0a05acba
added africa support
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
876
diff
changeset
|
215 * `Abdrahman Elkafil <mailto:elkafil@nextbehealthcare.com>`__ (English/French/Arabic, Belgium and Morocco) |
|
957
81f1253ac72c
added Olakunle Dada
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
951
diff
changeset
|
216 * `Olakunle Dada <mailto:holakunle69@gmail.com>`__ (English/French, Nigeria) |
|
894
08ea0a05acba
added africa support
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
876
diff
changeset
|
217 |
| 613 | 218 * **Asia**: |
| 219 | |
| 980 | 220 * `Ajay Rana <https://smarthms.in/>`__ (English/Hindi/Punjabi, India) |
| 613 | 221 * `Phong Tran Duc <http://www.itechcorp.com.vn/>`__ (English/Vietnamese, Vietnam) |
| 222 * `Rana Asim Wajid <http://ethosmed.com/>`__ (English/Urdu/Punjabi, Pakistan) | |
| 951 | 223 * `Yash Sonalia <mailto:sonaliayash@gmail.com>`__ (English/Hindi/Bengali, India) |
| 613 | 224 |
| 225 * **Oceania**: | |
| 226 | |
| 227 * `James Manner <https://binary.com.au/>`__ (English, Australia) | |
| 228 | |
| 614 | 229 Get in touch with `Sébastien Jodogne |
| 230 <mailto:s.jodogne@orthanc-labs.com>`__ if you want to be included | |
| 231 in this list. | |
| 232 |