[Deprecated] Gazelle Proxy - Installation & configuration
Warning: This documentation is out-dated, newest version of the documentation is available at https://gazelle.ihe.net/gazelle-documentation/Proxy/installation.html
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 https://scm.gforge.inria.fr/svn/gazelle/Maven/gazelle-proxy/. You can either download the latest tagged version or the current trunk.
Compilation
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.
Installation
You can download the latest gazelle-proxy.ear in nexus http://gazelle.ihe.net/nexus/index.html#nexus-search;quick~gazelle-proxy.ear
/!\ BE CAREFUL /!\
We have ported the proxy to Jboss 7. The Jboss 5 version is maintained for bug fixes, but new features will only be added to the Jboss 7 version. If you are using the Jboss 5 version, use EAR 3.X.X, for Jboss 7 use version 4.0.0 or above.
To Summarize :
- Jboss 5 : from version 0.1 to 3.X.X
- Jboss 7.2.0 (download link): from version 4.0.0 and above
/!\ BE CAREFUL /!\
Then, follow the instructions below:
- In your database (postgresql 8.4 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
- On your file system, create a directory /opt/proxy/DICOM
- Put the ear in the deploy folder of your Jboss AS
- Start Jboss AS
- Execute the sql script available in your workspace at gazelle-proxy-ear/src/main/sql/init.sql
psql -U gazelle gazelle-proxy < init.sql
- Open your favorite browser (we recommand Chrome or Firefox) and go to http://yourServer:8080/proxy
- 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 application_works_without_cas 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.
Configuration
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. |
http://gazelle.ihe.net/content/proxy-0 |
application_issue_tracker | The link to the section of the issue tracker where to report issues about the Gazelle Proxy tool | http://gazelle.ihe.net/jra/browse/PROXY |
application_release_notes | The link to the application release notes of the tool | http://gazelle.ihe.net/jira... |
application_works_without_cas | Specifies if the CAS should be used or not, if no CAS is used, property shall be set to true otherwise, it's set to false | true |
application_url | The URL used by any user to access the tool. The application needs it to build permanent links inside the tool | http://localhost:8080/proxy |
cas_url | If you intent to use a CAS, put its URL here | https://gazelle.ihe.net/cas |
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) | http://gazelle.ihe.net/EVSClient/ |
ip_login | if the application is not linked to a CAS, you can choose to restraint the access to the administration sections of the application to a subset of IP addresses | false |
ip_login_admin | regex to be matched by IP address of the users granted as admin | .* |
max_proxy_port |
Specifies the high limit for the opened ports |
11000 |
min_proxy_port | Specifies the low limit for the opened ports | 10000 |
proxy_ip_addresses | This property is used to inform the users of the IP address(es) to use to contact the proxy | 131.254.209.16 (kujira.irisa.fr), 131.254.209.17 (kujira1.irisa.fr), 131.254.209.18 (kujira2.irisa.fr), 131.254.209.19 (kujira3.irisa.fr) |
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. | 1.1.1.1.1 |
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 |