Skip to main content

Installation des 5Minds Portals

In dieser Anleitung wird Ihnen erklärt, wie Sie das 5Minds Portal installieren und konfigurieren können.

Installationsvoraussetzungen​

Erstinstallation​

Das 5Minds Portal wird als Docker-Image (5minds/portal) zur Verfügung gestellt. Mit dem nachfolgenden Befehl können Sie die aktuelle Version des 5Minds Portals von Docker Hub herunterladen.

docker pull 5minds/portal

Um eine spezifische Version herunterzuladen, müssen Sie nach der Paketbezeichnung ein Suffix :Paketversion angeben. Der Befehl dafür sieht dann z.B. wie folgt aus.

docker pull 5minds/portal:3.11.0

Starten des Docker-Images​

Nachdem Sie das Image heruntergeladen haben, können Sie es mittels docker run starten. Das 5Minds Portal nutzt intern standardmäßig den Port 13560. Um diesen Port erreichen zu können, müssen Sie auf dem Host ebenfalls einen Port benennen, der auf den Docker-Container weitergeleitet wird. Das können Sie über den publish-Parameter erreichen: --publish (-p) {hostPort}:{containerPort} Dem Container können Sie mit dem name-Parameter einen Namen zuweisen.

Im folgenden Beispiel wird der Port 13560 des Hosts auf den Port 13560 des Docker-Containers weitergeleitet.

docker run --name 5MindsPortal --publish 13560:13560 5minds/portal

Wenn sie eine spezifische Version heruntergeladen haben, sieht der Befehl wie folgt aus:

docker run --name 5MindsPortal --publish 13560:13560 5minds/portal:3.11.0

Der Port des Hosts kann frei gewählt werden. Wenn Sie einen anderen Port verwenden möchten, passen Sie einfach den ersten Port des --publish-Parameters an.

docker run --name 5MindsPortal --publish 49999:13560 5minds/portal

Nach erfolgreichem Start des Docker-Containers wird folgende Ausgabe auf Ihrer Konsole angezeigt:

5Minds Engine URL: http://localhost:10560
Application Base URL: http://localhost:13560
Use of Authority enabled: false

Running on http://localhost:13560/

Konfigurieren des 5Minds Portals​

Sie können Ihr 5Minds Portal auf drei verschiedene Arten Konfigurieren, oder die Standardwerte verwenden, wenn Sie keine eigenen Formulare entwickeln wollen. Daraus ergeben sich vier verschiedene Konfigurationsquellen, die nacheinander eingelesen werden. Eine später eingelesener Datensatz überschreibt den Vorhergehenden.

  1. Standardwerte
  2. JSON Datei
  3. Umgebungsvariablen
  4. Kommandozeilenargumente

Eine genaue Beschreibung der Konfigurationsmöglichkeiten und Standardwerte finden Sie unter Konfigurieren des 5Minds Portals.

JSON-Konfiguration in Docker-Container laden​

Wenn Sie eine eigene Konfigurationsdatei angelegt haben, müssen Sie diese über ein gemountetes Volume an den Docker-Container anbinden und den Pfad zur Datei mit dem Befehlszeilenargument CONFIG_PATH beim Starten an den Docker-Container übergeben. Dafür sollten Sie die Konfigurationsdateien in einem nur dafür vorgesehenen Ordner ablegen, da alle Inhalte des Ordners im Docker-Container verfügbar gemacht werden.

Den Ordner können Sie anschließend über den Parameter --volume (-v) {Pfad zum Konfigurations-Ordners}:{Pfad des Ordners im Container} im docker run-Befehl mounten.

Die CONFIG_PATH-Umgebungsvariable kann mit dem Parameter --env (-e) CONFIG_PATH={Pfad des Ordners im Container}/{Konfigurationsdatei-Namen}.json an den Container übergeben werden.

Die Syntax des gesamten Befehls für das Starten des Containers sieht folgendermaßen aus:

docker run --name 5MindsPortal --volume <path-to-mount>:<destination> --CONFIG_PATH=<path-to-config-file-in-docker-container> 5minds/portal

Mit einer eingebundenen Beispieldatei und der lokalen Portfreigabe ergibt sich daraus der folgende Befehl:

docker run --name 5MindsPortal --volume ${PWD}:/mnt/config --CONFIG_PATH=/mnt/config/dev.json --publish 13560:13560 5minds/portal

Unter Windows ist der Befehl für die Pfadauswertung in der Eingabeaufforderung abweichend, dafür können Sie dann folgenden Befehl verwenden.

docker run --name 5MindsPortal --volume %cd%:/mnt/config --CONFIG_PATH=/mnt/config/dev.json --publish 13560:13560 5minds/portal

Die Befehle sind so geschrieben, dass Sie diese in dem Ordner in dem die Konfigurationsdatei liegt, ausführen müssen. Sollten Sie den Befehl von einer anderen Stelle ausführen wollen, geben Sie den Pfad anstelle von ${PWD} bzw. %cd% an.

Der nachfolgende Befehl zeigt die Pfaddefinition auf einem Windows-Betriebssystem.

docker run --name 5MindsPortal --volume /c/5MindsPortal/Configuration:/mnt/config --env CONFIG_PATH=/mnt/config/dev.json --publish 13560:13560 5minds/portal

Aktualisieren auf eine andere Version​

Wenn Sie das Docker-Image und damit ihre Installation des 5Minds Portals aktualisieren wollen, geht dies über Docker in den folgenden Schritten:

Abrufen der neuen Version​

Dies funktioniert identisch zu dem unter Erstinstallation beschriebenen Vorgehen.

docker pull 5minds/portal

Identifizieren der ID des laufenden 5Minds-Portal-Docker-Containers​

Sie können sich mit dem nachfolgenden Befehl alle laufenden Docker-Container und ihre IDs anzeigen lassen.

docker ps

Der gesuchte Docker-Container beinhaltet in der Spalte Image die aktuell laufende Image-Version. Anhand dieser können sie die Container ID identifizieren, welche im nächsten Schritt benötigt wird.

Screenshot Docker ps

Beenden des aktuell laufenden Docker-Containers​

Mit dem Befehl docker stop können Sie den Docker-Container beenden.

Bitte beachten Sie dabei, dass das 5Minds Portal danach nicht mehr erreichbar ist.

Um den Container danach zu entfernen, können Sie den Befehl docker rm {CONTAINER ID | CONTAINER NAME} benutzen.

Mit Container ID​

docker stop {CONTAINER ID | CONTAINER NAME}
docker rm {CONTAINER ID | CONTAINER NAME}

Mit den Werten aus dem laufenden Docker-Container ergeben sich dann z.B. folgende Befehle:

docker stop 468a247f3bdd
docker rm 468a247f3bdd

Wenn Sie einen Namen (z.B. 5MindsPortal) für den Docker-Container vergeben haben, dann sehen die Befehle wie folgt aus.

docker stop 5MindsPortal
docker rm 5MindsPortal

Starten des neuen Images​

Das Starten des abgerufenen Images verläuft wie bereits unter Starten des Docker-Images erklärt mit dem docker run-Befehl.

Testen des Verbindungsaufbaus​

Um die Verbindung zum 5Minds Portal zu testen, können Sie einfach die URL http://localhost:13560/ aufrufen. Wenn Sie den Host-Port wie unter Starten des Docker-Images beschrieben angepasst haben, kann der Link zum 5Minds Portal entsprechend abweichen.

Wird z.B. der Host Port 49999 benutzt, ändert sich die URL zu http://localhost:49999 .

Dort sehen Sie dann Ihr 5Minds Portal mit den in der verbundenen 5Minds Engine veröffentlichten Prozessen.

5Minds Portal Startseite Screenshot