Orthanc

https://orthanc.uclouvain.be/book/
Admin
Orthanc is a lightweight DICOM server that enables storage, retrieval, and management of medical...
Tokens:235,503
Snippets:2,137
Trust Score:9.9
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install rcconf for service management

Source: https://orthanc.uclouvain.be/book/faq/debian-daemon.html

Installs the 'rcconf' utility, which provides an interactive way to manage services that start at boot.

```bash
$ sudo apt-get install rcconf
```

--------------------------------

### Install wsgidav and cheroot, and set up a test directory

Source: https://orthanc.uclouvain.be/book/users/webdav.html

Installs necessary Python packages and creates a sample file for WebDAV testing. Ensure you have pip installed.

```bash
$ sudo pip install wsgidav cheroot
$ mkdir -p /tmp/webdav/hello
$ echo "foo" > /tmp/webdav/hello/world
```

--------------------------------

### Prepare and Start dcmqrscp for Testing

Source: https://orthanc.uclouvain.be/book/users/storage-commitment.html

This sequence uploads a sample image to Orthanc, generates a DICOMDIR, and starts the dcmqrscp tool. The dcmqrscp tool emulates a DICOM SCP and listens on port 11114. Ensure dcm4che is installed and accessible.

```bash
$ storescu localhost 4242 /tmp/DummyCT.dcm
$ curl http://localhost:8042/studies/b9c08539-26f93bde-c81ab0d7-bffaf2cb-a4d0bdd0/media > /tmp/DummyCT.zip
$ mkdir /tmp/dcmqrscp
$ cd /tmp/dcmqrscp
$ unzip /tmp/DummyCT.zip
$ /home/jodogne/Downloads/dcm4che-5.20.0/bin/dcmqrscp -b DCMQRSCP:11114 --dicomdir /tmp/dcmqrscp/DICOMDIR
15:20:09,476 INFO  - Start TCP Listener on 0.0.0.0/0.0.0.0:11114

```

--------------------------------

### Install Orthanc and plugins

Source: https://orthanc.uclouvain.be/book/users/debian-packages.html

Install Orthanc and its official plugins.

```bash
$ sudo apt install orthanc
$ sudo apt install orthanc-dicomweb
$ sudo apt install orthanc-gdcm
$ sudo apt install orthanc-imagej
$ sudo apt install orthanc-mysql
$ sudo apt install orthanc-wsi

```

--------------------------------

### Enable Orthanc init service at boot

Source: https://orthanc.uclouvain.be/book/faq/debian-daemon.html

Configures the Orthanc service to start automatically when the system boots up. Use this after installing the init script.

```bash
$ sudo update-rc.d orthanc defaults
```

--------------------------------

### Log Output Example

Source: https://orthanc.uclouvain.be/book/plugins/python.html

Example log output showing successful Python plugin initialization.

```text
W0331 15:48:12.990661 PluginsManager.cpp:269] Registering plugin 'python' (version mainline)
W0331 15:48:12.990691 PluginsManager.cpp:168] Python plugin is initializing
W0331 15:48:12.990743 PluginsManager.cpp:168] Using Python script "hello.py" from directory: /etc/orthanc
W0331 15:48:12.990819 PluginsManager.cpp:168] Program name: /usr/local/sbin/Orthanc
Hello world!
```

--------------------------------

### Install vcpkg dependencies for Google

Source: https://orthanc.uclouvain.be/book/plugins/object-storage.html

Install vcpkg dependencies for Google Storage plugin.

```bash
$ ./vcpkg install cryptopp
$ ./vcpkg install google-cloud-cpp

```

--------------------------------

### Start Prometheus with Docker

Source: https://orthanc.uclouvain.be/book/users/advanced-rest.html

Command to start a Prometheus server using Docker.

```bash
$ sudo run -p 9090:9090 -v /tmp/prometheus.yml:/etc/prometheus/prometheus.yml --rm prom/prometheus:v2.7.0

```

--------------------------------

### Start MinIO server with Docker

Source: https://orthanc.uclouvain.be/book/plugins/object-storage.html

Starts a local MinIO server for AWS S3 emulation. Set MINIO_REGION to an AWS-supported region; the access and secret keys must match the credentials used in the Orthanc configuration. After starting, open http://localhost:9000/ to create a bucket.

```bash
$ docker run -p 9000:9000 \
  -e "MINIO_REGION=eu-west-1" \
  -e "MINIO_ACCESS_KEY=AKIAIOSFODNN7EXAMPLE" \
  -e "MINIO_SECRET_KEY=wJalrXUtnFEMI/K7MNG/bPxRfiCYEXAMPLEKEY" \
  minio/minio server /data
```

--------------------------------

### Start CouchDB Container

Source: https://orthanc.uclouvain.be/book/plugins/python.html

Command to start a CouchDB container with the specified credentials and port mapping.

```bash
$ docker run --rm -t -i -p 5984:5984 -e COUCHDB_USER=admin -e COUCHDB_PASSWORD=password couchdb:3.3.3
```

--------------------------------

### Start Orthanc with configuration file or folder

Source: https://orthanc.uclouvain.be/book/users/configuration.html

Starts Orthanc by providing a configuration file path or a folder containing multiple `.json` configuration files. All `.json` files in the folder are loaded.

```bash
$ Orthanc ./Configuration.json
$ Orthanc ./config/

```

--------------------------------

### Python: Insert virtual environment site-packages into sys.path on Windows

Source: https://orthanc.uclouvain.be/book/plugins/python.html

Example 3: On a Windows system, to use a virtual environment at C:/tmp/.venv/, insert the venv's site-packages at the beginning of sys.path (index 0) so that packages are looked up there first. If a package is not present in the venv, the system-wide installation might be loaded. The example prints sys.path before and after modification, then imports requests.

```python
import orthanc
import sys

print("sys.path before modification: " + ", ".join(sys.path))

sys.path.insert(0, "C:/tmp/.venv/Lib/site-packages")

print("sys.path after modification: " + ", ".join(sys.path))

import requests
# ....

```

--------------------------------

### Install vcpkg dependencies for Azure

Source: https://orthanc.uclouvain.be/book/plugins/object-storage.html

Install vcpkg dependencies for Azure Blob Storage plugin.

```bash
$ ./vcpkg install cryptopp
$ ./vcpkg install azure-storage-cpp

```

--------------------------------

### Python Plugin Configuration Examples

Source: https://orthanc.uclouvain.be/book/plugins/python.html

Two JSON configuration examples for the Orthanc Python plugin: a minimal global configuration and a dedicated Python section with aliases and additional options.

```json
{
  "Plugins" : [ "." ],
  "PythonScript" : "my-plugin.py",
  "PythonVerbose" : false
}

```

```json
{
  "Plugins" : [ "." ],
  "Python" : {
    "Path" : "my-plugin.py",  // Alias for the global "PythonScript" option
    "Verbose" : false,        // Alias for the global "PythonVerbose" option
    "DisplayMemoryUsage" : false,
    "AllowThreads" : false
  }
}

```

--------------------------------

### Start PostgreSQL container

Source: https://orthanc.uclouvain.be/book/users/docker.html

Starts the official PostgreSQL container with the specified user and password. The container is removed after it stops.

```bash
$ docker run --name some-postgres -e POSTGRES_USER=postgres -e POSTGRES_PASSWORD=pgpassword --rm postgres

```

--------------------------------

### Start Orthanc with WSI Viewer Plugin

Source: https://orthanc.uclouvain.be/book/users/docker.html

Starts the orthanc-plugins container with the WSI viewer plugin enabled. The container is named 'orthanc-wsi' for later linking.

```bash
$ docker run -p 4242:4242 -p 8042:8042 --rm --name orthanc-wsi jodogne/orthanc-plugins:1.13.0

```

--------------------------------

### Start Orthanc with Trace Logging

Source: https://orthanc.uclouvain.be/book/faq/log.html

Use the --trace and --logfile command-line options to start Orthanc with detailed logging and redirect output to a file. This is useful for debugging.

```bash
$ ./Orthanc --trace --logfile=orthanc.log

```

--------------------------------

### Install vcpkg dependencies for AWS

Source: https://orthanc.uclouvain.be/book/plugins/object-storage.html

Install Crypto++ dependency via vcpkg.

```bash
$ ./vcpkg install cryptopp

```

--------------------------------

### Start Orthanc with Docker Compose

Source: https://orthanc.uclouvain.be/book/users/docker.html

Starts the Orthanc container defined in the docker-compose.yml file.

```bash
$ docker-compose up

```

--------------------------------

### Start Orthanc with PostgreSQL configuration

Source: https://orthanc.uclouvain.be/book/users/docker.html

Starts the Orthanc container, mounting the modified configuration file as read-only and exposing ports 4242 and 8042.

```bash
$ docker run -p 4242:4242 -p 8042:8042 --rm -v /tmp/orthanc.json:/etc/orthanc/orthanc.json:ro jodogne/orthanc-plugins:1.13.0

```

--------------------------------

### Install Stone Web viewer on Debian 9 (legacy apt-key method)

Source: https://orthanc.uclouvain.be/book/users/cookbook.html

Commands to install the Stone Web viewer on a barebone Debian 9 Docker container. Uses the older apt-key method for the repository key. Intended for older Debian/Ubuntu versions that still use apt-key.

```bash
# docker run --rm -t -i -p 8042:8042 -p 4242:4242 debian:9

$ cat <<EOF > /etc/apt/sources.list
deb http://archive.debian.org/debian stretch main
deb http://archive.debian.org/debian-security stretch/updates main
EOF
$ apt update
$ DEBIAN_FRONTEND=noninteractive apt install -y software-properties-common wget curl nano gnupg apt-transport-https

$ wget -qO - https://orthanc.uclouvain.be/debian/archive.key | apt-key add -
$ export DISTRO_VERSION=`grep '^VERSION_CODENAME' /etc/os-release | cut -d'=' -f 2`
$ apt-add-repository -y "deb https://orthanc.uclouvain.be/debian ${DISTRO_VERSION} main"

$ apt clean && apt update
$ apt install orthanc-stone-webviewer
$ Orthanc /etc/orthanc

```

--------------------------------

### Install Stone Web viewer on Debian 13 (modern apt-key method)

Source: https://orthanc.uclouvain.be/book/users/cookbook.html

Commands to install the Stone Web viewer on a barebone Debian 13 Docker container. Uses the modern signed-by method for the repository key. Requires an AMD64 architecture and a supported Debian/Ubuntu version.

```bash
# docker run --rm -t -i -p 8042:8042 -p 4242:4242 debian:13

$ apt update
$ DEBIAN_FRONTEND=noninteractive apt install -y wget curl nano gnupg apt-transport-https

$ wget -qO - https://orthanc.uclouvain.be/debian/archive.key | gpg --dearmor -o /usr/share/keyrings/orthanc-archive-keyring.gpg
$ export DISTRO_VERSION=`grep '^VERSION_CODENAME' /etc/os-release | cut -d'=' -f 2`
$ echo "deb [signed-by=/usr/share/keyrings/orthanc-archive-keyring.gpg] https://orthanc.uclouvain.be/debian ${DISTRO_VERSION} main" > /etc/apt/sources.list.d/orthanc.list

$ apt clean && apt update
$ apt install orthanc-stone-webviewer
$ Orthanc /etc/orthanc

```

--------------------------------

### Orthanc Python Plugin Examples

Source: https://orthanc.uclouvain.be/book/plugins/python.html

Code examples demonstrating how to replace Orthanc's DICOM SCP with pynetdicom, catch exceptions in the Python plugin, and implement a custom storage area.

```json
{
  "Plugins" : [ "." ],
  "PythonScript" : "pynetdicom.py",
  "DicomServerEnabled" : false
}

```

```python
import json
import orthanc
import pynetdicom

def HandleStore(event):
    orthanc.LogWarning('Handling C-STORE using pynetdicom')
    orthanc.RestApiPost('/instances', event.request.DataSet.getvalue())
    return 0x0000

ae = pynetdicom.AE()
ae.supported_contexts = pynetdicom.AllStoragePresentationContexts

SCP = None

def OnChange(changeType, level, resource):
    global SCP
    
    if changeType == orthanc.ChangeType.ORTHANC_STARTED:
        port = json.loads(orthanc.GetConfiguration()).get('DicomPort', 4242)
        
        SCP = ae.start_server(('', port), block = False)

```

```python
import orthanc

def OnChange(changeType, level, resource):
    if changeType == orthanc.ChangeType.ORTHANC_STARTED:
        try:
            # Some code that might raise an exception
            pass
        except orthanc.OrthancException as e:
            # Raised in releases >= 3.3
            print(e)
        except ValueError as e:
            # Raised in releases <= 3.2 of the plugin (doesn't occur in releases >= 3.3)
            print(e)

orthanc.RegisterOnChangeCallback(OnChange)

```

```python
# Compared to the default Orthanc storage, this storage plugin 
# uses a flat folder structure but prefixes all file paths with 
# the PatientID.  This is a sample only and should not be used 
# in production.

import orthanc
from typing import Tuple, Optional
import json
import os
import re

orthanc_full_configuration = json.loads(orthanc.GetConfiguration())

root_storage_directory = orthanc_full_configuration.get('StorageDirectory', orthanc_full_configuration.get('IndexDirectory', os.curdir))

orthanc.LogWarning(f"Python Storage: root directory: {root_storage_directory}")

```

--------------------------------

### Permission Configuration for GET Requests

Source: https://orthanc.uclouvain.be/book/plugins/authorization.html

Example configuration defining permissions required for GET requests to patient, study, series, or instance endpoints.

```json
["get" , "^/(patients|studies|series|instances)/([a-f0-9-]+)$", "all|view"]

```

--------------------------------

### Start Microsoft SQL Server Docker Container

Source: https://orthanc.uclouvain.be/book/plugins/odbc.html

Starts a non-persistent developer instance of MSSQL 2019 using Docker. Ensure you have Docker installed and running.

```bash
$ docker run --name mssql --rm -t -i -e 'ACCEPT_EULA=Y' -e 'SA_PASSWORD=MyStrOngPa55word!' \
  -e MSSQL_MEMORY_LIMIT_MB=512 -p 1433:1433 mcr.microsoft.com/mssql/server:2019-latest

```

--------------------------------

### Launch Orthanc with Configuration

Source: https://orthanc.uclouvain.be/book/plugins/worklists-plugin.html

Start the Orthanc server using the command line, specifying the path to your custom configuration file.

```bash
Orthanc.exe config.json

```

--------------------------------

### Dockerfile: Set PYTHONPATH to use a virtual environment

Source: https://orthanc.uclouvain.be/book/plugins/python.html

Example 1: On a Linux system, create a virtual environment in /tmp/.venv and set the PYTHONPATH environment variable to instruct the Python interpreter to search for modules in the virtual environment. This example is implemented in a Docker container using the orthancteam/orthanc-pre-release:bookworm image. It installs python3-venv, creates a virtual environment at /.venv, installs pydicom, sets PYTHONPATH to /.venv/lib64/python3.11/site-packages/, and copies Python files into /python.

```dockerfile
FROM orthancteam/orthanc-pre-release:bookworm

# This example is using a virtual env that is not mandatory when using Docker containers
# but recommended since python 3.11 and Debian bookworm based images where you get a warning
# when installing system-wide packages.  RUN apt update && apt install -y python3-venv
RUN python3 -m venv /.venv

RUN /.venv/bin/pip install pydicom
ENV PYTHONPATH=/.venv/lib64/python3.11/site-packages/

RUN mkdir /python
COPY * /python/

```

--------------------------------

### Python: Rewrite sys.path to use a virtual environment on Linux

Source: https://orthanc.uclouvain.be/book/plugins/python.html

Example 2: On a Linux system, to use only the modules installed in a virtual environment at /tmp/.venv, rewrite sys.path to include the system Python directories and the virtual environment's site-packages. The example prints sys.path before and after modification, then imports requests.

```python
import orthanc
import sys

print("sys.path before modification: " + ", ".join(sys.path))

sys.path = ["/usr/lib/python3.8", "/usr/lib/python3.8/lib-dynload", "/tmp/.env/lib/python3.8/site-packages", "/tmp/.venv/lib64/python3.8/site-packages"]

print("sys.path after modification: " + ", ".join(sys.path))

import requests
# ....

```

--------------------------------

### Query Series with XML Format using QIDO-RS

Source: https://orthanc.uclouvain.be/book/plugins/dicomweb.html

This example demonstrates a QIDO-RS search for series associated with a specific patient name, requesting the response in XML format. Note that GET arguments are passed in the 'Arguments' field.

```bash
$ curl http://localhost:8042/dicom-web/servers/sample/get -d @- << EOF
{
  "Uri" : "/series",
  "HttpHeaders" : {
    "Accept" : "application/dicom+xml"
  },
  "Arguments" : {
    "00100010" : "KNIX"
  }
}
EOF

```

--------------------------------

### Configure Orthanc AwsS3Storage for MinIO

Source: https://orthanc.uclouvain.be/book/plugins/object-storage.html

Orthanc configuration for using MinIO as an AWS S3-compatible storage backend. VirtualAddressing must be false for local MinIO setups; this option is not available in plugin releases <= 1.1.0. A SignatureDoesNotMatch error indicates the access/secret keys do not match those used when starting MinIO.

```json
{
  "Plugins" : [ <...> ],
  "AwsS3Storage" : {
    "BucketName": "my-sample-bucket",
    "Region" : "eu-west-1",
    "Endpoint": "http://localhost:9000/",
    "AccessKey": "AKIAIOSFODNN7EXAMPLE",
    "SecretKey": "wJalrXUtnFEMI/K7MNG/bPxRfiCYEXAMPLEKEY",
    "VirtualAddressing" : false
  }
}
```

--------------------------------

### Get Metadata with Revision (GET)

Source: https://orthanc.uclouvain.be/book/faq/features.html

A GET request for metadata will also return the current ETag value, representing the revision number.

```bash
$ curl -v http://localhost:8042/instances/19816330-cb02e1cf-df3a8fe8-bf510623-ccefe9f5/metadata/1024
[...]
< ETag: "0"

```

--------------------------------

### Full Authorization Configuration Example

Source: https://orthanc.uclouvain.be/book/plugins/authorization.html

This snippet shows the complete structure for configuring the authorization module, including various web service endpoints and permission definitions. It is useful for setting up a custom authorization flow.

```json
{
  "Authorization" : {
      // The Base URL of the auth webservice.  This is an alias for all next 4 configurations:
      // // "WebServiceUserProfileUrl" : " ROOT /user/get-profile",
      // // "WebServiceTokenValidationUrl" : " ROOT /tokens/validate",
      // // "WebServiceTokenCreationBaseUrl" : " ROOT /tokens/",
      // // "WebServiceTokenDecoderUrl" : " ROOT /tokens/decode",
      // You should define it only if your auth webservice implements all 4 routes !
      // "WebServiceRootUrl" : "http://change-me:8000/",

      // The URL of the auth webservice route implementing user profile (optional)
      // "WebServiceUserProfileUrl" : "http://change-me:8000/user/profile",

      // The URL of the auth webservice route implementing resource level authorization (optional)
      // "WebServiceTokenValidationUrl" : "http://change-me:8000/tokens/validate",

      // The Base URL of the auth webservice route to create tokens (optional)
      // "WebServiceTokenCreationBaseUrl" : "http://change-me:8000/tokens/",

      // The URL of the auth webservice route implementing token decoding (optional)
      // "WebServiceTokenDecoderUrl": "http://change-me:8000/tokens/decode"

      // The username and password to connect to the webservice (optional)
      //"WebServiceUsername": "change-me",
      //"WebServicePassword": "change-me",

      // An identifier added to the payload of each request to the auth webservice (optional).
      // It is used to identify the Orthanc instance that is sending the request to the auth webservice
      //"WebServiceIdentifier": "change-me"

      // The name of the HTTP headers that may contain auth tokens
      //"TokenHttpHeaders" : [],

      // The name of the GET arguments that may contain auth tokens
      //"TokenGetArguments" : [],

      // A list of predefined configurations for well-known plugins
      // "StandardConfigurations": [               // new in v 0.4.0
      //     "osimis-web-viewer",
      //     "stone-webviewer",
      //     "orthanc-explorer-2",
      //     "ohif"
      // ],

      //"UncheckedResources" : [],
      //"UncheckedFolders" : [],
      //"CheckedLevel" : "studies",
      //"UncheckedLevels" : [],

      // Definition of required "user-permissions".  This can be fully customized.
      // You may define other permissions yourself as long as they match the permissions
      // provided in the user-profile route implemented by the auth-service.
      // You may test your regex in https://regex101.com/ by selecting .NET (C#) and removing the leading ^ and trailing $
      // The default configuration is suitable for Orthanc-Explorer-2 (see https://github.com/orthanc-team/orthanc-auth-service)
      "Permissions" : [
          ["post", "^/auth/tokens/decode$", ""],
          ["post", "^/tools/lookup$", ""],

          // elemental browsing in OE2
          ["post", "^/tools/find$", "all|view"],
          ["get" , "^/(patients|studies|series|instances)/([a-f0-9-]+)$", "all|view"],
          ...
      ]
  }
}
```

--------------------------------

### Install DICOM Package for Octave

Source: https://orthanc.uclouvain.be/book/faq/matlab.html

Command to install the DICOM package for Octave from a local tarball. Ensure necessary development packages like libgdcm2-dev and octave-image are installed first.

```bash
$ octave --no-gui --eval "pkg install ./dicom-0.2.0.tar.gz"

```

--------------------------------

### C-FIND SCP handler example

Source: https://orthanc.uclouvain.be/book/plugins/python.html

Minimal example for a C-FIND handler in the Python plugin.

```python
import json
import orthanc


def OnFind(answers, query, connection):  # new from v 7.0: issuerAet and calledAet are available from the connection object
    print('Received incoming C-FIND request from %s %s %s:' % (connection.GetConnectionRemoteAet(), connection.GetConnectionRemoteIp(), connection.GetConnectionCalledAet()))

    # old prototype still available
    # def OnFindLegacy(answers, query, issuerAet, calledAet):
    #     print('Received incoming C-FIND request from %s:' % issuerAet)

    answer = {}
    for i in range(query.GetFindQuerySize()):
        print('  %s (%04x,%04x) = [%s]' % (query.GetFindQueryTagName(i),
                                           query.GetFindQueryTagGroup(i),
                                           query.GetFindQueryTagElement(i),
                                           query.GetFindQueryValue(i)))

    answers.FindAddAnswer(orthanc.CreateDicom(
        json.dumps(answer), None, orthanc.CreateDicomFlags.NONE))

orthanc.RegisterFindCallback2(OnFind)        # new from v 7.0
#orthanc.RegisterFindCallback(OnFindLegacy)  # old version, still available
```

--------------------------------

### Basic Serve Folders Configuration

Source: https://orthanc.uclouvain.be/book/plugins/serve-folders.html

Configure the ServeFolders plugin to map a local folder to a URI. Ensure the plugin is loaded in the 'Plugins' section.

```json
{
  "Plugins" : [
    "."
  ],
  "ServeFolders" : {
    "/fosdem" : "/home/jodogne/WWW/fosdem"
  }
}
```

--------------------------------

### Install Orthanc init script

Source: https://orthanc.uclouvain.be/book/faq/debian-daemon.html

Moves the Orthanc init script to the correct directory, sets ownership, and makes it executable. This is for older Debian/Ubuntu systems.

```bash
$ sudo mv orthanc.init /etc/init.d/orthanc
$ sudo chown root:root /etc/init.d/orthanc
$ sudo chmod 755 /etc/init.d/orthanc
```

--------------------------------

### Start Orthanc Service on Debian

Source: https://orthanc.uclouvain.be/book/faq/log.html

Use this command to start the Orthanc service on Debian-based Linux systems.

```bash
$ sudo /etc/init.d/orthanc start

```

--------------------------------

### Orthanc startup log with PostgreSQL plugins

Source: https://orthanc.uclouvain.be/book/plugins/postgresql.html

Expected log output when starting Orthanc with the PostgreSQL index and storage plugins. Shows plugin registration and confirmation that PostgreSQL is used for both index and storage.

```text
$ ./Orthanc Configuration.json
W0212 16:30:34.576972 11285 main.cpp:632] Orthanc version: 0.8.6
W0212 16:30:34.577386 11285 OrthancInitialization.cpp:80] Using the configuration from: Configuration.json
[...]
W0212 16:30:34.598053 11285 main.cpp:379] Registering a plugin from: /home/jodogne/Subversion/orthanc-databases/BuildPostgreSQL/libOrthancPostgreSQLIndex.so
W0212 16:30:34.598470 11285 PluginsManager.cpp:258] Registering plugin 'postgresql-index' (version 1.0)
W0212 16:30:34.598491 11285 PluginsManager.cpp:148] Using PostgreSQL index
W0212 16:30:34.608289 11285 main.cpp:379] Registering a plugin from: /home/jodogne/Subversion/orthanc-databases/BuildPostgreSQL/libOrthancPostgreSQLStorage.so
W0212 16:30:34.608916 11285 PluginsManager.cpp:258] Registering plugin 'postgresql-storage' (version 1.0)
W0212 16:30:34.608947 11285 PluginsManager.cpp:148] Using PostgreSQL storage area
[...]
W0212 16:30:34.674648 11285 main.cpp:530] Orthanc has started
```

--------------------------------

### Command-line Tools Help

Source: https://orthanc.uclouvain.be/book/plugins/wsi.html

These commands display the help information for the OrthancWSIDicomizer and OrthancWSIDicomToTiff command-line tools, detailing their available options.

```bash
$ ./OrthancWSIDicomizer --help

```

```bash
$ ./OrthancWSIDicomToTiff --help

```

--------------------------------

### Start Orthanc systemd service

Source: https://orthanc.uclouvain.be/book/faq/debian-daemon.html

Reloads the systemd manager configuration and starts the Orthanc service. This is for systems using systemd.

```bash
$ sudo systemctl daemon-reload
$ sudo systemctl start orthanc.service
```

--------------------------------

### Configure GoogleCloudStorage plugin

Source: https://orthanc.uclouvain.be/book/plugins/object-storage.html

Sample configuration for the Google Cloud Storage plugin. Requires a service account file and a bucket name. Other options are documented in the referenced sections.

```json
"GoogleCloudStorage" : {
  "ServiceAccountFile": "/path/to/googleServiceAccountFile.json",
  "BucketName": "test-orthanc-storage-plugin",
  "RootPath": "",                           // see below
  "MigrationFromFileSystemEnabled": false,  // see below
  "StorageStructure": "flat",               // see below
  "EnableLegacyUnknownFiles": true,         // optional: see below
  "StorageEncryption" : {},                 // optional: see the section related to encryption
  "HybridMode": "Disabled"                  // optional: see the section related to Hybrid storage
}
```

--------------------------------

### Example Resource Access Request

Source: https://orthanc.uclouvain.be/book/plugins/authorization.html

This is an example of a cURL request a user might make to access a DICOM resource through Orthanc.

```bash
curl -H "auth-token-header: my-super-safe-resource-token" http://localhost:8042/patients/6eeded74-75005003-c3ae9738-d4a06a4f-6beedeb8

```

--------------------------------

### Configure Housekeeper Plugin

Source: https://orthanc.uclouvain.be/book/plugins/housekeeper.html

Sample configuration for the Housekeeper plugin, including enabling/disabling, global property ID, force execution, reconstruction options, throttling, scheduling, and triggers. Default values are provided.

```json
{
  "Housekeeper": {

    // Enables/disables the plugin
    "Enable": false,

    // the Global Prooperty ID in which the plugin progress
    // is stored.  Must be > 1024 and must not be used by
    // another plugin
    "GlobalPropertyId": 1025,

    // Forces execution even if the plugin did not detect
    // any changes in configuration
    "Force": false,

    // New in 1.12.9
    // If "Force" is set to true, forces the "ReconstructFiles"
    // option when reconstructing resources even if the plugin
    // did not detect any changes in the configuration that
    // should trigger a Reconstruct.
    "ForceReconstructFiles": false,

    // Delay (in seconds) between reconstruction of 2 studies
    // This avoids overloading Orthanc with the housekeeping
    // process and leaves room for other operations.
    "ThrottleDelay": 5,

    // Runs the plugin only at certain period of time.
    // If not specified, the plugin runs all the time
    // Examples:
    // to run between 0AM and 6AM everyday + every night
    // from 8PM to 12PM and 24h a day on the weekend:
    // "Schedule": {
    //   "Monday": ["0-6", "20-24"],
    //   "Tuesday": ["0-6", "20-24"],
    //   "Wednesday": ["0-6", "20-24"],
    //   "Thursday": ["0-6", "20-24"],
    //   "Friday": ["0-6", "20-24"],
    //   "Saturday": ["0-24"],
    //   "Sunday": ["0-24"]
    // },

    // configure events that can trigger a housekeeping processing
    "Triggers" : {
      "StorageCompressionChange": true,
      "MainDicomTagsChange": true,
      "UnnecessaryDicomAsJsonFiles": true,
      "IngestTranscodingChange": true,
      "DicomWebCacheChange": true   // new in 1.12.2
    },

    // When rebuilding MainDicomTags, limit to a single level of resource
    // which can greatly improve performances e.g. if you have only updated
    // the Study level ExtraMainDicomTags.
    // Allowed values: "Patient", "Study", "Series", "Instance", "All"
    "LimitMainDicomTagsReconstructLevel": "All"

  }
}
```

--------------------------------

### Run wsgidav server and log output

Source: https://orthanc.uclouvain.be/book/users/webdav.html

Starts the wsgidav server with anonymous authentication, listening on all interfaces and port 8042, logging verbose output to both the console and a file. Connect your WebDAV client to http://localhost:8042/ and perform operations.

```bash
$ wsgidav -v -v --auth anonymous --host=0.0.0.0 --port=8042 --root=/tmp/webdav/ | tee /tmp/wsgidav.log
```

--------------------------------

### findscu C-Find Response Example

Source: https://orthanc.uclouvain.be/book/plugins/worklists-plugin.html

This is an example of the output you might expect from a successful `findscu` C-Find request, showing the retrieved AccessionNumbers.

```text
W: ---------------------------
W: Find Response: 1 (Pending)
W:
W: # Dicom-Data-Set
W: # Used TransferSyntax: Little Endian Explicit
W: (0008,0005) CS [ISO_IR 100]                             #  10, 1 SpecificCharacterSet
W: (0008,0050) SH [**********]                             #  10, 1 AccessionNumber
W:


```

--------------------------------

### Sample Configuration for Extrapolate Mode

Source: https://orthanc.uclouvain.be/book/plugins/dicomweb.html

This configuration sample demonstrates how to set up the `Extrapolate` mode for WADO-RS Retrieve Metadata, including specifying tags for studies and series.

```json
{
  "[...]": "[...]",
  "DicomWeb" : {
    "[...]": "[...]",
    "StudiesMetadata" : "Extrapolate",
    "StudiesMetadataExtrapolatedTags" : [
      "AcquisitionDate"
    ],
    "SeriesMetadata" : "Extrapolate",
    "SeriesMetadataExtrapolatedTags" : [
      "BitsAllocated",
      "BitsStored",
      "Columns",
      "HighBit",
      "PhotometricInterpretation",
      "PixelSpacing",
      "PlanarConfiguration",
      "RescaleIntercept",
      "RescaleSlope",
      "Rows",
      "SOPClassUID",
      "SamplesPerPixel",
      "SliceThickness"
    ]
  }
}
```

--------------------------------

### Orthanc-Python image conversion example

Source: https://orthanc.uclouvain.be/book/plugins/python.html

Full working example using PIL/Pillow to decode a DICOM frame, modify it, and upload as a new DICOM instance.

```python
import json
import PIL.Image
import PIL.ImageDraw
import orthanc

URL = 'https://orthanc.uclouvain.be/hg/orthanc-tests/raw-file/Orthanc-1.11.0/Database/LenaTwiceWithFragments.dcm'
USERNAME = ''
PASSWORD = ''

def OnChange(changeType, level, resource):
    if changeType == orthanc.ChangeType.ORTHANC_STARTED:

        # (1) Download a sample DICOM instance and decode it
        orthanc.LogWarning('Downloading: %s' % URL)
        lena = orthanc.HttpGet(URL, USERNAME, PASSWORD)

        # (2) Access the first frame of the instance as a PIL image
        frame = dicom.GetInstanceDecodedFrame()

        # (3) Modify the image using PIL
        draw = PIL.ImageDraw.Draw(frame)
        draw.rectangle([0, 0, 100, 100], fill='red')

        # (4) Convert the PIL image back to an Orthanc image
        a = orthanc.CreateImageFromBuffer(frame.tobytes())

        # (5) Create and upload a new DICOM instance with the modified frame
        tags = {
            'SOPClassUID' : '1.2.840.10008.5.1.4.1.1.1',
            'PatientID' : 'HELLO',
            'PatientName' : 'WORLD',
        }

        s = orthanc.CreateDicom(json.dumps(tags), a, orthanc.CreateDicomFlags.NONE)
        orthanc.RestApiPost('/instances', s)

orthanc.RegisterOnChangeCallback(OnChange)
```

--------------------------------

### Set environment variable and verify system info

Source: https://orthanc.uclouvain.be/book/users/configuration.html

Sets the `ORTHANC_NAME` environment variable to `Hello`, starts Orthanc, and queries the `/system` endpoint to confirm the `Name` is set to `Hello`.

```bash
$ ORTHANC_NAME=Hello ./Orthanc Configuration.json
$ curl http://localhost:8042/system
{
  "Name" : "Hello",
  [...]
}

```

--------------------------------

### Start Orthanc with Specific Log Levels

Source: https://orthanc.uclouvain.be/book/faq/log.html

Use command-line flags to set initial log levels for specific categories when starting Orthanc. This is useful for debugging particular subsystems.

```bash
$ ./Orthanc --verbose-http --trace-dicom
```

--------------------------------

### Configure DICOMweb Server with PKCS#11

Source: https://orthanc.uclouvain.be/book/plugins/dicomweb.html

Enable PKCS#11 support for client authentication with hardware security modules or smart cards. This requires the core to be compiled with -DENABLE_PKCS11=ON and a proper Pkcs11 section in the configuration.

```json
{
  [...] 
  "DicomWeb" : {
    "Servers" : {
      "sample" : {
        "Url" : "http://192.168.1.1/dicomweb/",
        "Pkcs11" : true
      }
    }
  }
}
```

--------------------------------

### Configure Orthanc to use VolView Plugin

Source: https://orthanc.uclouvain.be/book/plugins/volview.html

Minimal sample configuration for Orthanc to load the VolView plugin. Ensure the path to the shared library is correct.

```json
{
  "Plugins" : [
    "/home/user/OrthancVolView/Build/libOrthancVolView.so"
  ]
}

```

--------------------------------

### Start Orthanc with Verbose Logging on Debian

Source: https://orthanc.uclouvain.be/book/faq/log.html

Manually start Orthanc as the 'orthanc' user with the --verbose flag and redirect output to 'Orthanc.log'. This uses the specified configuration directory.

```bash
$ sudo -u orthanc /usr/sbin/Orthanc --verbose /etc/orthanc/ > Orthanc.log 2>&1

```
Tokens:
Raw