annotate Sphinx/source/faq/troubleshooting.rst @ 41:1c8aaaea72b2

runtime assertions
author Sebastien Jodogne <s.jodogne@gmail.com>
date Fri, 16 Sep 2016 08:57:28 +0200
parents dabe6df0267f
children a52f1dc48ebc
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 .. _troubleshooting:
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3 Troubleshooting
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 ===============
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5
16
b12e2c1d9fed troubleshooting
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 15
diff changeset
6 As a general rule, when you encounter an issue, always make sure that
b12e2c1d9fed troubleshooting
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 15
diff changeset
7 you use the `most recent version
b12e2c1d9fed troubleshooting
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 15
diff changeset
8 <http://www.orthanc-server.com/download.php>`__ of Orthanc.
b12e2c1d9fed troubleshooting
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 15
diff changeset
9
b12e2c1d9fed troubleshooting
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 15
diff changeset
10 Also make a search on the `Orthanc Users discussion group
b12e2c1d9fed troubleshooting
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 15
diff changeset
11 <https://groups.google.com/forum/#!forum/orthanc-users>`__, and make a
b12e2c1d9fed troubleshooting
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 15
diff changeset
12 search in the present Orthanc Book (there is a search field at the top
b12e2c1d9fed troubleshooting
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 15
diff changeset
13 of this page). Your issue might indeed have already been discussed in
b12e2c1d9fed troubleshooting
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 15
diff changeset
14 the past or in the FAQ.
b12e2c1d9fed troubleshooting
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 15
diff changeset
15
b12e2c1d9fed troubleshooting
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 15
diff changeset
16
b12e2c1d9fed troubleshooting
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 15
diff changeset
17 Orthanc Explorer
b12e2c1d9fed troubleshooting
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 15
diff changeset
18 ----------------
b12e2c1d9fed troubleshooting
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 15
diff changeset
19
0
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 * **I cannot login to Orthanc Explorer**: For security reasons, access
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 to Orthanc from remote hosts is disabled by default. Only the
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 localhost is allowed to access Orthanc. You have to set the
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 ``RemoteAccessAllowed`` option in the :ref:`configuration file
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 <configuration>` to ``true``. It is then strongly advised to set
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 ``AuthenticationEnabled`` to ``true`` and to add a user to the
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26 ``RegisteredUsers`` option, also in the configuration file.
16
b12e2c1d9fed troubleshooting
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 15
diff changeset
27
b12e2c1d9fed troubleshooting
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 15
diff changeset
28
b12e2c1d9fed troubleshooting
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 15
diff changeset
29 Performance issues
b12e2c1d9fed troubleshooting
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 15
diff changeset
30 ------------------
b12e2c1d9fed troubleshooting
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 15
diff changeset
31
41
1c8aaaea72b2 runtime assertions
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 18
diff changeset
32 * **Run-time debug assertions**: If performance is important to you,
1c8aaaea72b2 runtime assertions
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 18
diff changeset
33 make sure to add the option ``-DCMAKE_BUILD_TYPE=Release`` when
1c8aaaea72b2 runtime assertions
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 18
diff changeset
34 invoking ``cmake`` while :ref:`compiling Orthanc
1c8aaaea72b2 runtime assertions
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 18
diff changeset
35 <compiling>`. Indeed, by default, `run-time debug assertions
1c8aaaea72b2 runtime assertions
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 18
diff changeset
36 <https://en.wikipedia.org/wiki/Assertion_(software_development)#Assertions_for_run-time_checking>`_
1c8aaaea72b2 runtime assertions
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 18
diff changeset
37 are enabled, which can seriously impact performance, especially if
1c8aaaea72b2 runtime assertions
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 18
diff changeset
38 your Orthanc server stores a lot of DICOM instances.
1c8aaaea72b2 runtime assertions
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 18
diff changeset
39
1c8aaaea72b2 runtime assertions
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 18
diff changeset
40 Note that the `official Docker images
1c8aaaea72b2 runtime assertions
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 18
diff changeset
41 <https://github.com/jodogne/OrthancDocker>`__ of Orthanc <= 1.0.0
1c8aaaea72b2 runtime assertions
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 18
diff changeset
42 were not compiled in ``Release`` mode. As a consequence, to improve
1c8aaaea72b2 runtime assertions
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 18
diff changeset
43 performance, make sure to use either the mainline version of the
1c8aaaea72b2 runtime assertions
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 18
diff changeset
44 container, or versions more recent than ``jodogne/orthanc:1.1.0``.
1c8aaaea72b2 runtime assertions
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 18
diff changeset
45
18
dabe6df0267f localhost
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 16
diff changeset
46 * **Orthanc Explorer is slow under Windows on the localhost**:
dabe6df0267f localhost
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 16
diff changeset
47
dabe6df0267f localhost
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 16
diff changeset
48 - Favor ``127.0.0.1`` instead of ``localhost`` when specifying the
dabe6df0267f localhost
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 16
diff changeset
49 network address of a server. Users have reported that this minor
dabe6df0267f localhost
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 16
diff changeset
50 change `can massively improve performance
dabe6df0267f localhost
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 16
diff changeset
51 <https://groups.google.com/d/msg/orthanc-users/tTe28zR0nGk/Lvs0STJLAgAJ>`__
dabe6df0267f localhost
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 16
diff changeset
52 on Windows. Starting with Orthanc 1.0.1, the samples from the
dabe6df0267f localhost
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 16
diff changeset
53 source distribution have been adapted in this way.
dabe6df0267f localhost
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 16
diff changeset
54
dabe6df0267f localhost
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 16
diff changeset
55 - As an alternative, you can disable IPv6 support. This is a
dabe6df0267f localhost
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 16
diff changeset
56 Windows-specific problem that is discussed `here
dabe6df0267f localhost
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 16
diff changeset
57 <http://superuser.com/questions/43823/google-chrome-is-slow-to-localhost>`__
dabe6df0267f localhost
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 16
diff changeset
58 and `here
dabe6df0267f localhost
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 16
diff changeset
59 <http://stackoverflow.com/questions/1726585/firefox-and-chrome-slow-on-localhost-known-fix-doesnt-work-on-windows-7>`__.
16
b12e2c1d9fed troubleshooting
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 15
diff changeset
60
b12e2c1d9fed troubleshooting
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 15
diff changeset
61 * If you experience **slow DICOM transfers under Linux**, please read
b12e2c1d9fed troubleshooting
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 15
diff changeset
62 the `following bug report
b12e2c1d9fed troubleshooting
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 15
diff changeset
63 <https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=785400>`__. This
b12e2c1d9fed troubleshooting
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 15
diff changeset
64 issue does *not* affect all the versions of Linux. A
b12e2c1d9fed troubleshooting
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 15
diff changeset
65 patch to this issue is shipped with the Orthanc source code. In
b12e2c1d9fed troubleshooting
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 15
diff changeset
66 order to take advantage of this patch, you need to statically link
b12e2c1d9fed troubleshooting
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 15
diff changeset
67 Orthanc against DCMTK by using the ``-DUSE_SYSTEM_DCMTK=OFF`` flag
b12e2c1d9fed troubleshooting
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 15
diff changeset
68 `when invoking CMake
b12e2c1d9fed troubleshooting
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 15
diff changeset
69 <https://bitbucket.org/sjodogne/orthanc/src/default/LinuxCompilation.txt>`__.
b12e2c1d9fed troubleshooting
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 15
diff changeset
70
b12e2c1d9fed troubleshooting
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 15
diff changeset
71
b12e2c1d9fed troubleshooting
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 15
diff changeset
72 Windows-specific issues
b12e2c1d9fed troubleshooting
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 15
diff changeset
73 -----------------------
b12e2c1d9fed troubleshooting
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 15
diff changeset
74
0
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
75 * Under Windows, Orthanc creates the "OrthancStorage" folder, and
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
76 crashes with the error "**SQLite: Unable to open the database**":
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
77 Your directory name is either too long, or it contains special
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
78 characters. Please try and run Orthanc in a folder with a simple
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
79 name such as ``C:\Orthanc``.