@atlas-engine-contrib/atlas-ui_portal-server
v3.13.0
Published
Das 5Minds Portal ist eine React-Applikation zur Steuerung von Benutzerinteraktionen mit der 5Minds Engine.
Downloads
30,416
Keywords
Readme
5Minds Portal
Das 5Minds Portal ist eine React-Applikation zur Steuerung von Benutzerinteraktionen mit der 5Minds Engine.
Was sind die Ziele dieses Projekts?
Das 5Minds Portal erlaubt es Benutzern BPMN-Prozesse auf einer 5Minds Engine zu starten und ManualTasks sowie UserTasks zu bearbeiten.
Wie kann ich das Projekt aufsetzen?
Voraussetzungen
- Node.js
>= 14
- Laufende 5Minds Engine
>= 11.0.0
- Laufende 5Minds Authority (optional)
Setup/Installation
Das Projekt besteht aus zwei Paketen: Der React-Applikation (im Folgenden Frontend genannt) und einem Webserver (im Folgenden Backend genannt), der weitere Dateien wie z.B. die Konfiguration ausliefert und eine API zur Persistierung von CustomForm-Zuständen bereitstellt.
Es müssen die Abhängigkeiten für beide Pakete installiert werden:
npm install && npm --prefix frontend install
Wie kann ich das Projekt benutzen?
Frontend und Backend können gemeinsam mit folgendem Befehl im Entwicklungsmodus gestartet werden:
npm start
Das Frontend kann unter der Adresse http://localhost:13590 erreicht werden. Das Backend verwendet im Entwicklungsmodus
die Konfigurationsdatei config/development.json
und ist unter http://localhost:13591 erreichbar.
Weitere Installationsmethoden
npm
Das 5Minds Portal kann von npmjs bezogen werden:
npm install --global @atlas-engine-contrib/atlas-ui_portal-server
Auf der Kommandozeile steht nun der Befehl portal
bereit.
Ebenfalls sind die CLI-Befehle des Servers unter portal
verfügbar.
Usage: portal [options]
Options:
--version Show version number [boolean]
--application-base-url URL under which the 5Minds Portal should be accessible [string]
--assets Path to a directory which includes assets that are served by the web server [string]
--authority-client-id Public identifier used for authentication [string]
--authority-client-secret Client secret that should be used in the authentication process [string]
--authority-grant-type Grant type that should be used for the authentication process [string]
--authority-response-type Response type that should be used in the authentication process [string]
--authority-scopes Scopes that should be requested in the authentication process [string]
--config Path to a configuration file [deprecated: Use --config-path instead] [string]
--CONFIG_PATH Path to a configuration file [deprecated: Use --config-path instead] [string]
--config-path Path to a configuration file [string]
--custom-forms JSON string that should be used as custom forms configuration [string]
--custom-forms-mode, --custom-form-mode HTTP method to use for retrieving the data in the custom form ("default" equals "get") [string] [choices: "default", "get", "post"]
--custom-forms-url, --custom-form-url URL that should be used for all custom forms [string]
--engine-url URL under which the 5Minds Engine should be accessible [string]
--extensions-dir Path to a directory which includes extensions that should be loaded by the 5Minds Portal [string]
--favicon URL to an image that should be used as the favicon [string]
--languages JSON string that should be used as languages configuration
--logo URL to an image that should be used as the logo [string]
--min-log-level The Loggers minimum log level [string] [choices: "debug", "info", "warn", 'error']
--port The port on which the Portal server should listen [number]
--startables-order List of process model and start dialog IDs that are used to determine their order [array]
--theme Path to the theme file for the web-ui [string]
--translationFolder Path to a directory which includes translation files for the web-ui [string]
--use-authority Use 5Minds Authority for authentication [boolean]
-v, --verbose Logs more information [deprecated: Use --min-log-level instead] [boolean]
-h, --help Show help [boolean]
Examples:
portal Use the default configuration
portal --config-path=portalConfig.json Load configuration from file
portal --config-path=portalConfig.json --engine-url http://localhost:10560 Load configuration from file and override 5Minds Engine URL
authorityConfiguration__clientId=portal_app portal Use environment variables to set the client ID
Docker
Das 5Minds Portal steht als Docker-Image unter 5minds/portal zur Verfügung.
Hilfe für das Image anzeigen:
docker run --rm -it 5minds/portal --help
Portal starten:
docker run --publish 13560:13560 --rm -it 5minds/portal
Beispiel-Konfiguration mit URL für die 5Minds Engine und aktiviertem OAuth2:
docker run --publish 9000:9000 --rm -it 5minds/portal \
--useAuthority true \
--authorityConfiguration__clientId atlasui \
--authorityConfiguration__scopes test_resource \
--engineUrl https://pe.portal.5minds.de \
--applicationBaseUrl http://localhost:9000
Konfiguration
Das Portal kann über verschiedene Wege konfiguriert werden (Konfigurationsdatei, Umgebungsvariablen, Kommandozeilenargumente).
In der Dokumentation zur Konfiguration werden alle Konfigurationsmöglichkeiten aufgezeigt.