Scroll to navigation

ORTHANC(8) System Administration Utilities ORTHANC(8)

NAME

Orthanc - Lightweight, RESTful DICOM server for healthcare and medical research

SYNOPSIS

Orthanc [OPTION]... [CONFIGURATION]

DESCRIPTION

Orthanc, lightweight, RESTful DICOM server for healthcare and medical research.

The "CONFIGURATION" argument can be a single file or a directory. In the case of a directory, all the JSON files it contains will be merged. If no configuration path is given on the command line, a set of default parameters is used. Please refer to the Orthanc Book for the full instructions about how to use Orthanc <https://orthanc.uclouvain.be/book/>.

Pay attention to the fact that the order of the options is important. Options are read left to right. In particular, options such as "--verbose" can reset the value of other log-related options that were read before.

The recommended set of options to debug DICOM communications is "--verbose --trace-dicom --logfile=dicom.log"

Command-line options:

display this help and exit
directory where to store the log files (by default, the log is dumped to stderr)
file where to store the log of Orthanc (by default, the log is dumped to stderr)
create a sample configuration file and exit (if "file" is "-", dumps to stdout)
print the supported error codes and exit
be verbose in logs
highest verbosity in logs (for debug)
allow Orthanc to upgrade the version of the database (beware that the database will become incompatible with former versions of Orthanc)
don't restart the jobs that were stored during the last execution of Orthanc
write the OpenAPI documentation and exit (if "file" is "-", dumps to stdout)
write the cheat sheet of REST API as CSV and exit (if "file" is "-", dumps to stdout)
output version information and exit

Fine-tuning of log categories:

be verbose in logs of category "generic"
use highest verbosity for logs of category "generic"
be verbose in logs of category "plugins"
use highest verbosity for logs of category "plugins"
be verbose in logs of category "http"
use highest verbosity for logs of category "http"
be verbose in logs of category "sqlite"
use highest verbosity for logs of category "sqlite"
be verbose in logs of category "dicom"

--trace-dicom use highest verbosity for logs of category "dicom"

be verbose in logs of category "jobs"
use highest verbosity for logs of category "jobs"

--verbose-lua be verbose in logs of category "lua"

use highest verbosity for logs of category "lua"

Exit status:

0
if success,
-1
if error (have a look at the logs).

AUTHOR

Written by Sebastien Jodogne <s.jodogne@orthanc-labs.com>

COPYRIGHT

Copyright © 2012-2016 Sebastien Jodogne, Medical Physics Department, University Hospital of Liege (Belgium)
Copyright © 2017-2023 Osimis S.A. (Belgium)
Copyright © 2021-2023 Sebastien Jodogne, ICTEAM UCLouvain (Belgium) Licensing GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.
This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law.

January 2024 Orthanc 1.12.2