Sie können trax prinzipiell auf jedem Linux-Derivat einsetzen, auf dem Docker installiert werden kann. Docker stellt entsprechende Anleitungen für die folgenden Plattformen bereit:
CentOS: https://docs.docker.com/install/linux/docker-ce/centos/
Debian: https://docs.docker.com/install/linux/docker-ce/debian/
Fedora: https://docs.docker.com/install/linux/docker-ce/fedora/
Ubuntu: https://docs.docker.com/install/linux/docker-ce/ubuntu/
Die mitgelieferten Skripte, gerade zur Installation von Docker gehen jedoch von einem Setup auf einem Debian oder Ubuntu-System aus.
Stellen Sie sicher, dass der Server, auf dem Sie trax installieren wollen, sämtliche verfügbaren Updates installiert hat, und die Anforderungen für Docker erfüllt. Wir empfehlen für eine kleine Installation mit max. drei Mandanten eine CPU mit zwei Kernen und min. 1GB RAM.
Für die Installation sind an mehreren Stellen root-Rechte erforderlich.
Die aktuellen Versionen von trax werden über die Docker Registry registry.tts-trax.com verteilt, auf die per HTTPS mit dem Standard-Port 443 zugegriffen wird.
Zur Inbetriebnahme von trax werden von TTS folgende Dateien bereitgestellt:
Ein Archiv tts-trax-x.x.x.tar.gz mit sämtlichen Konfigurationsdateien und Provisionierungsdaten sowie den benötigten Zertifikaten zum Zugriff auf das trax Repository sowie
eine Lizenzdatei license.trax
Das .tar.gz-Archiv muss auf den entsprechenden Server, auf dem trax ausgeführt werden soll, kopiert und entpackt werden.
Mit folgendem Befehl kann das Archiv in einen neu erstellten Ordner deployment entpackt werden:
$ mkdir deployment
$ tar -xzvf tts-trax-x.x.x.tar.gz --strip-components=1 -C deployment
Um auf das TTS Repository zugreifen zu können, muss der zuvor erstellte private Schlüssel in das Unterverzeichnis registry/ kopiert werden.
Im Verzeichnis registry/ müssen folgende Dateien liegen. Auf eine korrekte Benennung ist zu achten:
| Datei | Beschreibung |
|---|---|
| ca.crt | Zertifikatskette des trax Repositories (bereitgestellt von TTS) |
| client.cert | Signiertes Zertifikat des CSR (s. Kapitel 4, bereitgestellt von TTS) |
| client.key | Privater Schlüssel (erstellt in Kapitel 4) |
Sollte noch kein Docker auf dem Server installiert sein, so können Sie diese unter Debian-basierten Systemen mit dem Skript 01-setup-env.sh installieren.
Dieses installiert die aktuellste Version der Docker Community Edition aus den Docker-eigenen Repositories. Zusätzlich wird auch das benötigte docker-compose installiert:
$ chmod +x ./01-setup-env.sh
$ ./01-setup-env.sh
Dieses Skript fügt den aktuellen Benutzer in die Docker-Gruppe hinzu, um die Docker-Container starten zu können. Um diese Gruppenzugehörigkeit zu laden, muss eine erneute Anmeldung durchgeführt werden. Zur Installation werden Root-Rechte benötigt, die über sudo erlangt werden. Aus diesem Grund kann das Skript nach einem Passwort fragen.
Aufgrund einer Inkompatibilität des Docker-Installationspakets mit Debian 9, kann es vorkommen, dass Sie einen Server mit diesem Debian-Betriebssystem nach der Installation von Docker einmalig neu starten müssen.
Ein einfacher Test, um zu überprüfen, ob die Installation von Docker erfolgreich war, stellt der folgende Befehl dar. Wird dieser erfolgreich ausgeführt, ist die Docker-Umgebung installiert.
$ docker run hello-world
Betreiben Sie die Docker-Installation auf einem Server, der lediglich über einen HTTP(S)-Proxy auf das Internet zugreifen kann, müssen Sie Docker entsprechend konfigurieren, die Anfragen über diesen Proxy zu schicken. Sie können sich dabei an den Schritten der offiziellen Docker-Dokumentation orientieren.
In diesem Schritt werden die Zertifikate zum Zugriff auf die Registry konfiguriert, die Datenbankverschlüsselung initialisiert und die Umgebung vorbereitet.
Dafür muss das Skript 02-setup-trax.sh ausgeführt werden.
$ chmod +x ./02-setup-trax.sh
$ ./02-setup-trax.sh
Die SSL-Terminierung von trax wurde in dem trax-Container integriert. Um SSL zu aktivieren werden sowohl ein TLS-Zertifikat für den Hostname der trax-Instanz sowie der dazugehörige private Schlüssel benötigt.
Um trax über HTTPS zu verwenden, müssen im trax Verzeichnis die entsprechenden certs Ordner existieren:
$ mkdir -p certs/certs
$ mkdir -p certs/keys
Anschließend müssen die Zertifikatsdateien in die Ordner gelegt werden. Dabei ist folgende Namenskonvention zu beachten:
Der private Schlüssel muss mit dem Namen TRAX_HOST.key in den Ordner certs/keys, das Zertifikat mit dem Namen TRAX_HOST.crt in den Ordner certs/certs gelegt werden.
TRAX_HOST muss mit dem entsprechenden Common Name (CN) der trax Instanz ersetzt werden.
Damit nimmt trax automatisch Anfragen über HTTPS an.
In der .env-Datei erfolgt die Konfiguration der Umgebungsvariablen, die von trax verwendet werden.
Dazu gehören Angaben zum Versenden von Mails usw. Einige dieser Punkte müssen angepasst werden.
Die entsprechenden Einträge sind in der Dokumentation hervorgehoben, es ist sicherzustellen, dass auf jeden Fall die Variablen
APP_URL und TRAX_HOST angepasst werden. Außerdem müssen möglichst starke Passwörter für DB_PASSWORD und DB_SETUP_PASSWORD gewählt werden, diese werden beim ersten Start des Systems automatisch in der Datenbank gesetzt.
Wenn ein Mailserver konfiguriert wird, muss darauf geachtet werden, dass die Variable MAIL_DRIVER auf smtp gesetzt wird, sowie die Einträge MAIL_FROM_NAME und MAIL_FROM_ADDRESS ausgefüllt werden, zusätzlich zu den Zugangsdaten in MAIL_HOST, MAIL_PORT, MAIL_USERNAME und MAIL_PASSWORD.
Achten Sie insbesondere auf eine korrekte Angabe im Feld APP_URL. Dieses muss das verwendete Protokoll enthalten (z.B. https://trax.intranet.com).
Anschließend müssen die Container mit dem folgenden Befehl gestartet werden:
$ ./start.sh
Um trax während des Betriebs neu zu starten wird folgender Befehl ausgeführt:
$ ./restart.sh
Vor allem beim Update auf eine neue Version oder beim ersten Start von TTS trax gibt der Container einige Statusmeldungen in Form von Log-Ausgaben aus. Diese können Sie mit dem folgenden Befehl einsehen:
$ docker-compose logs -f trax
Durch die Option -f werden fortlaufend die neusten Meldungen ausgegeben.
Dieser Modus kann mit der Tastenkombination Strg+C wieder verlassen werden.
Die abschließende Konfiguration erfolgt über den Browser. Dazu wird die Domain aufgerufen, über die Ihre trax-Installation erreichbar sein soll. Dadurch wird der Setup-Assistent automatisch gestartet, dieser wird im folgenden Kapitel beschrieben.