Installing DICOM DS

Downloading the Installer

DICOM DS is designed to run on Windows, as a Windows service. The following links allow you to download the latest Windows installer (recommended) and jar for DICOM DS.

For previous versions of DICOM DS, please see the Release Notes.

Using the Installer

  1. Download and run the installer as an administrator. Please note that you may receive a message asking you to confirm whether you wish to allow the installer executable to run. In order to use the installer, you will need to press Yes.
  2. Once the installer starts, you will be brought to a welcome screen reminding you that a recent version of the Java is required. Once you're ready to continue, press the Next button.
  3. The next screen allows you to choose which components to install. DICOM DS Core component consists of the entire application package and is required. Install as a Service is an optional component. When checked, the installer will install DICOM DS Core and then install and run DICOM DS as a Windows Service.

    Once you've made your selections, press the Install button.

  4. The installation page will show the progress of the install for the components selected in step 3. Once complete, the installation will automatically progress to the next page.
  5. The last page will confirm that the install is complete. Click on the Configure DICOM DS link to open the DICOM Management Console in your default web browser.

    Press Finish to close the installer.

What is the installer actually doing during the install phase?

  • Installs the application JAR file, the uninstaller, and YAJSW library files in the DICOM DS directory in your program files directory (e.g., C:\Program Files (x86)\DICOM DS)
  • Sets up supporting application directories for storing your service configurations and logs (e.g. C:\Program Data\DICOM DS).
  • Registers the uninstaller so that the application may be located and uninstalled from your Control Panel.

Command Line Options

The recommended way to run DICOM DS is as a service and installed using the method described above. Alternatively, you may download the jar file and provide customized options to start DICOM DS.

java -Dhttp.port=<port> -DLOGS_DIR=<log_directory> -DCONFIGS_DIR=<configuration_directory> -DLOG_MAX_HISTORY=<max_log_files> -DLOG_MAX_FILE_SIZE=<max_log_file_size> -DLOG_TOTAL_SIZE_CAP=<max_total_log_file_size> -Djava.net.useSystemProxies=true -Dpidfile.path=/dev/null -Dplay.http.secret.key="{secret_key}" -jar C:\example\path\to\dicom-ds.jar
Argument Required Default Description
-Dhttp.port yes   The port number that the application listens on for HTTP requests from the user interface.
-DLOGS_DIR no ${user.home}/.proknow/dicom-ds/logs where ${user.home} is the user's home directory and is system dependent The directory in which to store the application logs. We recommend this to be a subdirectory of the -DCONFIGS_DIR.
-DCONFIGS_DIR no ${user.home}/.proknow/dicom-ds where ${user.home} is the user's home directory and is system dependent The directory in which to store the application configurations.
-DLOG_MAX_HISTORY no 30 The maximum number of days for which to retain log files. Fewer days of log files may be retained, if necessary, to respect the LOG_TOTAL_SIZE_CAP.
-DLOG_MAX_FILE_SIZE no 10MB The maximum log file size, e.g. 10MB or 1GB. Note that there is no space between the integer scalar and the units. This is an approximation +/- 10% due to buffering and threading. Once the application logfile (app.log) reaches this size, it will be renamed to app-yyyy-MM-dd.i.log where yyyy-MM-dd is the current date and i is an index that increments from 0. A new app.log file will then be created and become the current logfile.
-DLOG_TOTAL_SIZE_CAP no 1GB The maximum total size of all log files, e.g., 512MB or 2GB. Note that there is no space between the integer scalar and the unit. Older log files will be deleted to prevent exceeding this size.
-Djava.net.useSystemProxies yes   The flag indicating whether the application should use system proxies. Please set this value to true.
-Dpidfile.path yes   The path for the application process ID (PID) file. Please set this value to Nul so that no process ID file is created.
-Dplay.http.secret.key yes   A secret key that is used for signing session cookies and CSRF tokens as well as for built-in encryption utilities. The key needs to be at least 32 bytes of random input and can be generated with a command such as:
head -c 32 /dev/urandom | base64
-jar yes   The file path to the DICOM DS jar file
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

0 comments

Article is closed for comments.