6.2 Installation und Konfiguration

Gilt nur für ENTERPRISE Abonnement bei On Premise Hosting

Diese Anleitung bietet einen umfassenden Leitfaden zur Installation und Konfiguration des calServers in einer Docker-Umgebung auf einem Linux-System (z. B. Ubuntu 24.04). Sie richtet sich an IT-Administratoren und technisches Personal und umfasst alle wesentlichen Schritte – von der Einrichtung der Docker-Umgebung über das Klonen und Anpassen des Repositories bis hin zur Bereitstellung, Aktualisierung, Datenübertragung, Firewall-Konfiguration und initialen Datenbankeinrichtung. Nach diesen Schritten wird die Anwendung mit der konfigurierten Domain (z. B. meinefirma.calserver.com) gestartet und zeigt direkt die Meldung zur Initialisierung der Datenbank an.

Inhaltsverzeichnis

1. About the Project

Das Projekt erleichtert die Bereitstellung eines neuen calServer-Systems in einer Docker-Umgebung, indem grundlegende Compose-Dateien verwendet werden. Es bietet eine einfache, aber flexible Möglichkeit, den calServer auf einem Linux-System bereitzustellen.

2. Voraussetzungen

Stellen Sie sicher, dass folgende Voraussetzungen erfüllt sind:

    • Betriebssystem: Ubuntu 24.04 oder eine vergleichbare Linux-Distribution.
    • Benutzerrechte: Administrator- bzw. sudo-Rechte oder der aktuelle Benutzer in der Docker-Gruppe.
    • Netzwerk: Freigegebene Ports (z. B. 80, 443, SSH) und eine entsprechend konfigurierte Firewall.
    • Software:
      • Git (zum Klonen des Repositorys)
      • Docker sowie Docker Compose (bzw. das Docker Compose Plugin)
    • Systemressourcen: Ausreichend freier Speicherplatz und RAM zur Ausführung der Container.

3. Erstellung der Docker-Umgebung

3.1 Vorhandene Docker-Umgebung zurücksetzen

Skripte zum Zurücksetzen bestehender Docker-Container und Docker Compose-Konfigurationen sind erst verfügbar, wenn das Startprojekt vollständig eingerichtet ist. Falls diese Skripte (z. B. remove-all-from-docker.sh und install-docker.sh) vorhanden sind, können Sie damit Ihre aktuelle Docker-Umgebung zurücksetzen.

3.2 Docker und Docker Compose installieren

Falls Docker noch nicht installiert ist, führen Sie folgende Schritte aus:

Beispielhafte Ausgaben:

4. Installation des calServers

4.1 Arbeitsverzeichnis vorbereiten

Erstellen Sie einen geeigneten Installationsordner und wechseln Sie in diesen:

Hinweis: Falls Sie das Datenverzeichnis extern mappen möchten, stellen Sie sicher, dass das externe Volume die erforderliche Ablagestruktur besitzt. Andernfalls wird das Verzeichnis /data/calserver automatisch mit der folgenden Struktur gefüllt:

    • /data/calserver/filemanager
    • /data/calserver/filemanager/dms
    • /data/calserver/filemanager/inbox
    • /data/calserver/filemanager/reports
    • /data/calserver/local

Sie können das Verzeichnis mit einem Einzeiler erstellen:

4.2 Repository klonen

Stellen Sie sicher, dass Git installiert ist (falls nicht: sudo apt install git), und klonen Sie das Repository:

Wechseln Sie anschließend in das geklonte Verzeichnis:

4.3 Installer ausführen und Vorlagen kopieren

Führen Sie das Skript aus, das alle notwendigen Compose-Dateien, Shell-Skripte und die Vorlage der .env-Datei in das Master-Verzeichnis kopiert. Zusätzlich wird ein Service für den Autostart unter /var/calserver/deploy eingerichtet:

Falls das System bereits eingerichtet ist und nur Aktualisierungen vorgenommen werden sollen, verwenden Sie alternativ:

Hinweis: Stellen Sie sicher, dass alle .sh-Skripte ausführbar sind, z. B. durch:

5. Konfiguration anpassen

    • Wechseln Sie in das Master-Verzeichnis:
    • Führen Sie beispielhaft ein ls aus, um zu überprüfen, ob alle Dateien korrekt kopiert wurden. Eine typische Ausgabe könnte wie folgt aussehen:
    • Öffnen Sie die .envDatei in Ihrem bevorzugten Editor (z. B. nano):
    • Bearbeiten Sie insbesondere folgende Einträge (Beispiel):
    • Speichern Sie die Datei und schließen Sie den Editor.

Weitere Details zu den Umgebungsvariablen finden Sie in der Datei calserver.md im Repository.

6. Update und Bereitstellung

6.1 Update der Umgebung

Laden Sie die aktuell bestellten Docker-Container-Images mit dem Update-Skript:

Simulierte Log-Ausgabe für das Update:

Hinweis: Für den erfolgreichen Download ist ein Docker Hub Login erforderlich. Dieser Login wird Ihnen über Ihr aktuelles Abonnement des calServers bereitgestellt. Melden Sie sich gegebenenfalls mit folgendem Befehl an:

6.2 Deployment des calServers

Die Bereitstellung der Container erfolgt mittels des Skripts deploy.sh. Vor der Ausführung des Skripts muss sichergestellt werden, dass Sie im richtigen Verzeichnis (z. B. /opt/calserver/calserver-start) arbeiten.

    • Anmeldung bei Docker: Melden Sie sich bei Docker an, um Zugriff auf das Service-Repository zu erhalten. Verwenden Sie hierfür den folgenden Befehl und bestätigen Sie ihn mit Ihrem Servicepasswort (diese Zugangsdaten erhalten Sie über Ihr aktuelles Abonnement des calServers):
    • Container-Bereitstellung: Starten Sie den calServer mit dem Bereitstellungsskript: Simulierte Log-Ausgabe:
    • Überprüfen Sie den Container-Status mit:

Nach diesen Schritten sollte die Anwendung mit der konfigurierten Domain (z. B. meinefirma.calserver.com) gestartet werden und direkt die Meldung zur Initialisierung der Datenbank anzeigen.

7. Vorbereitende Datenbankeinrichtung im MySQL-Container

Nachdem Sie mit ./deploy.sh den calServer gestartet haben, läuft MySQL als Container. Bevor der calServer vollständig in Betrieb geht, müssen Sie in diesem MySQL-Container die benötigte Datenbank (z. B. calserver) und den Benutzer (z. B. calhelp) mit den erforderlichen Rechten anlegen – unter Verwendung der in der .env-Datei definierten Passwörter.

    • Ermitteln Sie den MySQL-Container:

    Führen Sie den Befehl aus, um den laufenden MySQL-Container zu identifizieren (in der Regel heißt der Container mysql_db):

    • Verbinden Sie sich mit dem MySQL-Container:

    Starten Sie eine MySQL-Shell im Container (verwenden Sie dabei das in der .env hinterlegte Root-Passwort, z. B. MyFirmaRoot!23):

    Geben Sie das Root-Passwort ein, wenn Sie dazu aufgefordert werden.

    • Überprüfen Sie vorhandene Datenbanken und legen Sie die benötigte an:

    Um einen Überblick über die vorhandenen Datenbanken zu erhalten, führen Sie in der MySQL-Shell folgenden Befehl aus:

    Anschließend führen Sie die folgenden Befehle aus (passen Sie die Werte an die in Ihrer .env definierten an):

    • Verlassen Sie die MySQL-Shell und beenden Sie die Exec-Session vollständig:

    Geben Sie in der MySQL-Shell ein:

    Wichtig: Falls Sie nach der Eingabe von EXIT; noch innerhalb der Docker Exec-Session verbleiben, geben Sie erneut exit ein, bis Sie sicher wieder in Ihrer Host-Shell sind.

    • Erneutes Deployment:

    Nachdem die Datenbankumgebung im MySQL-Container eingerichtet wurde und Sie die Exec-Session vollständig beendet haben, starten Sie den calServer erneut, um sicherzustellen, dass alle Komponenten korrekt miteinander kommunizieren:

    Simulierte Log-Ausgabe:

8. Firewall-Konfiguration (UFW)

Um sicherzustellen, dass nur der benötigte Netzwerkverkehr zugelassen wird, konfigurieren Sie UFW (Uncomplicated Firewall):

    • UFW installieren (falls nicht vorhanden):
    • Standardrichtlinien setzen:
    • Notwendige Ports freigeben:
      • SSH (Port 22):
      • HTTP (Port 80):
      • HTTPS (Port 443):
    • Firewall aktivieren:
    • Status der Firewall prüfen:

Diese Schritte stellen sicher, dass Ihre Serverumgebung nur den benötigten Netzwerkverkehr zulässt und somit vor unautorisierten Zugriffen geschützt ist.