# HG changeset patch # User Alain Mazy # Date 1724665405 -7200 # Node ID 92f294db6a8458b5ed631e1dfbe70caa7a6bb3f8 # Parent f8a335fdeae7fe92abcfff26bf1240c421fff269# Parent 0f1d221a4faf6813ef2805c894f4024bd630745c merge diff -r f8a335fdeae7 -r 92f294db6a84 Sphinx/source/users/docker-orthancteam.rst --- a/Sphinx/source/users/docker-orthancteam.rst Mon Aug 26 11:43:03 2024 +0200 +++ b/Sphinx/source/users/docker-orthancteam.rst Mon Aug 26 11:43:25 2024 +0200 @@ -49,6 +49,9 @@ - classical configuration files - a mix of these options +A comparison against the ``jodogne/orthanc`` Docker images :ref:`is +available `. + This `repository `__ contains lots of examples on how to use these images. In particular, `this example `__ diff -r f8a335fdeae7 -r 92f294db6a84 Sphinx/source/users/docker.rst --- a/Sphinx/source/users/docker.rst Mon Aug 26 11:43:03 2024 +0200 +++ b/Sphinx/source/users/docker.rst Mon Aug 26 11:43:25 2024 +0200 @@ -24,7 +24,13 @@ source code of the corresponding Docker images is available on `GitHub `__. -**Note about Orthanc vs. Orthanc Team Docker images:** + +.. _docker-jodogne-vs-orthanc-team: + +Orthanc vs. Orthanc Team Docker images +-------------------------------------- + +Two different flavors of Docker images for Orthanc are available: * The ``jodogne/orthanc`` and ``jodogne/orthanc-plugins`` Docker images that are described on this page are always kept in sync with @@ -33,20 +39,23 @@ (i.e., manual edition of the configuration files). This is also where the new experimental features from `Sébastien Jodogne's research team at UCLouvain `__ are - initially released. These images are most useful to **software - developers and researchers**. + initially released. The binaries used in these images correspond to + the Linux Standard Base binaries. The default user interface is the + built-in **Orthanc Explorer**. These images are most useful to + **software developers and researchers**. * Our commercial partner `Orthanc Team `__ also - `publishes separated Docker images + `publishes separate Docker images `__. These - ``orthancteam/orthanc`` images are used by the technical team of - the Orthanc Team company in order to provide professional support - to their customers, with a - configuration system that can be tuned through **environment - variables** (which is very handy if using ``docker-compose`` or - Kubernetes). A :ref:`specific page ` is - available to describe how these images should be used. These images - are targeted at **ops teams**. + ``orthancteam/orthanc`` images are used by the technical team of the + Orthanc Team company in order to provide professional support to + their customers, with a configuration system that can be tuned using + **environment variables** (which is very handy if using Docker + Compose or Kubernetes). The binaries used in these images are + compiled from scratch. The default user interface is the **Orthanc + Explorer 2** :ref:`plugin `. A :ref:`specific + page ` is available to describe how these images + should be used. These images are targeted at **ops teams**. **Note for CentOS users:** The Docker environment might be difficult to configure on your platform. Hints are available on the `Orthanc Users diff -r f8a335fdeae7 -r 92f294db6a84 Sphinx/source/users/quick-start-windows.rst --- a/Sphinx/source/users/quick-start-windows.rst Mon Aug 26 11:43:03 2024 +0200 +++ b/Sphinx/source/users/quick-start-windows.rst Mon Aug 26 11:43:25 2024 +0200 @@ -1,16 +1,16 @@ .. _quick-start-windows: -Quickstart Guide for Windows +Quickstart guide for Windows ============================ -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. +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. Step 1: Download Orthanc ------------------------ 1. **Visit the Orthanc Website** - Navigate to the `Orthanc downloads website `_. + Navigate to the `Orthanc downloads for Microsoft Windows `__ Web site. 2. **Download the Windows Installer** @@ -20,8 +20,8 @@ ----------------------- 1. **Run the Installer** - Locate the downloaded installer file and double-click it to start the installation process. Note that the installer is not signed and you might - have to click on ``More info`` and ``Run anyway`` + + 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``: .. image:: ../images/win-quick-start-protect.png :align: center @@ -30,41 +30,43 @@ 2. **Follow the Installation Wizard** * Accept the license agreement. -* Choose the installation directory (default ``C:\Program Files\Orthanc Server`` is usually fine). -* Select the folder in which Orthanc will store its data files (default ``C:\Orthanc`` is usually fine). -* 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. +* Choose the installation directory (default value ``C:\Program Files\Orthanc Server`` is usually fine). +* Select the folder in which Orthanc will store its data (default value ``C:\Orthanc`` is usually fine). +* 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. * Complete the installation by following the prompts. .. image:: ../images/win-quick-start-inst.png :align: center :width: 40% -Step 3: Orthanc is running ! ----------------------------- +Step 3: Orthanc is running! +--------------------------- -At this stage, Orthanc is running as a Windows Service which means that it will start everytime your Windows machine starts. +At this stage, Orthanc is running as a Windows Service, which means that it will automatically start whenever your computer starts. -Orthanc User Interface is accessible at `http://localhost:8042/ui/app/ `_. Orthanc is currently empty +The :ref:`Orthanc Explorer 2 ` interface is accessible at `http://localhost:8042/ui/app/ `__. As Orthanc has not received any DICOM file yet, its content is currently empty: .. image:: ../images/win-quick-start-orthanc-empty.png :align: center :width: 80% -Step 4: Upload and view your first DICOM images ! -------------------------------------------------- +Step 4: Upload and view your first DICOM images! +------------------------------------------------ -The easiest way to feed Orthanc with DICOM images is through the ``upload`` menu of the User interface. +The easiest way to feed Orthanc with DICOM images is through the ``Upload`` menu of the Orthanc Explorer 2 interface: .. image:: ../images/win-quick-start-orthanc-upload.png :align: center :width: 40% -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. -Remember that we have installed all plugins ? Therefore, you'll have the choice between 4 viewers: +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. +Remember that we have installed all plugins? Therefore, you have the choice between 4 viewers: -* The :ref:`Stone Web viewer ` -* The :ref:`OHIF viewer ` -* :ref:`Volview ` +* The :ref:`Stone Web viewer `, +* The :ref:`OHIF viewer `, +* The :ref:`Kitware VolView viewer `. + +Each of these viewers can easily be launched by clicking on the buttons highlighted in red: .. image:: ../images/win-quick-start-orthanc-study-list.png :align: center @@ -73,14 +75,14 @@ Step 5: Configure Orthanc ------------------------- -Orthanc is configured through a `JSON `__ configuration file and comes with a default configuration that is suitable for quick testing. -However, at some point, you might probably need to customize the settings. +Orthanc is configured using a `JSON `__ configuration file. The Windows installers come with a default configuration file that is suitable for quick testing. +However, at some point, you will probably want to customize the settings. 1. **Locate the Configuration Files** - The Windows configuration is split under multiple configuration files and are typically stored in ``C:\Program Files\Orthanc\Configuration\``. + 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\``. ``orthanc.json`` is the main configuration file. Its complete documentation is available `here `__. - Each :ref:`plugin ` has its own configuration file documented in the plugin documentation. + In addition, each :ref:`plugin ` has its own configuration file that is described in the documentation of the plugin. .. image:: ../images/win-quick-start-config-files.png :align: center @@ -88,40 +90,40 @@ 2. **Edit the Configuration File** - To edit a configuration file, you must start your editor with ``Run as administrator``. - We recommend to edit your configuration file with an editor such as `Notepad++ `_. - 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 - able to save it. + To edit a configuration file, you must start your editor with ``Run as administrator``. + We recommend to edit your configuration file using an editor such as `Notepad++ `__. + 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. - Configure settings such as: + Some important configuration options are for instance: * **HTTP Server Port**: ``"HttpPort": 8042`` (default is 8042) * **DICOM Server Port**: ``"DicomPort": 4242`` (default is 4242) * **Database Storage Path**: ``"StorageDirectory": "OrthancStorage"`` + Save your changes. **Remark 1:** When specifying paths under Microsoft Windows, backslashes (i.e. ``\``) should be either escaped by doubling them (as in ``\\``), or replaced by forward slashes (as in ``/``). - **Remark 2:** In JSON, every ``{}`` and every ``,`` counts ! Orthanc will refuse to + **Remark 2:** In JSON, every ``{}`` and every ``,`` counts! Orthanc will refuse to start if the file is not in a valid JSON format. There are numerous online JSON validators to validate your JSON. 3. **Restart Orthanc service** - To take the configuration changes into account, Orthanc must be restarted. This is done through the - ``services`` panel (type the ``Windows`` key and search for ``services``). Locate Orthanc and right click ``Restart`` + To take the changes to the configuration files into account, Orthanc must be restarted. This is done through the + ``services`` panel of Microsoft Windows (type the ``Windows`` key and search for ``services``). Locate the Orthanc service, right click, and select ``Restart``: .. image:: ../images/win-quick-start-services.png :align: center :width: 70% -4. **Check it is running correctly** +4. **Check Orthanc is Running Correctly** - Open the User Interface at `http://localhost:8042/ui/app/ `_ to validate that Orthanc is running correctly after your changes. - If not, you should check the :ref:`Orthanc logs ` in ``C:\\Program Files\\Orthanc Server\\Logs``. + Open the user interface at `http://localhost:8042/ui/app/ `__ to validate that Orthanc is still running correctly after your changes. + If not, you should check the :ref:`Orthanc logs ` in the ``C:\Program Files\Orthanc Server\Logs\`` folder. Next steps @@ -130,8 +132,8 @@ Now that you know how to configure Orthanc, here are a few suggested sections to continue your exploration: * :ref:`Connect Orthanc to a DICOM modality ` -* Connect a DICOMWeb client e.g. :ref:`Osirix ` -* Learn to use the Orthanc Rest API :ref:`Rest API ` +* Connect a DICOMweb client such as :ref:`Osirix ` +* Learn to use the Orthanc :ref:`REST API ` * Start to customize Orthanc through :ref:`Lua scripting ` -* Extend Orthanc through a :ref:`Python plugin ` -* And learn much more by reading the :ref:`Orthanc book ` \ No newline at end of file +* Extend Orthanc using a :ref:`Python plugin ` +* And learn much more by reading the whole :ref:`Orthanc book `