trax für Windows Server wird als Docker Container über eine von TTS betriebene Registry verteilt.
Die Verwendung von Containern ist ab Windows Server 2016 möglich.
Stellen Sie sicher, dass der Server, auf dem Sie trax installieren wollen, sämtliche verfügbaren Updates installiert hat, und die Anforderungen von Docker unter Windows erfüllt. Docker unter Windows benötigt min. 4 GB RAM und min. 32 GB Speicherplatz. Wir empfehlen eine CPU mit vier Kernen für kleine Installationen mit max. drei Mandanten.
Zur Installation von Docker wird ein Skript bereitgestellt, das den offiziellen Installationsweg unter https://docs.microsoft.com/en-us/virtualization/windowscontainers/quick-start/set-up-environment befolgt. Hierbei werden Pakete von Microsoft Servern bezogen, ggf. muss der Zugriff auf diese gestattet werden. Alternativ kann Docker manuell über die in der Dokumentation beschriebene skript-basierte Installation im Voraus installiert werden. Wird dieser Weg gewählt, muss ebenfalls docker-compose manuell installiert werden.
Zur Installation dieser Komponenten sind Administratorrechte 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 zip-Archiv tts-trax-x.x.x.zip mit sämtlichen Konfigurationsdateien und Provisionierungsdaten und den benötigten Zertifikaten zum Zugriff auf das trax Repository sowie
eine Lizenzdatei license.trax
Mit diesen Dateien können Sie die aktuelle Version von trax aus einem von TTS betriebenen Online-Repository (registry.tts-trax.com) beziehen.
Laden Sie das zip-Archiv auf den Server, auf dem trax ausgeführt werden soll, und entpacken Sie dieses nach C:\trax.
Folgende Struktur sollte sich daraus u.a. ergeben:
C:\trax |
||
|---|---|---|
| ↳ | certs |
Speicherort für Webserver Zertifikate |
| ↳ | database |
Speicherort für Datenbankschlüssel |
| ↳ | environment |
Umgebungskonfiguration |
| ↳ | images |
Zusätzliche von trax verwendete Images |
| ↳ | provisioning |
Speicherort für Konfigurationen |
| ↳ | registry |
Zertifikate zum Zugriff auf die Registry |
| ↳ | storage |
Speicherort für temporäre und Log-Dateien |
| ↳ | 01-setup-env.ps1 |
Skript zur Installation von Docker etc. |
| ↳ | 02-setup-trax.ps1 |
Skript zur Installation von trax |
| ↳ | docker-compose.win2016.yml |
Konfiguration der verwendeten Container |
Bitte kopieren Sie den oben erstellten privaten Schlüssel client.key in das Verzeichnis C:\trax\registry. Dieser wird für die gesicherte Kommunikation mit dem Release-Server benötigt.
Kopieren Sie zusätzlich das TLS-Zertifikat sowie den dazugehörigen Schlüssel zur Herstellung der https-Verbindung in das Verzeichnis C:\trax\certs.
Sei trax.mycompany.local der Hostname, unter dem Sie Ihre trax-Installation erreichen wollen, dann nennen Sie die Dateien bitte trax.mycompany.local.crt (Zertifikat) respektive trax.mycompany.local.key (privater Schlüssel).
Sollten Sie Docker noch nicht auf dem Server installiert haben, öffnen Sie bitte eine Powershell mit Administratorrechten und führen das Skript 01-setup-env.ps1 aus.
.\01-setup-env.ps1
Des Weiteren wird die Datei docker-compose.win2016.yml in docker-compose.yml umbenannt, um statt der Linux-Distribution die Windows Server Distribution zu verwenden, und zuletzt Docker for Windows Server installiert.
Dazu wird mittels Install-Module der DockerMsftProvider installiert, der dann vom Docker-Paket, das mittels Install-Package installiert wird, verwendet wird.
Das Setup wird durch die Installation von docker-compose abgeschlossen.
Sollten Sie Docker sowie docker-compose bereits auf Ihrem Server installiert haben, so führen Sie dennoch das Skript aus, jedoch in der Form:
.\01-setup-env.ps1 –SkipDocker
Es wird empfohlen, den Server nach diesem Schritt neu zu starten, um sicherzugehen, dass alle Pakete installiert, konfiguriert und gestartet sind.
Nach dem Neustart des Servers öffnen Sie bitte erneut eine Powershell mit Administratorrechten in dem Verzeichnis C:\trax und führen das Skript 02-setup-trax.ps1 aus:
.\02-setup-trax.ps1
Dieses Skript kopiert zunächst die Zertifikate aus dem Registry-Verzeichnis an die Stelle, an der sie von Docker erwartet werden (C:\ProgramData\docker\certs.d).
Darauf wird die Verschlüsselung der Datenbank konfiguriert. Dafür wird es entsprechende Schlüssel generieren und im Verzeichnis C:\trax\database speichern.
Im Anschluss wird eine Standard-Konfigurationsdatei unter C:\trax\environment\.env hinterlegt, die im Folgenden noch angepasst werden muss, sowie verschiedene Schlüssel generiert.
In der environment\.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).
Zum Start der Anwendung genügt nun folgender Befehl:
docker-compose up -d
Sie können die Anwendung mit dem folgenden Befehl beenden:
docker-compose down
Der erste Start kann einige Minuten dauern. In diesem Fall wird trax die nötigen Migrationen ausführen.
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.