From 324589e948ee3c9be36d84a115677bb7f674d22b Mon Sep 17 00:00:00 2001 From: Mohammad Amir Kannout Date: Mon, 29 Jul 2024 15:05:04 +0200 Subject: [PATCH 1/2] Changes to the install plugins website --- docs/src/v1.5.2/maintain/install-plugins.md | 54 ++++++++++++++++----- 1 file changed, 43 insertions(+), 11 deletions(-) diff --git a/docs/src/v1.5.2/maintain/install-plugins.md b/docs/src/v1.5.2/maintain/install-plugins.md index dc15d6c75..40fffb2d4 100644 --- a/docs/src/v1.5.2/maintain/install-plugins.md +++ b/docs/src/v1.5.2/maintain/install-plugins.md @@ -3,19 +3,51 @@ title: Install Plugins icon: plugin --- -You can find an overview of compatible process plugins below. +::: tip Marketplace for process plugins +To install and learn more about each Process Plugin, you can visit the Marketplace [here](https://hub.dsf.dev/). +::: -## Common processes -- Ping-Pong: https://github.com/datasharingframework/dsf-process-ping-pong/releases -- AllowList Download: https://github.com/datasharingframework/dsf-process-allow-list/releases +## **Overview** +- You can find an overview of compatable process plugins below (last updated 25/07/2024). -## MII processes -- Feasibility: https://github.com/medizininformatik-initiative/mii-process-feasibility/releases -- KDS-Report: https://github.com/medizininformatik-initiative/mii-process-report/releases -- MII-Data-Sharing: https://github.com/medizininformatik-initiative/mii-process-data-sharing/releases -- MII-Data-Transfer: https://github.com/medizininformatik-initiative/mii-process-data-transfer/releases +| Process Plugin | released for test | released for production | +| ------------------------- | ----------------------------- | ----------------------------- | +| Ping Pong | [v1.0.1.0](https://github.com/datasharingframework/dsf-process-ping-pong/releases/tag/v1.0.1.0) | [v1.0.1.0](https://github.com/datasharingframework/dsf-process-ping-pong/releases/tag/v1.0.1.0) | +| Allow-List | [v1.0.0.1](https://github.com/datasharingframework/dsf-process-allow-list/releases/tag/v1.0.0.1) | [v1.0.0.1](https://github.com/datasharingframework/dsf-process-allow-list/releases/tag/v1.0.0.1) | +| MII Process Feasibility | [v1.0.0.5](https://github.com/medizininformatik-initiative/mii-process-feasibility/releases/tag/v1.0.0.5) | [v1.0.0.5](https://github.com/medizininformatik-initiative/mii-process-feasibility/releases/tag/v1.0.0.5) | +| MII Process Report | [v1.1.0.1](https://github.com/medizininformatik-initiative/mii-process-report/releases/tag/v1.1.0.1) | [v1.1.0.1](https://github.com/medizininformatik-initiative/mii-process-report/releases/tag/v1.1.0.1) | +| MII Process Data Transfer | [v1.0.0.1](https://github.com/medizininformatik-initiative/mii-process-data-sharing/releases/tag/v1.0.0.1) | [v1.0.0.1](https://github.com/medizininformatik-initiative/mii-process-data-sharing/releases/tag/v1.0.0.1) | +| MII Process Data Sharing | [v1.0.1.0](https://github.com/medizininformatik-initiative/mii-process-data-transfer/releases/tag/v1.0.1.0) | [v1.0.1.0](https://github.com/medizininformatik-initiative/mii-process-data-transfer/releases/tag/v1.0.1.0) | +| RDP Process | [v1.1.0.0](https://github.com/num-codex/codex-processes-ap1/releases/tag/v1.1.0.0) | [v1.0.0.0](https://github.com/num-codex/codex-processes-ap1/releases/tag/v1.0.0.0) | -## NUM processes -- NUM-RDP: https://github.com/num-codex/codex-processes-ap1/releases + +- Deploying the process plugin to the DSF involves copy the process jar-file and configuring environment variable for the business process engine (BPE). + + +### Prerequisites +- A DSF installation of version 1.0.0 or higher. An installation guide can be found [here](https://dsf.dev/stable/maintain/install.html). + +### Deployment +- Add the process jar-file to the DSF BPE folder `/opt/bpe/process` +- Make sure the process is readable by the bpe user or group +- Modify the process exclude config in `/opt/bpe/docker-compose.yml` + + + +## **Releases**: +### Common processes + +- [Ping-Pong](https://github.com/datasharingframework/dsf-process-ping-pong/releases) +- [Allow-List](https://github.com/datasharingframework/dsf-process-allow-list/releases) + +### MII processes + +- [Feasibility](https://github.com/medizininformatik-initiative/mii-process-feasibility/releases) +- [KDS-Report](https://github.com/medizininformatik-initiative/mii-process-report/releases) +- [MII-Data-Sharing](https://github.com/medizininformatik-initiative/mii-process-data-sharing/releases) +- [MII-Data-Transfer](https://github.com/medizininformatik-initiative/mii-process-data-transfer/releases) + +### NUM processes +- [NUM-RDP](https://github.com/num-codex/codex-processes-ap1/releases) \ No newline at end of file From 5548da5ee2c3f8ce8b576aace284db036f17fd32 Mon Sep 17 00:00:00 2001 From: Mohammad Amir Kannout Date: Mon, 29 Jul 2024 16:55:04 +0200 Subject: [PATCH 2/2] changes_1 --- docs/src/v1.5.2/maintain/install-plugins.md | 57 +++++++++++---------- 1 file changed, 30 insertions(+), 27 deletions(-) diff --git a/docs/src/v1.5.2/maintain/install-plugins.md b/docs/src/v1.5.2/maintain/install-plugins.md index 40fffb2d4..506ec2106 100644 --- a/docs/src/v1.5.2/maintain/install-plugins.md +++ b/docs/src/v1.5.2/maintain/install-plugins.md @@ -14,15 +14,16 @@ To install and learn more about each Process Plugin, you can visit the Marketpla | Process Plugin | released for test | released for production | | ------------------------- | ----------------------------- | ----------------------------- | -| Ping Pong | [v1.0.1.0](https://github.com/datasharingframework/dsf-process-ping-pong/releases/tag/v1.0.1.0) | [v1.0.1.0](https://github.com/datasharingframework/dsf-process-ping-pong/releases/tag/v1.0.1.0) | -| Allow-List | [v1.0.0.1](https://github.com/datasharingframework/dsf-process-allow-list/releases/tag/v1.0.0.1) | [v1.0.0.1](https://github.com/datasharingframework/dsf-process-allow-list/releases/tag/v1.0.0.1) | -| MII Process Feasibility | [v1.0.0.5](https://github.com/medizininformatik-initiative/mii-process-feasibility/releases/tag/v1.0.0.5) | [v1.0.0.5](https://github.com/medizininformatik-initiative/mii-process-feasibility/releases/tag/v1.0.0.5) | -| MII Process Report | [v1.1.0.1](https://github.com/medizininformatik-initiative/mii-process-report/releases/tag/v1.1.0.1) | [v1.1.0.1](https://github.com/medizininformatik-initiative/mii-process-report/releases/tag/v1.1.0.1) | -| MII Process Data Transfer | [v1.0.0.1](https://github.com/medizininformatik-initiative/mii-process-data-sharing/releases/tag/v1.0.0.1) | [v1.0.0.1](https://github.com/medizininformatik-initiative/mii-process-data-sharing/releases/tag/v1.0.0.1) | -| MII Process Data Sharing | [v1.0.1.0](https://github.com/medizininformatik-initiative/mii-process-data-transfer/releases/tag/v1.0.1.0) | [v1.0.1.0](https://github.com/medizininformatik-initiative/mii-process-data-transfer/releases/tag/v1.0.1.0) | -| RDP Process | [v1.1.0.0](https://github.com/num-codex/codex-processes-ap1/releases/tag/v1.1.0.0) | [v1.0.0.0](https://github.com/num-codex/codex-processes-ap1/releases/tag/v1.0.0.0) | +| [Ping-Pong](https://github.com/datasharingframework/dsf-process-ping-pong/releases) | [v1.0.1.0](https://github.com/datasharingframework/dsf-process-ping-pong/releases/tag/v1.0.1.0) | [v1.0.1.0](https://github.com/datasharingframework/dsf-process-ping-pong/releases/tag/v1.0.1.0) | +| [Allow-List](https://github.com/datasharingframework/dsf-process-allow-list/releases) | [v1.0.0.1](https://github.com/datasharingframework/dsf-process-allow-list/releases/tag/v1.0.0.1) | [v1.0.0.1](https://github.com/datasharingframework/dsf-process-allow-list/releases/tag/v1.0.0.1) | +| [MII Process Feasibility](https://github.com/medizininformatik-initiative/mii-process-feasibility/releases) | [v1.0.0.5](https://github.com/medizininformatik-initiative/mii-process-feasibility/releases/tag/v1.0.0.5) | [v1.0.0.5](https://github.com/medizininformatik-initiative/mii-process-feasibility/releases/tag/v1.0.0.5) | +| [MII Process Report](https://github.com/medizininformatik-initiative/mii-process-report/releases) | [v1.1.0.1](https://github.com/medizininformatik-initiative/mii-process-report/releases/tag/v1.1.0.1) | [v1.1.0.1](https://github.com/medizininformatik-initiative/mii-process-report/releases/tag/v1.1.0.1) | +| [MII Process Data Transfer](https://github.com/medizininformatik-initiative/mii-process-data-transfer/releases) | [v1.0.0.1](https://github.com/medizininformatik-initiative/mii-process-data-sharing/releases/tag/v1.0.0.1) | [v1.0.0.1](https://github.com/medizininformatik-initiative/mii-process-data-sharing/releases/tag/v1.0.0.1) | +| [MII Process Data Sharing](https://github.com/medizininformatik-initiative/mii-process-data-sharing/releases) | [v1.0.1.0](https://github.com/medizininformatik-initiative/mii-process-data-transfer/releases/tag/v1.0.1.0) | [v1.0.1.0](https://github.com/medizininformatik-initiative/mii-process-data-transfer/releases/tag/v1.0.1.0) | +| [NUM-RDP](https://github.com/num-codex/codex-processes-ap1/releases) | [v1.1.0.0](https://github.com/num-codex/codex-processes-ap1/releases/tag/v1.1.0.0) | [v1.0.0.0](https://github.com/num-codex/codex-processes-ap1/releases/tag/v1.0.0.0) | +- Explore and install Process Plugins in the Marketplace. Details on each plugin are available [here](https://hub.dsf.dev/). - Deploying the process plugin to the DSF involves copy the process jar-file and configuring environment variable for the business process engine (BPE). @@ -30,24 +31,26 @@ To install and learn more about each Process Plugin, you can visit the Marketpla - A DSF installation of version 1.0.0 or higher. An installation guide can be found [here](https://dsf.dev/stable/maintain/install.html). ### Deployment -- Add the process jar-file to the DSF BPE folder `/opt/bpe/process` -- Make sure the process is readable by the bpe user or group -- Modify the process exclude config in `/opt/bpe/docker-compose.yml` - - - -## **Releases**: -### Common processes +- Add the process jar-file to the DSF BPE folder `/opt/bpe/process`: +``` +wget (your jar-file download link) +``` + +For example: +``` + wget https://github.com/medizininformatik-initiative/mii-process-data-sharing/releases/download/v1.0.0.1/mii-process-data-sharing-1.0.0.1.jar +``` + +- Make sure the process is readable by the bpe user or group, for example by executing: +``` +sudo chmod 440 (your jar-file name.jar) +sudo chown root:bpe (your jar-file name.jar) +``` +For example: +``` +sudo chmod 440 mii-process-data-sharing-1.0.0.1.jar +sudo chown root:bpe mii-process-data-sharing-1.0.0.1.jar +``` -- [Ping-Pong](https://github.com/datasharingframework/dsf-process-ping-pong/releases) -- [Allow-List](https://github.com/datasharingframework/dsf-process-allow-list/releases) - -### MII processes - -- [Feasibility](https://github.com/medizininformatik-initiative/mii-process-feasibility/releases) -- [KDS-Report](https://github.com/medizininformatik-initiative/mii-process-report/releases) -- [MII-Data-Sharing](https://github.com/medizininformatik-initiative/mii-process-data-sharing/releases) -- [MII-Data-Transfer](https://github.com/medizininformatik-initiative/mii-process-data-transfer/releases) - -### NUM processes -- [NUM-RDP](https://github.com/num-codex/codex-processes-ap1/releases) \ No newline at end of file +- Modify the process exclude config in `/opt/bpe/docker-compose.yml` +- **Reminder:** Check required configurations in `docker-compose.yml` \ No newline at end of file