Mercurial > hg > orthanc-book
comparison Sphinx/source/users/quick-start-windows.rst @ 1103:0f1d221a4faf
minor improvements in quick-start-windows
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Fri, 16 Aug 2024 14:42:59 +0200 |
parents | 569e7f6f4753 |
children |
comparison
equal
deleted
inserted
replaced
1102:4f3709b36f8a | 1103:0f1d221a4faf |
---|---|
1 .. _quick-start-windows: | 1 .. _quick-start-windows: |
2 | 2 |
3 Quickstart Guide for Windows | 3 Quickstart guide for Windows |
4 ============================ | 4 ============================ |
5 | 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. | 6 Orthanc is a lightweight, free and open-source DICOM server that is ideal for medical imaging professionals. This guide will help you to quickly set up and run Orthanc on a Microsoft Windows computer. |
7 | 7 |
8 Step 1: Download Orthanc | 8 Step 1: Download Orthanc |
9 ------------------------ | 9 ------------------------ |
10 | 10 |
11 1. **Visit the Orthanc Website** | 11 1. **Visit the Orthanc Website** |
12 | 12 |
13 Navigate to the `Orthanc downloads website <https://www.orthanc-server.com/download-windows.php>`_. | 13 Navigate to the `Orthanc downloads for Microsoft Windows <https://www.orthanc-server.com/download-windows.php>`__ Web site. |
14 | 14 |
15 2. **Download the Windows Installer** | 15 2. **Download the Windows Installer** |
16 | 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). | 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 | 18 |
19 Step 2: Install Orthanc | 19 Step 2: Install Orthanc |
20 ----------------------- | 20 ----------------------- |
21 | 21 |
22 1. **Run the Installer** | 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 | 23 |
24 have to click on ``More info`` and ``Run anyway`` | 24 Locate the downloaded installer file on your computer. Double-click on it to start the installation process. Note that the installer is not signed and that you might have to click on ``More info`` and ``Run anyway``: |
25 | 25 |
26 .. image:: ../images/win-quick-start-protect.png | 26 .. image:: ../images/win-quick-start-protect.png |
27 :align: center | 27 :align: center |
28 :width: 60% | 28 :width: 60% |
29 | 29 |
30 2. **Follow the Installation Wizard** | 30 2. **Follow the Installation Wizard** |
31 | 31 |
32 * Accept the license agreement. | 32 * Accept the license agreement. |
33 * Choose the installation directory (default ``C:\Program Files\Orthanc Server`` is usually fine). | 33 * Choose the installation directory (default value ``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). | 34 * Select the folder in which Orthanc will store its data (default value ``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 : plugins that are not explicitly enabled do not consume any resources. | 35 * Select the plugins to install. Although you might not need all of them, they are all selected by default and this is fine: Plugins that are not explicitly enabled do not consume any resources. |
36 * Complete the installation by following the prompts. | 36 * Complete the installation by following the prompts. |
37 | 37 |
38 .. image:: ../images/win-quick-start-inst.png | 38 .. image:: ../images/win-quick-start-inst.png |
39 :align: center | 39 :align: center |
40 :width: 40% | 40 :width: 40% |
41 | 41 |
42 Step 3: Orthanc is running ! | 42 Step 3: Orthanc is running! |
43 ---------------------------- | 43 --------------------------- |
44 | 44 |
45 At this stage, Orthanc is running as a Windows Service which means that it will start everytime your Windows machine starts. | 45 At this stage, Orthanc is running as a Windows Service, which means that it will automatically start whenever your computer starts. |
46 | 46 |
47 Orthanc User Interface is accessible at `http://localhost:8042/ui/app/ <http://localhost:8042/ui/app/>`_. Orthanc is currently empty | 47 The :ref:`Orthanc Explorer 2 <orthanc-explorer-2>` interface is accessible at `http://localhost:8042/ui/app/ <http://localhost:8042/ui/app/>`__. As Orthanc has not received any DICOM file yet, its content is currently empty: |
48 | 48 |
49 .. image:: ../images/win-quick-start-orthanc-empty.png | 49 .. image:: ../images/win-quick-start-orthanc-empty.png |
50 :align: center | 50 :align: center |
51 :width: 80% | 51 :width: 80% |
52 | 52 |
53 Step 4: Upload and view your first DICOM images ! | 53 Step 4: Upload and view your first DICOM images! |
54 ------------------------------------------------- | 54 ------------------------------------------------ |
55 | 55 |
56 The easiest way to feed Orthanc with DICOM images is through the ``upload`` menu of the User interface. | 56 The easiest way to feed Orthanc with DICOM images is through the ``Upload`` menu of the Orthanc Explorer 2 interface: |
57 | 57 |
58 .. image:: ../images/win-quick-start-orthanc-upload.png | 58 .. image:: ../images/win-quick-start-orthanc-upload.png |
59 :align: center | 59 :align: center |
60 :width: 40% | 60 :width: 40% |
61 | 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. | 62 Once uploaded, your DICOM images will appear in the list of studies. You will 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: | 63 Remember that we have installed all plugins? Therefore, you have the choice between 4 viewers: |
64 | 64 |
65 * The :ref:`Stone Web viewer <stone_webviewer>` | 65 * The :ref:`Stone Web viewer <stone_webviewer>`, |
66 * The :ref:`OHIF viewer <ohif>` | 66 * The :ref:`OHIF viewer <ohif>`, |
67 * :ref:`Volview <volview>` | 67 * The :ref:`Kitware VolView viewer <volview>`. |
68 | |
69 Each of these viewers can easily be launched by clicking on the buttons highlighted in red: | |
68 | 70 |
69 .. image:: ../images/win-quick-start-orthanc-study-list.png | 71 .. image:: ../images/win-quick-start-orthanc-study-list.png |
70 :align: center | 72 :align: center |
71 :width: 80% | 73 :width: 80% |
72 | 74 |
73 Step 5: Configure Orthanc | 75 Step 5: Configure Orthanc |
74 ------------------------- | 76 ------------------------- |
75 | 77 |
76 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 Orthanc is configured using a `JSON <https://en.wikipedia.org/wiki/JSON>`__ configuration file. The Windows installers come with a default configuration file that is suitable for quick testing. |
77 However, at some point, you might probably need to customize the settings. | 79 However, at some point, you will probably want to customize the settings. |
78 | 80 |
79 1. **Locate the Configuration Files** | 81 1. **Locate the Configuration Files** |
80 | 82 |
81 The Windows configuration is split under multiple configuration files and are typically stored in ``C:\Program Files\Orthanc\Configuration\``. | 83 The Windows configuration is split into multiple configuration files (one main configuration file, plus one for each plugin). These files are typically stored in ``C:\Program Files\Orthanc\Configuration\``. |
82 ``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 ``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>`__. |
83 Each :ref:`plugin <plugins>` has its own configuration file documented in the plugin documentation. | 85 In addition, each :ref:`plugin <plugins>` has its own configuration file that is described in the documentation of the plugin. |
84 | 86 |
85 .. image:: ../images/win-quick-start-config-files.png | 87 .. image:: ../images/win-quick-start-config-files.png |
86 :align: center | 88 :align: center |
87 :width: 40% | 89 :width: 40% |
88 | 90 |
89 2. **Edit the Configuration File** | 91 2. **Edit the Configuration File** |
90 | 92 |
91 To edit a configuration file, you must start your editor with ``Run as administrator``. | 93 To edit a configuration file, you must start your editor with ``Run as administrator``. |
92 We recommend to edit your configuration file with an editor such as `Notepad++ <https://notepad-plus-plus.org/>`_. | 94 We recommend to edit your configuration file using an editor such as `Notepad++ <https://notepad-plus-plus.org/>`__. |
93 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 It will warn you that this file can only be edited by an administrator and suggest that you restart Notepad++ as an administrator so that you will be able to save it. |
94 able to save it. | |
95 | 96 |
96 Configure settings such as: | 97 Some important configuration options are for instance: |
97 | 98 |
98 * **HTTP Server Port**: ``"HttpPort": 8042`` (default is 8042) | 99 * **HTTP Server Port**: ``"HttpPort": 8042`` (default is 8042) |
99 * **DICOM Server Port**: ``"DicomPort": 4242`` (default is 4242) | 100 * **DICOM Server Port**: ``"DicomPort": 4242`` (default is 4242) |
100 * **Database Storage Path**: ``"StorageDirectory": "OrthancStorage"`` | 101 * **Database Storage Path**: ``"StorageDirectory": "OrthancStorage"`` |
102 | |
101 Save your changes. | 103 Save your changes. |
102 | 104 |
103 **Remark 1:** When specifying paths under Microsoft Windows, | 105 **Remark 1:** When specifying paths under Microsoft Windows, |
104 backslashes (i.e. ``\``) should be either escaped by doubling them (as | 106 backslashes (i.e. ``\``) should be either escaped by doubling them (as |
105 in ``\\``), or replaced by forward slashes (as in ``/``). | 107 in ``\\``), or replaced by forward slashes (as in ``/``). |
106 | 108 |
107 **Remark 2:** In JSON, every ``{}`` and every ``,`` counts ! Orthanc will refuse to | 109 **Remark 2:** In JSON, every ``{}`` and every ``,`` counts! Orthanc will refuse to |
108 start if the file is not in a valid JSON format. There are numerous online JSON validators to validate your | 110 start if the file is not in a valid JSON format. There are numerous online JSON validators to validate your |
109 JSON. | 111 JSON. |
110 | 112 |
111 3. **Restart Orthanc service** | 113 3. **Restart Orthanc service** |
112 | 114 |
113 To take the configuration changes into account, Orthanc must be restarted. This is done through the | 115 To take the changes to the configuration files into account, Orthanc must be restarted. This is done through the |
114 ``services`` panel (type the ``Windows`` key and search for ``services``). Locate Orthanc and right click ``Restart`` | 116 ``services`` panel of Microsoft Windows (type the ``Windows`` key and search for ``services``). Locate the Orthanc service, right click, and select ``Restart``: |
115 | 117 |
116 | 118 |
117 .. image:: ../images/win-quick-start-services.png | 119 .. image:: ../images/win-quick-start-services.png |
118 :align: center | 120 :align: center |
119 :width: 70% | 121 :width: 70% |
120 | 122 |
121 4. **Check it is running correctly** | 123 4. **Check Orthanc is Running Correctly** |
122 | 124 |
123 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 Open the user interface at `http://localhost:8042/ui/app/ <http://localhost:8042/ui/app/>`__ to validate that Orthanc is still running correctly after your changes. |
124 If not, you should check the :ref:`Orthanc logs <log>` in ``C:\\Program Files\\Orthanc Server\\Logs``. | 126 If not, you should check the :ref:`Orthanc logs <log>` in the ``C:\Program Files\Orthanc Server\Logs\`` folder. |
125 | 127 |
126 | 128 |
127 Next steps | 129 Next steps |
128 ---------- | 130 ---------- |
129 | 131 |
130 Now that you know how to configure Orthanc, here are a few suggested sections to continue your exploration: | 132 Now that you know how to configure Orthanc, here are a few suggested sections to continue your exploration: |
131 | 133 |
132 * :ref:`Connect Orthanc to a DICOM modality <configure-modality>` | 134 * :ref:`Connect Orthanc to a DICOM modality <configure-modality>` |
133 * Connect a DICOMWeb client e.g. :ref:`Osirix <integrate-osirix-using-dicomweb>` | 135 * Connect a DICOMweb client such as :ref:`Osirix <integrate-osirix-using-dicomweb>` |
134 * Learn to use the Orthanc Rest API :ref:`Rest API <rest>` | 136 * Learn to use the Orthanc :ref:`REST API <rest>` |
135 * Start to customize Orthanc through :ref:`Lua scripting <lua>` | 137 * Start to customize Orthanc through :ref:`Lua scripting <lua>` |
136 * Extend Orthanc through a :ref:`Python plugin <python-plugin>` | 138 * Extend Orthanc using a :ref:`Python plugin <python-plugin>` |
137 * And learn much more by reading the :ref:`Orthanc book <orthanc-book>` | 139 * And learn much more by reading the whole :ref:`Orthanc book <orthanc-book>` |