UNPKG

@5minds/processcube_engine

Version:

The ProcessCube Engine. Stores and executes BPMNs.

github.com/5minds/ProcessCube.Engine

5minds/ProcessCube.Engine

98 lines (61 loc) • 3.15 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
# 5Minds Engine Die 5Minds Engine ist eine Stand-alone Anwendung, die für das Ausführen der mit dem ProcessCube Studio modellierten Prozesse zuständig ist. Sie kann entweder als globales NPM Paket, oder als Docker Container verwendet werden. Ausführliche Anwendungsbeispiele finden sich [auf processcube.io](https://processcube.io/docs/engine). ## Voraussetzungen - Minimal benötigte NodeJS Version: >= `v20.9.0` - Empfohlene NodeJS Version: >= `v22.17.0` - Auf Windows Systemen: Die [Windows Build Tools](https://www.npmjs.com/package/windows-build-tools) - Eine laufende Authority - Die Engine verwendet diese Authority zur Benutzerauthentifizierung - Derzeit unterstützte DBMS sind: - MS SQL Server - PostgreSQL - SQLite Falls PostgreSQL oder MS SQL Server als Datenbank verwendet werden, muss eine entsprechende Instanz erreichbar sein. ## Beispiele und Dokumentation Ausführliche Beispiele und Dokumentationen finden sich auf [processcube.io](https://processcube.io) ## Schnellstart mit NPM Installation: ```bash npm install -g @5minds/processcube_engine ``` Starten: ```bash processcube-engine ``` Die Engine ist nun unter `http://localhost:10560` erreichbar. Über den Browser ist auf diesem Wege eine vollumfängliche Dokumentation der Engine API verfügbar. **Hinweis:** Falls der Befehl `processcube-engine` unter Windows nicht funktioniert, bitte sicherstellen, dass `PATH` korrekt gesetzt wurde. Auch muss die Command Shell mit Administratorrechten gestartet werden. ## Schnellstart mit Docker Ein Docker Image ist auf [Dockerhub](https://hub.docker.com/repository/docker/5minds/processcube_engine) verfügbar. Zum schnellen Starten eines Containers kann folgender Befehl genutzt werden: ```shell docker run -p 10560:80 5minds/processcube_engine ``` Sollte das Image noch nicht lokal vorhanden sein, wird es vorher heruntergeladen. Weitere Infos zur Verwendung mit Docker: - [Installationsanleitung](https://processcube.io/docs/engine/installation) - [Erste Schritte](https://processcube.io/docs/engine/first_steps) ## Konfiguration Standardmäßig nutzt die Engine die [interne SQLite Konfiguration](./configs/sqlite.json). Eine eigene Konfigurationsdatei kann mit der Umgebungsvariable `CONFIG_PATH` gesetzt werden. Beispiel: ```bash CONFIG_PATH=/<path_to_configfile>/<filename>.json processcube-engine ``` Eine ausführliche Anleitung findet sich in unserer [Konfigurationsanleitung](https://processcube.io/docs/engine/configuration). Auch ist ein Set an [Beispielkonfigurationen verfügbar](./configs/). ## Arbeitsverzeichnis Die Engine speichert ihre lokalen Dateien in folgendem Verzeichnis: | Platform | Folder Path | | -------- | ----------------------------------------- | | macOS | `/Users/<Username>/.processcube/engine` | | Linux | `/home/<Username>/.processcube/engine` | | Windows | `c:\Users\<Username>\.processcube\engine` | Die per Default verwendete SQLite Datenbank befindet sich an diesem Ort. ## Ansprechpartner 1. [Christian Werner](mailto:christian.werner@5minds.de) 1. [Sebastian Griesa](mailto:sebastian.griesa@5minds.de)