Mercurial > hg > orthanc-book
annotate Sphinx/source/users/quick-start-windows.rst @ 1112:ad26102adccc default tip
fix broken link
| author | Alain Mazy <am@orthanc.team> |
|---|---|
| date | Wed, 23 Oct 2024 16:52:30 +0200 |
| parents | 0f1d221a4faf |
| children |
| rev | line source |
|---|---|
| 1096 | 1 .. _quick-start-windows: |
| 2 | |
|
1103
0f1d221a4faf
minor improvements in quick-start-windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1098
diff
changeset
|
3 Quickstart guide for Windows |
| 1096 | 4 ============================ |
| 5 | |
|
1103
0f1d221a4faf
minor improvements in quick-start-windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1098
diff
changeset
|
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. |
| 1096 | 7 |
| 8 Step 1: Download Orthanc | |
| 9 ------------------------ | |
| 10 | |
| 11 1. **Visit the Orthanc Website** | |
| 12 | |
|
1103
0f1d221a4faf
minor improvements in quick-start-windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1098
diff
changeset
|
13 Navigate to the `Orthanc downloads for Microsoft Windows <https://www.orthanc-server.com/download-windows.php>`__ Web site. |
| 1096 | 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** | |
|
1103
0f1d221a4faf
minor improvements in quick-start-windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1098
diff
changeset
|
23 |
|
0f1d221a4faf
minor improvements in quick-start-windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1098
diff
changeset
|
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``: |
| 1096 | 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. | |
|
1103
0f1d221a4faf
minor improvements in quick-start-windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1098
diff
changeset
|
33 * Choose the installation directory (default value ``C:\Program Files\Orthanc Server`` is usually fine). |
|
0f1d221a4faf
minor improvements in quick-start-windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1098
diff
changeset
|
34 * Select the folder in which Orthanc will store its data (default value ``C:\Orthanc`` is usually fine). |
|
0f1d221a4faf
minor improvements in quick-start-windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1098
diff
changeset
|
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. |
| 1096 | 36 * Complete the installation by following the prompts. |
| 37 | |
| 38 .. image:: ../images/win-quick-start-inst.png | |
| 39 :align: center | |
| 40 :width: 40% | |
| 41 | |
|
1103
0f1d221a4faf
minor improvements in quick-start-windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1098
diff
changeset
|
42 Step 3: Orthanc is running! |
|
0f1d221a4faf
minor improvements in quick-start-windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1098
diff
changeset
|
43 --------------------------- |
| 1096 | 44 |
|
1103
0f1d221a4faf
minor improvements in quick-start-windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1098
diff
changeset
|
45 At this stage, Orthanc is running as a Windows Service, which means that it will automatically start whenever your computer starts. |
| 1096 | 46 |
|
1103
0f1d221a4faf
minor improvements in quick-start-windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1098
diff
changeset
|
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: |
| 1096 | 48 |
| 49 .. image:: ../images/win-quick-start-orthanc-empty.png | |
| 50 :align: center | |
| 51 :width: 80% | |
| 52 | |
|
1103
0f1d221a4faf
minor improvements in quick-start-windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1098
diff
changeset
|
53 Step 4: Upload and view your first DICOM images! |
|
0f1d221a4faf
minor improvements in quick-start-windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1098
diff
changeset
|
54 ------------------------------------------------ |
| 1096 | 55 |
|
1103
0f1d221a4faf
minor improvements in quick-start-windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1098
diff
changeset
|
56 The easiest way to feed Orthanc with DICOM images is through the ``Upload`` menu of the Orthanc Explorer 2 interface: |
| 1096 | 57 |
| 58 .. image:: ../images/win-quick-start-orthanc-upload.png | |
| 59 :align: center | |
| 60 :width: 40% | |
| 61 | |
|
1103
0f1d221a4faf
minor improvements in quick-start-windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1098
diff
changeset
|
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. |
|
0f1d221a4faf
minor improvements in quick-start-windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1098
diff
changeset
|
63 Remember that we have installed all plugins? Therefore, you have the choice between 4 viewers: |
| 1096 | 64 |
|
1103
0f1d221a4faf
minor improvements in quick-start-windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1098
diff
changeset
|
65 * The :ref:`Stone Web viewer <stone_webviewer>`, |
|
0f1d221a4faf
minor improvements in quick-start-windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1098
diff
changeset
|
66 * The :ref:`OHIF viewer <ohif>`, |
|
0f1d221a4faf
minor improvements in quick-start-windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1098
diff
changeset
|
67 * The :ref:`Kitware VolView viewer <volview>`. |
|
0f1d221a4faf
minor improvements in quick-start-windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1098
diff
changeset
|
68 |
|
0f1d221a4faf
minor improvements in quick-start-windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1098
diff
changeset
|
69 Each of these viewers can easily be launched by clicking on the buttons highlighted in red: |
| 1096 | 70 |
| 71 .. image:: ../images/win-quick-start-orthanc-study-list.png | |
| 72 :align: center | |
| 73 :width: 80% | |
| 74 | |
| 75 Step 5: Configure Orthanc | |
| 76 ------------------------- | |
| 77 | |
|
1103
0f1d221a4faf
minor improvements in quick-start-windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1098
diff
changeset
|
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. |
|
0f1d221a4faf
minor improvements in quick-start-windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1098
diff
changeset
|
79 However, at some point, you will probably want to customize the settings. |
| 1096 | 80 |
| 81 1. **Locate the Configuration Files** | |
| 82 | |
|
1103
0f1d221a4faf
minor improvements in quick-start-windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1098
diff
changeset
|
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\``. |
| 1096 | 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>`__. |
|
1103
0f1d221a4faf
minor improvements in quick-start-windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1098
diff
changeset
|
85 In addition, each :ref:`plugin <plugins>` has its own configuration file that is described in the documentation of the plugin. |
| 1096 | 86 |
| 87 .. image:: ../images/win-quick-start-config-files.png | |
| 88 :align: center | |
| 89 :width: 40% | |
| 90 | |
| 91 2. **Edit the Configuration File** | |
| 92 | |
|
1103
0f1d221a4faf
minor improvements in quick-start-windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1098
diff
changeset
|
93 To edit a configuration file, you must start your editor with ``Run as administrator``. |
|
0f1d221a4faf
minor improvements in quick-start-windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1098
diff
changeset
|
94 We recommend to edit your configuration file using an editor such as `Notepad++ <https://notepad-plus-plus.org/>`__. |
|
0f1d221a4faf
minor improvements in quick-start-windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1098
diff
changeset
|
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. |
| 1096 | 96 |
|
1103
0f1d221a4faf
minor improvements in quick-start-windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1098
diff
changeset
|
97 Some important configuration options are for instance: |
| 1096 | 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"`` | |
|
1103
0f1d221a4faf
minor improvements in quick-start-windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1098
diff
changeset
|
102 |
| 1096 | 103 Save your changes. |
| 104 | |
| 105 **Remark 1:** When specifying paths under Microsoft Windows, | |
| 106 backslashes (i.e. ``\``) should be either escaped by doubling them (as | |
| 107 in ``\\``), or replaced by forward slashes (as in ``/``). | |
| 108 | |
|
1103
0f1d221a4faf
minor improvements in quick-start-windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1098
diff
changeset
|
109 **Remark 2:** In JSON, every ``{}`` and every ``,`` counts! Orthanc will refuse to |
| 1096 | 110 start if the file is not in a valid JSON format. There are numerous online JSON validators to validate your |
| 111 JSON. | |
| 112 | |
| 113 3. **Restart Orthanc service** | |
| 114 | |
|
1103
0f1d221a4faf
minor improvements in quick-start-windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1098
diff
changeset
|
115 To take the changes to the configuration files into account, Orthanc must be restarted. This is done through the |
|
0f1d221a4faf
minor improvements in quick-start-windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1098
diff
changeset
|
116 ``services`` panel of Microsoft Windows (type the ``Windows`` key and search for ``services``). Locate the Orthanc service, right click, and select ``Restart``: |
| 1096 | 117 |
| 118 | |
| 119 .. image:: ../images/win-quick-start-services.png | |
| 120 :align: center | |
| 121 :width: 70% | |
| 122 | |
|
1103
0f1d221a4faf
minor improvements in quick-start-windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1098
diff
changeset
|
123 4. **Check Orthanc is Running Correctly** |
| 1096 | 124 |
|
1103
0f1d221a4faf
minor improvements in quick-start-windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1098
diff
changeset
|
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. |
|
0f1d221a4faf
minor improvements in quick-start-windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1098
diff
changeset
|
126 If not, you should check the :ref:`Orthanc logs <log>` in the ``C:\Program Files\Orthanc Server\Logs\`` folder. |
| 1096 | 127 |
| 128 | |
| 129 Next steps | |
| 130 ---------- | |
| 131 | |
| 132 Now that you know how to configure Orthanc, here are a few suggested sections to continue your exploration: | |
| 133 | |
| 134 * :ref:`Connect Orthanc to a DICOM modality <configure-modality>` | |
|
1103
0f1d221a4faf
minor improvements in quick-start-windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1098
diff
changeset
|
135 * Connect a DICOMweb client such as :ref:`Osirix <integrate-osirix-using-dicomweb>` |
|
0f1d221a4faf
minor improvements in quick-start-windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1098
diff
changeset
|
136 * Learn to use the Orthanc :ref:`REST API <rest>` |
| 1096 | 137 * Start to customize Orthanc through :ref:`Lua scripting <lua>` |
|
1103
0f1d221a4faf
minor improvements in quick-start-windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1098
diff
changeset
|
138 * Extend Orthanc using a :ref:`Python plugin <python-plugin>` |
|
0f1d221a4faf
minor improvements in quick-start-windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1098
diff
changeset
|
139 * And learn much more by reading the whole :ref:`Orthanc book <orthanc-book>` |