Proxy is the part of the Gazelle testbed which is used to capture the messages exchanged between two systems under test. This tool is also bind to the EVSClient in order to validate the messages stored in the Proxy in a very simple way.

As for the other tools, the proxy is an open source project and its sources are available at
You can download the latest gazelle-proxy.ear in nexus;quick~gazelle-proxy.ear

Channel Socket Service (Version 6.0.0 and higher)


The Proxy 6 has externalized the low level operations of the channels in a dedicated service based on Netty 4. This service is called the Channel Socket Service.

This service needs to be installed on the same machine as the Proxy and must be started before the Proxy.

Channel Socket Service is withing the Proxy V17 projects.



  1. Java 17
  2. Maven 3.8.x
  3. Docker
  4. Optional: Mandrel 17 (for native compilation)


  1. Clone the project:
     git clone [PROXY_V17_URL]
  2. Build the project:
     mvn clean install -DskipTests


We can run the Channel Socket Service using the following command:

java -jar proxy-quarkus/target/quarkus-app/quarkus-run.jar 


The Channel Socket Service is configured using JVM properties. The following table describes the properties that can be used to configure the Channel Socket Service.

Variable name Description Example of value
record.service.url The URL used to communicate with record service http://localhost:8380/proxy/rest/items
quarkus.http.port The port of the service 8081
quarkus.log.level The log leve INFO

For more details about the configuration of the Channel Socket Service, please refer to the project

Compilation and installation

Gazelle testbed tools are built using Maven 3, when you have download the sources, go to the gazelle-proxy folder and execute

mvn -P public clean package

You will get an EAR in the gazelle-proxy-ear/target folder.

Then, follow the instructions below:

1. Create database

In your database (postgresql 9.1 or higher) create a database named “gazelle-proxy”, using UTF-8 encoding and owned by the user gazelle

createdb -U gazelle -E UTF8 gazelle-proxy

2. File system

2.1 Version 6.0.0 and higher

For persistent channels, create a file /opt/proxy/proxyPersistentChannels.json and make sure that the user running the application has the right to write in it. On your file system, create a directory /opt/proxy/DICOM.

sudo mkdir -p /opt/proxy/DICOM
sudo touch /opt/proxy/proxyPersistentChannels.json
sudo chown -R jboss:jboss-admin /opt/proxy
sudo chmod -R 775 /opt/proxy

2.2 Version 5.0.0 and lower

For persistent channels, create a file /opt/proxy/proxyPersistentChannels.csv and make sure that the user running the application has the right to write in it. On your file system, create a directory /opt/proxy/DICOM.

sudo mkdir -p /opt/proxy/DICOM
sudo touch /opt/proxy/proxyPersistentChannels.csv
sudo chown -R jboss:jboss-admin /opt/proxy
sudo chmod -R 775 /opt/proxy

3. Put the ear in the deployment folder of your Jboss AS

cp gazelle-proxy-ear/target/gazelle-proxy.ear /usr/local/jboss7/standalone/deployments/gazelle-proxy.ear

4. Manage datasource

[WARNING] : From version 4.7.0, datasources have been extracted from the ear. The template file can be found in /src/main/application/datasource in the source or in the file from the nexus. For more information about how to manage that externalization, please refer to general considerations for JBoss7.

  • Datasource name : gazelle-proxyDS

  • Database name : gazelle-proxy

5. Configure SSO registration

Since version 5.1.0, Proxy can register itself as a client of a SSO server. This is done by giving some environment variables to the application.

Variable name Description Example of value
GZL_PROXY_K8S_ID Describes the instance ID and the replica ID of the application. gazelle-proxy-6dfeeb5595-tl29k

[WARNING] There are additional required variables for registration of the proxy to the SSO server. Please refer to the in sso-client-v7.

6. Start Jboss AS 7

sudo /etc/init.d/jboss7 start

7. Execute the sql script available in your workspace at gazelle-proxy-ear/src/main/sql/schema-X.X.X.sql

psql -U gazelle gazelle-proxy < schema-X.X.X.sql

8. Execute the sql script available in your workspace at gazelle-proxy-ear/src/main/sql/init-5.0.0.sql

psql -U gazelle gazelle-proxy < init-X.X.X.sql

9. Browse the application

Open a browser and go to http://yourServer:8080/proxy

10. The proxy is now up and running, see the next section for information on the configuration.

This new instance of the proxy is running without the CAS feature, that means that anyone accessing the tool has the administrator privileges.

If you rather want to use a single-sign one authentication, configure the application in this way. Edit the preference cas_enabled to set it to false.

Called tools

Check that dcmtk is installed on the machine. Actually, the proxy uses dcmdump to render the dicom files.

sudo apt get install dcmtk


There is a set of properties that you can configure on the Configuration page, the table below describes the various properties defined and their default values.

Property name Description Default value
application_documentation The link to the user manual. Link to this page  
application_issue_tracker The link to the section of the issue tracker where to report issues about the Gazelle Proxy tool
application_release_notes The link to the application release notes of the tool
application_url The URL used by any user to access the tool. The application needs it to build permanent links inside the tool http://yourASURL/proxy
dcmdump_path Path to dcmdump /usr/bin/dcmdump
evs_client_url The URL of the EVSClient application. This is required to validate the messages captured by the proxy. If you install your own instance of the proxy, you also need your own instance of the EVSClient tool. (Do not forget the tailing slash)
jms_communication_is_enabled Enable jms communication false
max_proxy_port Specifies the high limit for the opened ports 11000
min_proxy_port Specifies the low limit for the opened ports 10000
NUMBER_OF_ITEMS_PER_PAGE Number of items to display in datatable 20
proxy_ip_addresses This property is used to inform the users of the IP address(es) to use to contact the proxy (, (, (, (
proxy_oid For each tool, we need an OID which uniquely identify the instance of the tool and the URL used to send back results.
storage_dicom Absolute path to the system folder used to store the DICOM datasets /opt/proxy/DICOM
time_zone The time zone used to display the timestamps Europe/Paris
admin_only_mode This preference is used to enable/disable the Admin Only mode. This mode restricts the access to messages list and messages details to admin only. Connection can however be shared by an administrator to allow users knowing the connection privacy key to see messages from the connection. false
proxy_persistent_channels_file_path This file path where persistent channels are written. The file must be created by server admin /opt/proxy/proxyPersistentChannels.csv

SSO Configuration

There are additional preferences to configure the SSO authentication.

Preference name Description Example of value
cas_enabled Enable or disable the CAS authentication. true
ip_login Enable authentication by IP address matching ip_login_admin regex. false
ip_login_admin Regex to authorize ip authentication if CAS authentication is disabled. .*

For more documentation about SSO configurations, follow the link here.