Skip to content

Commit cbbfa8e

Browse files
authored
Merge pull request #63 from datasharingframework/install-plugins
Customise the install plugins website
2 parents b63faa6 + 5548da5 commit cbbfa8e

File tree

1 file changed

+46
-11
lines changed

1 file changed

+46
-11
lines changed

docs/src/v1.5.2/maintain/install-plugins.md

Lines changed: 46 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,54 @@ title: Install Plugins
33
icon: plugin
44
---
55

6-
You can find an overview of compatible process plugins below.
6+
::: tip Marketplace for process plugins
7+
To install and learn more about each Process Plugin, you can visit the Marketplace [here](https://hub.dsf.dev/).
8+
:::
79

8-
## Common processes
910

10-
- Ping-Pong: https://github.com/datasharingframework/dsf-process-ping-pong/releases
11-
- AllowList Download: https://github.com/datasharingframework/dsf-process-allow-list/releases
11+
## **Overview**
12+
- You can find an overview of compatable process plugins below (last updated 25/07/2024).
1213

13-
## MII processes
1414

15-
- Feasibility: https://github.com/medizininformatik-initiative/mii-process-feasibility/releases
16-
- KDS-Report: https://github.com/medizininformatik-initiative/mii-process-report/releases
17-
- MII-Data-Sharing: https://github.com/medizininformatik-initiative/mii-process-data-sharing/releases
18-
- MII-Data-Transfer: https://github.com/medizininformatik-initiative/mii-process-data-transfer/releases
15+
| Process Plugin | released for test | released for production |
16+
| ------------------------- | ----------------------------- | ----------------------------- |
17+
| [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) |
18+
| [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) |
19+
| [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) |
20+
| [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) |
21+
| [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) |
22+
| [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) |
23+
| [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) |
1924

20-
## NUM processes
21-
- NUM-RDP: https://github.com/num-codex/codex-processes-ap1/releases
25+
26+
- Explore and install Process Plugins in the Marketplace. Details on each plugin are available [here](https://hub.dsf.dev/).
27+
- Deploying the process plugin to the DSF involves copy the process jar-file and configuring environment variable for the business process engine (BPE).
28+
29+
30+
### Prerequisites
31+
- A DSF installation of version 1.0.0 or higher. An installation guide can be found [here](https://dsf.dev/stable/maintain/install.html).
32+
33+
### Deployment
34+
- Add the process jar-file to the DSF BPE folder `/opt/bpe/process`:
35+
```
36+
wget (your jar-file download link)
37+
```
38+
39+
For example:
40+
```
41+
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
42+
```
43+
44+
- Make sure the process is readable by the bpe user or group, for example by executing:
45+
```
46+
sudo chmod 440 (your jar-file name.jar)
47+
sudo chown root:bpe (your jar-file name.jar)
48+
```
49+
For example:
50+
```
51+
sudo chmod 440 mii-process-data-sharing-1.0.0.1.jar
52+
sudo chown root:bpe mii-process-data-sharing-1.0.0.1.jar
53+
```
54+
55+
- Modify the process exclude config in `/opt/bpe/docker-compose.yml`
56+
- **Reminder:** Check required configurations in `docker-compose.yml`

0 commit comments

Comments
 (0)