Mercurial > hg > orthanc-book

comparison Sphinx/source/users/quick-start-windows.rst @ 1096:c825cf4672f2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
quick start guide for windows
author Alain Mazy <am@orthanc.team>
date Thu, 01 Aug 2024 13:24:18 +0200
parents
children 424dea75b62a
comparison
equal deleted inserted replaced
1095:5b6f8a2b012a 1096:c825cf4672f2
1 .. _quick-start-windows:
2
3 Quickstart Guide for Windows
4 ============================
5
6 Orthanc is a lightweight, open-source DICOM server ideal for medical imaging professionals. This guide will help you quickly set up and run Orthanc on a Windows machine.
7
8 Step 1: Download Orthanc
9 ------------------------
10
11 1. **Visit the Orthanc Website**
12
13 Navigate to the `Orthanc downloads website <https://www.orthanc-server.com/download-windows.php>`_.
14
15 2. **Download the Windows Installer**
16
17 Identify your OS version 64 or 32 bits (note: very likely 64 bits) and download the latest version of the Orthanc installer (``.exe`` file).
18
19 Step 2: Install Orthanc
20 -----------------------
21
22 1. **Run the Installer**
23 Locate the downloaded installer file and double-click it to start the installation process. Note that the installer is not signed and you might
24 have to click on ``More info`` and ``Run anyway``
25
26 .. image:: ../images/win-quick-start-protect.png
27 :align: center
28 :width: 60%
29
30 2. **Follow the Installation Wizard**
31
32 * Accept the license agreement.
33 * Choose the installation directory (default ``C:\Program Files\Orthanc Server`` is usually fine).
34 * Select the folder in which Orthanc will store its data files (default ``C:\Orthanc`` is usually fine).
35 * Select the plugins to install. Although you might not need all of them, they are all selected by default and this is fine.
36 * Complete the installation by following the prompts.
37
38 .. image:: ../images/win-quick-start-inst.png
39 :align: center
40 :width: 40%
41
42 Step 3: Orthanc is running !
43 ----------------------------
44
45 At this stage, Orthanc is running as a Windows Service which means that it will start everytime your Windows machine starts.
46
47 Orthanc User Interface is accessible at `http://localhost:8042/ui/app/ <http://localhost:8042/ui/app/>`_. Orthanc is currently empty
48
49 .. image:: ../images/win-quick-start-orthanc-empty.png
50 :align: center
51 :width: 80%
52
53 Step 4: Upload and view your first DICOM images !
54 -------------------------------------------------
55
56 The easiest way to feed Orthanc with DICOM images is through the ``upload`` menu of the User interface.
57
58 .. image:: ../images/win-quick-start-orthanc-upload.png
59 :align: center
60 :width: 40%
61
62 Once this is done, your DICOM images will appear in the Study List and you'll be able to browse them and visualize them with one of the pre-installed viewers.
63 Remember that we have installed all plugins ? Therefore, you'll have the choice between 4 viewers:
64
65 * The :ref:`Stone Web viewer <stone_webviewer>`
66 * The :ref:`OHIF viewer <ohif>`
67 * :ref:`Volview <volview>`
68 * The :ref:`Osimis WebViewer plugin <osimis_webviewer>` (now deprecated)
69
70 .. image:: ../images/win-quick-start-orthanc-study-list.png
71 :align: center
72 :width: 80%
73
74 Step 5: Configure Orthanc
75 -------------------------
76
77 Orthanc is configured through a `JSON <https://en.wikipedia.org/wiki/JSON>`__ configuration file and comes with a default configuration that is suitable for quick testing.
78 However, at some point, you might probably need to customize the settings.
79
80 1. **Locate the Configuration Files**
81
82 The Windows configuration is split under multiple configuration files and are typically stored in ``C:\Program Files\Orthanc\Configuration\``.
83 ``orthanc.json`` is the main configuration file. Its complete documentation is available `here <https://orthanc.uclouvain.be/hg/orthanc/file/tip/OrthancServer/Resources/Configuration.json>`__.
84 Each :ref:`plugin <plugins>` has its own configuration file documented in the plugin documentation.
85
86 .. image:: ../images/win-quick-start-config-files.png
87 :align: center
88 :width: 40%
89
90 2. **Edit the Configuration File**
91
92 To edit a configuration file, you must start your editor with ``Run as administrator``.
93 We recommend to edit your configuration file with an editor such as `Notepad++ <https://notepad-plus-plus.org/>`_.
94 It shall warn you that this file can be edited only by an admin, and will suggest you to restart Notepad++ as an admin such that you'll be
95 able to save it.
96
97 Configure settings such as:
98
99 * **HTTP Server Port**: ``"HttpPort": 8042`` (default is 8042)
100 * **DICOM Server Port**: ``"DicomPort": 4242`` (default is 4242)
101 * **Database Storage Path**: ``"StorageDirectory": "OrthancStorage"``
102 Save your changes.
103
104 **Remark 1:** When specifying paths under Microsoft Windows,
105 backslashes (i.e. ``\``) should be either escaped by doubling them (as
106 in ``\\``), or replaced by forward slashes (as in ``/``).
107
108 **Remark 2:** In JSON, every ``{}`` and every ``,`` counts ! Orthanc will refuse to
109 start if the file is not in a valid JSON format. There are numerous online JSON validators to validate your
110 JSON.
111
112 3. **Restart Orthanc service**
113
114 To take the configuration changes into account, Orthanc must be restarted. This is done through the
115 ``services`` panel (type the ``Windows`` key and search for ``services``). Locate Orthanc and right click ``Restart``
116
117
118 .. image:: ../images/win-quick-start-services.png
119 :align: center
120 :width: 70%
121
122 4. **Check it is running correctly**
123
124 Open the User Interface at `http://localhost:8042/ui/app/ <http://localhost:8042/ui/app/>`_ to validate that Orthanc is running correctly after your changes.
125 If not, you should check the :ref:`Orthanc logs <log>` in ``C:\\Program Files\\Orthanc Server\\Logs``.
126
127
128 Next steps
129 ----------
130
131 Now that you know how to configure Orthanc, here are a few suggested sections to continue your exploration:
132
133 * :ref:`Connect Orthanc to a DICOM modality <configure-modality>`
134 * Connect a DICOMWeb client e.g. :ref:`Osirix <integrate-osirix-using-dicomweb>`
135 * Learn to use the Orthanc Rest API :ref:`Rest API <rest>`
136 * Start to customize Orthanc through :ref:`Lua scripting <lua>`
137 * Extend Orthanc through a :ref:`Python plugin <python-plugin>`
138 * And learn much more by reading the :ref:`Orthanc book <orthanc-book>`