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