Erstellen Sie eine Testumgebung für das Product Management Dashboard™
Die Product Management Dashboard App wird als Docker Image bereitgestellt.
Wenn Sie die App auf Ihrem Rechner testen möchten, ist es unserer Meinung nach am besten, zwei Docker-Container mit Hilfe einer Docker-Compose-Datei einzurichten. Informationen zur Installation von docker-compose finden Sie hier, z.B. indem Sie einfach Docker Desktop auf Ihrem System installieren.
Systemvoraussetzungen
Die Docker-Umgebung, auf der das folgende Setup ausgeführt wird, sollte mindestens über die folgenden Ressourcen verfügen:
Minimal
-
2 CPU Cores
-
3 GB RAM
Empfohlen
-
4 CPU Cores
-
6 GB RAM
Der benötigte Speicherplatz hängt von der Größe der Dokumente ab, die Sie in die App hochladen möchten. Sie sollten jedoch mindestens 5 GB für die Instanzen einplanen.
Umgebungsparameter
Sobald Sie Docker zum Laufen gebracht haben, können Sie damit beginnen, eine Datei namens dashboard.env in einem speziellen Ordner zu erstellen.
Der Inhalt könnte wie folgt aussehen:
APPLICATION_PORT=80
DB_USERNAME=db_user
DB_PASSWORD=db_password
MYSQL_HOST=proProdDb
MYSQL_PORT=3306
MYSQL_DB=pmBoard
INIT_USER_EMAIL=
Diese E-Mail-Adresse ist vor Spambots geschützt! Zur Anzeige muss JavaScript eingeschaltet sein. INIT_USER_PASSWORD=changeme
LANGUAGE=en
In diesem Beispiel werden nur einige der verfügbaren Umgebungsvariablen verwendet. Wenn Sie einen detaillierteren Überblick über die verfügbaren Parameter wünschen oder wissen möchten, wie Sie Ihre eigene mysql-Datenbank verwenden, können Sie einen Blick auf die Beschreibung des docker image werfen.
APPLICATION_PORT
Der Port, unter dem die Anwendung laufen soll. Wenn Sie "80" verwenden, können Sie die App unter "http://localhost" aufrufen. Beachten Sie, dass die App selbst keine SSL-Funktionen bereitstellt. Wenn Sie also z.B. 443 als Port verwenden, wird das https-Protokoll nicht aktiviert.
DB_USERNAME
Der Name des Benutzers, der Zugriff auf das Schema auf dem entsprechenden MySQL-Server hat.
DB_PASSWORD
Das Passwort des Benutzers, der Zugriff auf die Datenbank auf dem entsprechenden MySSQL Server hat. Sie sollten dies ändern! Verwenden Sie nicht das Zeichen '/' in Ihrem Passwort.
MYSQL_DB
Die Datenbank für die App. Diese muss das Schema mit der Sortierung 'utf8mb4_0900_ai_ci' haben.
INIT_USER_EMAIL
Die E-Mail des ursprünglichen Benutzers der App. Diese kann später auch in der App geändert werden.
INIT_USER_PASSWORD
Das Passwort des ursprünglichen Benutzers der App. Dieses kann später auch in der App geändert werden.
SPRACHE
Die Sprache, in der der Showcase erstellt wird, und die Standardsprache für den ersten Benutzer. Die Werte können "de" und "en" sein, die Standardeinstellung ist 'en'.
Compose File
Nachdem Sie die Datei erstellt und alle relevanten Variablen geändert haben, können Sie im selben Verzeichnis eine Datei mit dem Namen docker-compose.yaml erstellen (achten Sie darauf, dass Sie die Einrückungen beibehalten):
version: "3.7" networks: proProdNetwork: name: proProdNetwork services: app: image: proprodukt/pmboard:latest container_name: pm-dashboard-app restart: always ports: - "${APPLICATION_PORT}:8080" environment: - DB_USERNAME=${DB_USERNAME} - DB_PASSWORD=${DB_PASSWORD} - MYSQL_HOST=${MYSQL_HOST} - MYSQL_PORT=${MYSQL_PORT} - MYSQL_DB=${MYSQL_DB} - INIT_USER_EMAIL=${INIT_USER_EMAIL} - INIT_USER_PASSWORD=${INIT_USER_PASSWORD} - ATTACHMENT_PATH=/dashboard/data - WAIT_HOSTS= ${MYSQL_HOST}:${MYSQL_PORT} - LANGUAGE=${LANGUAGE} volumes: - dashboard_data:/dashboard/data depends_on: - proProdDb networks: - proProdNetwork proProdDb: image: mysql:8.0.32 container_name: pm-dashboard-db restart: always environment: - MYSQL_RANDOM_ROOT_PASSWORD=true - MYSQL_DATABASE=${MYSQL_DB} - MYSQL_USER=${DB_USERNAME} - MYSQL_PASSWORD=${DB_PASSWORD} ports: - 3306:3306 volumes: - db_data:/var/lib/mysql networks: - proProdNetwork cap_add: - SYS_NICE volumes: db_data: name: proProdMySql dashboard_data: name: proProdDashboard
Dadurch wird eine Docker Compose-Anwendung mit zwei Diensten erstellt, einem für die Anwendung und einem für den MySql-Server. Es werden auch zwei Volumina erstellt, in denen die Daten der App und der Datenbank gespeichert werden. Sie können diese Datei gerne ändern, wenn Sie wissen, was Sie tun. Sie können zum Beispiel Ihren eigenen (vorhandenen) MySQL-Server verwenden, der die Version 8.0.x (oder höher) haben muss. Oder Sie können die Datenordner nicht den Volumen, sondern den Ordnern auf Ihrem System zuordnen. Hier finden Sie eine Übersicht, wie Sie mit einer Docker-Compose-Datei arbeiten können.
Start and login
Nachdem Sie beide Dateien erstellt haben, können Sie mit Ihrer Konsole zu dem Ordner navigieren, in dem sich die beiden Dateien befinden, und den folgenden Befehl ausführen:
$ sudo docker-compose -p pm-board --env-file dashboard.env up -d
Sobald sowohl der Datenbank-Container als auch der App-Container gestartet sind, sollten Sie in der Lage sein, auf die App zuzugreifen, indem Sie http://localhost in Ihren Browser eingeben (vorausgesetzt, Sie haben die obigen Standardeinstellungen verwendet). Der Benutzername und das Passwort sind ebenfalls die Werte, die Sie in den Umgebungsparametern definiert haben, standardmäßig
Erwerb einer Testlizenz
Um das Product Management Dashboard nutzen zu können, müssen Sie Ihren lokalen Server registrieren, um eine Testlizenz zu erhalten. Für die Registrierung benötigen Sie den eindeutigen Serverschlüssel, den Sie im Abschnitt "Lizenz" im Administrationsbereich finden:
Hier können Sie ein Konto erstellen und Ihre lokale Instanz registrieren.
Wenn Ihre lokale Instanz eine Verbindung zum Internet herstellen kann, holt sich die App die Lizenz automatisch. Wenn sie keinen Zugriff hat, z. B. weil die Instanz hinter einer Firewall läuft, können Sie den Schlüssel in unserem Lizenzportal herunterladen und in das Feld "Lizenzschlüssel" im Abschnitt "Lizenz" der App eingeben.
Updaten Ihrer Installation
Um Ihre lokale Installation zu aktualisieren, müssen Sie zu dem Ordner navigieren, in dem Sie die beiden oben genannten Dateien dashboard.env und docker-compose.yaml ursprünglich erstellt haben. Wenn Sie die Dateien gelöscht haben, erstellen Sie sie einfach neu. Nun können Sie den folgenden Befehl ausführen, um die neueste Version der App zu erhalten
$ sudo docker pull proprodukt/pmboard:latest
Sobald die neue Version heruntergeladen ist, können Sie das Skript von oben erneut ausführen:
$ sudo docker-compose -p pm-board --env-file dashboard.env up -d
Wenn Sie den Namen der Containergruppe (den Parameter nach -p) geändert haben, stellen Sie sicher, dass Sie ihn auch im obigen Skript ändern.
Nächste Schritte
Nach dem Test empfehlen wir Ihnen dringend, mit der IT-Abteilung Ihres Unternehmens zu klären, wie die App in Ihrer Umgebung für den produktiven Einsatz gehostet werden kann.
Die Daten, die Sie während Ihres Tests eingegeben haben, gehen nicht verloren. Sie können einen Export von Ihrem lokalen System erstellen, der dann auf dem neuen System installiert werden kann.