From 8507fd9f3b83cf0085c543966f3c125e4ea6e5d3 Mon Sep 17 00:00:00 2001 From: Achraf <aai@kereval.com> Date: Mon, 2 Sep 2024 15:53:59 +0200 Subject: [PATCH] Update documentation for Proxy 6.2.5 --- Proxy/installation.md | 26 ++++++++++++++++---------- Proxy/release-note.md | 32 ++++++++++++++++++++++++++++++-- 2 files changed, 46 insertions(+), 12 deletions(-) diff --git a/Proxy/installation.md b/Proxy/installation.md index 2bc6dc6..5b3f893 100755 --- a/Proxy/installation.md +++ b/Proxy/installation.md @@ -2,10 +2,10 @@ title: Installation Manual subtitle: Gazelle Proxy author: Nicolas BAILLIET -date: 18/01/2024 -toolversion: 6.0.0 +date: 02/09/2024 +toolversion: 6.2.5 function: Engineer -version: 2.1 +version: 2.2 status: Approved document reference: KER1-MAN-IHE-PROXY_INSTALLATION-2_01 customer: IHE-EUROPE @@ -62,14 +62,19 @@ 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 | +| **Variable name** | **Description** | **Default value** | +|------------------------------------------------|------------------------------------------------------------------------------------------|-----------------------------------------| +| **datahouse.url** | The URL used to communicate with datahouse, to record messages and connections | http://localhost:8080/datahouse/rest/v1 | +| **quarkus.http.port** | The port of the service | 8081 | +| **quarkus.log.level** | The log level | INFO | +| **proxy.fallback.pipeline.enabled** | Enable/disable fallback record | true | +| **proxy.fallback.record.service.url** | Recording service URL for the fallback pipeline (alternative to datahouse, ex: proxy v7) | http://localhost:8380/proxy/rest | +| **service.ip.address** | Ip of the host machine of proxy. Used in HTTP rewrite | 127.0.0.1 | +| **handler.logger.enabled** | Enable/disable logger handler to log incoming/outgoing messages | false | +| **quarkus.swagger-ui.always-include** | Enable/disable swagger graphical interface | true | +| **quarkus.otel.exporter.otlp.traces.endpoint** | Service URL to export opentelemtry spans, if not set, telemetry will be disabled | http://localhost:4317 | + -For more details about the configuration of the Channel Socket Service, please refer to the -project [README.md](#). # Compilation and installation @@ -201,6 +206,7 @@ There is a set of properties that you can configure on the Configuration page, t | **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 | +| **datahouse_ui_url** | URL to datahouse UI for the new messages list | http://localhost:3000/datahouse-ui | # SSO Configuration diff --git a/Proxy/release-note.md b/Proxy/release-note.md index a18078a..ed48aa9 100755 --- a/Proxy/release-note.md +++ b/Proxy/release-note.md @@ -1,13 +1,41 @@ --- title: Release note subtitle: Proxy -toolversion: 6.1.0 -releasedate: 2024-02-06 +toolversion: 6.2.5 +releasedate: 2024-09-02 author: Anne-Gaëlle BERGE function: Software Engineer customer: IHE Europe reference: KER1-RNO-IHE-Proxy --- + +# 6.2.5 +_Release date: 2024-09-02_ + +__Bug__ +* \[[PROXY-381](https://gazelle.ihe.net/jira/browse/PROXY-381)\] Replace HL7 by HL7v2 +* \[[PROXY-395](https://gazelle.ihe.net/jira/browse/PROXY-395)\] Decoding error: the content displayed is quite weird +* \[[PROXY-397](https://gazelle.ihe.net/jira/browse/PROXY-397)\] Arrow between Initiator and Responder +* \[[PROXY-404](https://gazelle.ihe.net/jira/browse/PROXY-404)\] Memory leaks on proxy-v17 +* \[[PROXY-419](https://gazelle.ihe.net/jira/browse/PROXY-419)\] Calendar filters lack rules + +__Task__ +* \[[PROXY-414](https://gazelle.ihe.net/jira/browse/PROXY-414)\] Decode Dicom dump in the backend +* \[[PROXY-418](https://gazelle.ihe.net/jira/browse/PROXY-418)\] Hl7v2 XML renderer +* \[[PROXY-421](https://gazelle.ihe.net/jira/browse/PROXY-421)\] Proxy decoders should save original message +* \[[PROXY-422](https://gazelle.ihe.net/jira/browse/PROXY-422)\] Make it easier to read the rows of a table +* \[[PROXY-423](https://gazelle.ihe.net/jira/browse/PROXY-423)\] Auto indexes verification +* \[[PROXY-424](https://gazelle.ihe.net/jira/browse/PROXY-424)\] ID for Automation tests +* \[[PROXY-425](https://gazelle.ihe.net/jira/browse/PROXY-425)\] Remove autoscroll +* \[[PROXY-426](https://gazelle.ihe.net/jira/browse/PROXY-426)\] List of messages - 1 line to display timestamp +* \[[PROXY-427](https://gazelle.ihe.net/jira/browse/PROXY-427)\] calendar not fully visible +* \[[PROXY-428](https://gazelle.ihe.net/jira/browse/PROXY-428)\] Calendar - Add a quick picker +* \[[PROXY-449](https://gazelle.ihe.net/jira/browse/PROXY-449)\] Download raw +* \[[PROXY-454](https://gazelle.ihe.net/jira/browse/PROXY-454)\] Replace BETA by NEW + +__Improvement__ +* \[[PROXY-405](https://gazelle.ihe.net/jira/browse/PROXY-405)\] Persist raw content alongside with decoded message + # 6.2.4 _Release date: 2024-06-25_ -- GitLab