Installation

Installation

Staxx kann als Einzelplatzinstallation (im folgenden mit lokal gekennzeichnet) oder als Server-Client-Applikation installiert werden. Bei der Einzelplatzinstallation werden alle erforderlichen Komponenten auf einem lokalen Gerät installiert. Bei der Server-Client-Installation werden die Datenbank und das File Repository auf dem Server installiert und auf den einzelnen Benutzer-Geräten lediglich der Staxx-Client.

Datenbank installieren

MySQL

Staxx benutzt zur Speicherung der Daten eine MySQL-Datenbank. Diese kann lokal sowie auf einem Server installiert werden. Dabei ist zu beachten, dass es verschiedene Edition von MySQL gibt und nicht jede davon kostenlos ist. Die Anleitung bezieht sich auf die Installation der kostenlosen Community Edition. Falls bereits eine MySQL-Datenbank installiert ist, können die nachfolgenden Schritte zur Installation von MySQL übersprungen werden. Folgende Anleitung ist für das Betriebssystem Windows:

Download der MySQL Community Edition (Version 8.0.20 - 8.0.28)
- Es wird empfohlen die aktuellste Version zu nutzen
- Beachten: Download der mysql-installer-community-$version$.msi, nicht der web variante.
MSI ausführen (es können fast immer die vorgegebenen Werte genutzt werden)
- Produkte:
  - MySQL Server (notwendig)
  - MySQL Workbench (optional, jedoch empfohlen)
    - Benutzeroberfläche um unter anderem mit den Datenbanken zu arbeiten. Es können jedoch auch alternative Tools benutzt werden (bspw. DBeaver).
- Typ und Netzwerk
  - Typ
    - Development Computer (lokal)
    - Server Computer (Server)
- Windows Service
  - dringend empfohlen, ansonsten muss der Service immer manuell gestartet werden

Staxx Datenbank

Wenn MySQL erfolgreich installiert ist, kann nun die Datenbank für Staxx erstellt werden. Hierzu wird der Root-Benutzer benötig.

Download von (noch einfügen)
Ausführen von create-db-user.bat
- Der MySQL-Host ist die IP des Servers oder für eine lokale Installation localhost
- Mehrfache Abfrage des Passworts vom Root-Benutzer
Ausführen von run-liquibase.bat
- Es wird immer eine update.log generiert, welche in der Regel ignoriert werden kann
- Bei Fehlern sollte eine rollback.log generiert werden. Falls das der Fall ist, stehen die entsprechenden Fehler in der update.log
Bei Bedarf können Demo-Daten mithilfe von init-demo.bat eingefügt werden (optional)
Programm Settings mithilfe von der MySQL Workbench, DBeaver, Shell, etc. einpflegen. Um Staxx starten zu können sind folgende Einstellungen notwendig, jedoch sollten für alle Einstellungen entsprechende Werte hinterlegt sein.
- GENERAL_FILE_DIRECTORY
- GENERAL_LICENSE_FILE
- GENERAL_EXPLORER_SERVER_IP

Hinweis: Es kann vorkommen, dass beim Starten von Staxx eine Fehlermeldung mit [...] SELECT list is not in GROUP BY [...] kommt. Für diesen Fall kann fix-group-by-error.bat ausgeführt werden, um den Fehler zu beheben. Andernfalls muss die MySQL Konfiguration manuell angepasst werden (s. hier link einfügen).

Achtung: Wenn die Skripte nicht ausgeführt werden können, weil mysql nicht erkannt wird, muss mysql noch zu Pfadvariable hinzugefügt werden. Dazu folgende Schritte befolgen.

In der Windows Suche nach "Umgebungsvariablen" suchen und "Systemumgebungsvariablen bearbeiten" auswählen
Im geöffneten Fenster auf Umgebungsvariablen klicken
Die Variable Path bearbeiten. Entweder für den Benutzer, falls die Skripte ausschließlich von dem Benutzer ausgeführt werden, andernfalls die Systemvariable anpassen.
Im neuen Fenster einen neuen Eintrag erstellen und dort das bin-Verzeichnis hinterlegen (C:\Program Files\MySQL\MySQL Server 8.0\bin). Entsprechend anpassen, falls MySQL an anderer Stelle installiert wurde

Staxx installieren

Download des Setups (link hier einfügen)
Setup ausführen und Schritte befolgen
- Datenbankserver: Es ist wichtig, dass hier eine IP angegeben wird und keine Domain
  - Für eine lokale Installation 127.0.0.1 und nicht ~~localhost~~ (lokal)
Staxx starten

Einzelplatzinstallation
Server-Client-Installation
- Anforderungen an die IT-Umgebung
Lizenz einlesen