View on GitHub

Resources for Dicoogle users and developers.


In this page, we will have an instance of Dicoogle running on your machine for the first time.

Install Requirements

Before we proceed, make sure that you have an up-to-date version of the Java Virtual Machine. It can be downloaded here, or it can be installed using your typical system package manager. Although Java 7 is still supported, we highly recommend having Java 8 at this time.

Obtain Dicoogle and Plugins

The website has a Downloads section, where you can download Dicoogle and some plugins for free. As an alternative, you can build it from the sources. Once that is done, be sure that you have these three files:

  • The main platform program (“dicoogle.jar”).

  • The index/query plugin file (“lucene.jar”). It is based on Lucene and provides indexing and querying of DICOM meta-data. With this plugin set, it is possible to index nearly all meta-data and perform free text, keyword-based, and range-based queries.

  • The file storage plugin (“filestorage.jar”). It is used for storing and retrieving DICOM files in the local file system. This plugin is necessary in order to use Dicoogle as a complete DICOM storage provider. The core platform provides a fallback implementation which supports reading (but not storing) files from the system.

Set up the Dicoogle Platform

Copy the jar file “dicoogle.jar” to a new folder, where we will deploy Dicoogle. For this example, we will name it “DicoogleDir”.

Installing Plugins

Create a new folder “Plugins” in “DicoogleDir”. This directory will hold the plugins used by our instance of Dicoogle.

A typical deployment of Dicoogle relies on at least two plugins: one for file storage and another one for indexing and querying. Next, copy or move the two plugins, “lucene.jar” and “filestorage.jar”, into the “Plugins” folder.

The Plugins folder is case-sensitive!

Some operating systems such as Windows will actually ignore casing in file names. However, Unix-based systems (Linux, OSX, ...) are sensitive to casing, which means that “Plugins” and “plugins” do not refer to the same file path. You are advised to always name this folder ”Plugins”, with a capital P.

Running Dicoogle

We are now ready to run Dicoogle. The most recommended way is to execute the jar file on a terminal. Open a command line and execute the following command:

java -jar dicoogle.jar -s

The -s flag is optional. Without it, Dicoogle will automatically open your default Internet browser on the web application.

Your Dicoogle server should now be ready for basic usage, which we will address in the next page. In order to stop Dicoogle entirely, simply terminate the program by pressing Ctrl + C, or by closing the terminal.