Installation (Connect 2021)

Inhalt

1 Inhalt
2 Voraussetzungen
3 Installation unter Windows
- 3.1 Installation als Konsolenanwendung
  - 3.1.1 Installation der Laufzeitumgebung
  - 3.1.2 Installation des Connect Servers
  - 3.1.3 Konfiguration des Connect Servers
  - 3.1.4 Start des Connect Servers
  - 3.1.5 Beenden des Connect Servers
- 3.2 Installation als Windows Dienst
- 3.3 Installation als IIS Website
  - 3.3.1 Installation der Laufzeitumgebung
4 Installation unter Linux
5 Installation unter Docker

Voraussetzungen

Als Laufzeitumgebung für den Connect Server wird .NET 5.0 (mit ASP.NET Core) ab Patchlevel 5.0.7 vorausgesetzt. Diese kann über folgenden Link heruntergeladen werden:

https://dotnet.microsoft.com/download/dotnet/5.0

Verwenden Sie unter Windows das Paket „Hosting Bundle“ bzw. unter anderen Plattformen die „binaries“ für die entsprechende Prozessorarchitektur. Alternativ kann auch die SDK verwendet werden, diese ist jedoch nicht zwingend erforderlich.

Die benötigten Ressourcen variieren stark in Abhängigkeit vom Szenario. Exemplarisch zur Orientierung die Empfehlungen für den Einsatz zur Firmeninternen Synchronisation von Tickets:

	Kleines Datenvolumen < 300 Transaktionen/h	Mittleres Datenvolumen < 1000 Transaktionen/h	Großes Datenvolumen >= 1000 Transaktionen/h

	Kleines Datenvolumen < 300 Transaktionen/h	Mittleres Datenvolumen < 1000 Transaktionen/h	Großes Datenvolumen >= 1000 Transaktionen/h
CPU	x64 >= 2 Cores	x64 >= 4 Cores	x64 >= 4 Cores
Speicher	>= 4 GB	>= 4 GB	>= 8 GB
Betriebssystem	Windows 10 oder Linux	Windows 10, Windows Server 2016 oder Linux	Windows 10, Windows Server 2016 oder Linux
Zusätzliche Komponenten	.NET 5.0 (inkl. ASP.NET Core 5.0)	.NET 5.0 (inkl. ASP.NET Core 5.0)	.NET 5.0 (inkl. ASP.NET Core 5.0)

Bei kleinen und mittleren Installationen spricht nichts dagegen, eine bestehende (virtuelle) Maschine mit ausreichenden Kapazitäten mitzubenutzen.

Netzwerkseitig ist zu sicherzustellen, dass die Laufzeitumgebung von Connect mit allen beteiligten Umsystemen über http bzw. https kommunizieren kann.

Installation unter Windows

Installation als Konsolenanwendung

Installation der Laufzeitumgebung

Laden Sie das aktuelle “Hosting Bundle” für die ASP.NET Core 5.0 Laufzeitumgebung herunter und führen sie das Installationsprogramm aus. Der Download wird von Microsoft unter folgendem Link bereitgestellt:

https://dotnet.microsoft.com/download/dotnet/5.0

Installation des Connect Servers

Extrahieren Sie das bereitgestellte ZIP-Archiv mit dem Connect Server in einen Ordner.

Konfiguration des Connect Servers

Der Connect Server mit bereits mit einer Lauffähigen Konfiguration ausgeliefert. Der integrierte Webserver steht nach dem Start an Port 80 zur Verfügung und reagiert auf HTTP-Anforderungen. Nähre Informationen zum Anpassen der Konfiguration entnehmen Sie bitte dem Kapitel Konfiguration.

Start des Connect Servers

Öffnen Sie eine Shell (cmd), wechseln Sie in den Ordner mit dem Connect Server und starten Sie die ausführbare Datei namens “GalileoGroup.Connect.Server.Backend.exe”

Beenden des Connect Servers

Aktivieren Sie das Konsolenfenster und beenden Sie den Connect Server durch die Tastenkombination Strg + C oder schließen Sie das Konsolenfenster des Connect Servers.

Installation als Windows Dienst

Installation der Laufzeitumgebung

Laden Sie das aktuelle “Hosting Bundle” für die ASP.NET Core 5.0 Laufzeitumgebung herunter und führen sie das Installationsprogramm aus. Der Download wird von Microsoft unter folgendem Link bereitgestellt:

https://dotnet.microsoft.com/download/dotnet/5.0

Installation des Connect Servers

Extrahieren Sie das bereitgestellte ZIP-Archiv mit dem Connect Server in einen Ordner (z. B. “C:\Program Files\GalileoGroup\Connect”).

Anlegen eines lokalen Benutzers für die Ausführung des Diensts

Zum Anlegen des lokalen Benutzers geben Sie folgende Kommandos in eine PowerShell mit Administratorrechten ein:

$accountName = "ConnectService"
New-LocalUser -Name $accountName

Nachdem Der Benutzer erfolgreich angelegt wurde, muss ihm die Berechtigung für die Anmeldung als Windows Dienst zugewiesen werden. Drücken Sie die Tasten Win + R und geben Sie im folgenden Eingabefenster secpol.msc ein. Nun wird ein Fenster wird mit einer Baumstruktur auf der linken Seite dargestellt. Öffnen Sie dort den Knoten “Lokale Richtlinien” und klicken Sie anschließend den Knoten “Zuweisen von Benutzerrechten” an. In der rechten Bildhälfte den Eintrag “Anmelden als Dienst” via Doppelklick auswählen.

Klicken Sie im nachfolgenden Dialogfenster auf die Schaltfläche „Benutzer oder Gruppe hinzufügen“ und wählen Sie den neu angelegten lokalen Benutzer aus. Falls der Benutzer nicht gefunden wird, schränken Sie den Suchpfad auf den lokalen Computernamen ein.

Nun muss dem neuen Benutzer der Zugriff auf den Ordner gestattet werden, in dem die Anwendung installiert wurde. In diesem Beispiel wird den Ordner “C:\Program Files\GalileoGroup\Connect” verwendet. Geben Sie hierfür folgende Kommandos in eine PowerShell mit Administratorrechten ein:

$accountName = "ConnectService"
$fullPath = "C:\Program Files\GalileoGroup\Connect"
$User = Get-LocalUser -Name $accountName

if($User -ne $Null) {
  $acl = Get-Acl $fullPath -ea Stop
  $FileSystemRights = [System.Security.AccessControl.FileSystemRights]"Modify"
  $AccessControlType = [System.Security.AccessControl.AccessControlType]::Allow
  $InheritanceFlags = [System.Security.AccessControl.InheritanceFlags]"ContainerInherit, ObjectInherit"
  $PropagationFlags = [System.Security.AccessControl.PropagationFlags]"InheritOnly"

  $AccessRule = New-Object System.Security.AccessControl.FileSystemAccessRule ($User.SID, $FileSystemRights, $InheritanceFlags, $PropagationFlags, $AccessControlType)
  $acl.AddAccessRule($AccessRule)
    
  Set-Acl -Path $fullPath -AclObject $acl -ea Stop
    
  Write-Host ("Permission granted at {0}" -f $fullPath)
}

Registrierung des Connect Servers als Windows Dienst

Die Registrierung kann ebenfalls mit Hilfe der PowerShell bewerkstelligt werden. Hier ein Beispiel, welches als Vorlage verwendet werden kann:

New-Service -Name ConnectServer -BinaryPathName "C:\Program Files\GalileoGroup\Connect\GalileoGroup.Connect.Server.Backend.exe" -Credential MYHOST\ConnectService -Description "Connect Server Service" -DisplayName "Connect Server" -StartupType Manual

Deregistrierung des Windows Diensts

Soll der Windows Dienst wieder entfernt werden, so kann dies mit folgendem Kommando in einer Shell mit Administrator-Berechtigung bewerkstelligt werden (“<ServiceName>” bitte durch den Namen des gewünschten Diensts ersetzen):

Konfiguration des Connect Servers

Der Connect Server mit bereits mit einer Lauffähigen Konfiguration ausgeliefert. Der integrierte Webserver steht nach dem Start an Port 80 zur Verfügung und reagiert auf HTTP-Anforderungen. Nähre Informationen zum Anpassen der Konfiguration entnehmen Sie bitte dem Kapitel Konfiguration.

Installation als IIS Website

Installation der Laufzeitumgebung

Laden Sie das aktuelle „Hosting Bundle“ für die ASP.NET Core 5.0 Laufzeitumgebung herunter und führen sie das Installationsprogramm aus. Der Download wird von Microsoft unter folgendem Link bereitgestellt:

https://dotnet.microsoft.com/download/dotnet/5.0

Bei der Installation ist zu beachten, dass der Connect Server sein Frontend als WebAssembly bereitstellt und daher einige Umfeld-spezifische Konfigurationsanpassungen erfordert. Bitte besprechen Sie die genaue Vorgehensweise mit unserem Support-Team.

Installation unter Linux

Vorbereitungen unter CentOS

Da bei CentOS die Bibliothek für die Entwicklung internationaler Unicode-Komponenten nicht standardmäßig installiert ist, muss diese ggf. manuell installiert werden. Gehen Sie hierbei wie folgt vor:

Vorbereitungen unter Debian

Da bei Debian die Bibliothek für die Entwicklung internationaler Unicode-Komponenten sowie curl nicht standardmäßig installiert ist, müssen diese ggf. manuell installiert werden. Gehen Sie hierbei wie folgt vor:

Anlegen des Benutzers

Es empfiehlt sich einen eignen Benutzer für die Ausführung des Connect Servers anzulegen.

Folgendes Beispiel zeigt das Anlegen eines neuen Benutzers mit dem Namen "connect":

Installation der ASP.NET Core 5.0 Runtime

Die Installation kann entweder über einen Paketmanager (global) oder über das von Microsoft bereitgestellte Installationsskript erfolgen.

Führen Sie hierfür folgende Kommandos aus, um das Installationsskript herunterzuladen und auszuführen:

Alternativ können Sie auch das benötigte Paket für Linux unter https://dotnet.microsoft.com/download/dotnet/5.0 herunterladen, im Home-Verzeichnis des für Connect angelegten Benutzers ablegen und wie folgt entpacken:

Allgemeine Informationen zur Installation der .NET Core Runtime finden Sie unter folgendem Link:

https://docs.microsoft.com/de-de/dotnet/core/install/linux

Informationen zu dem verwendeten Installationsskript finden Sie unter folgendem Link:

https://docs.microsoft.com/de-de/dotnet/core/tools/dotnet-install-script

Installation des Connect Servers

Zur Installation des Connect Servers kopieren Sie das Archiv mit dem Connect Server sowie das Archiv mit der kundenspezifischen Konfiguration in das Home-Verzeichnis des für Connect angelegten Benutzers. Gehen Sie wie folgt vor, um die Software zu installieren (ersetzen Sie den blau hervorgehobenen Namen config.tar.gz durch den Namen des für Sie bereitgestellten Archivs mit Konfigurationsdaten):

Konfiguration des Connect Servers

Der Connect Server mit bereits mit einer Lauffähigen Konfiguration ausgeliefert. Der integrierte Webserver steht nach dem Start an Port 80 zur Verfügung und reagiert auf HTTP-Anforderungen. Nähre Informationen zum Anpassen der Konfiguration entnehmen Sie bitte dem Kapitel Konfiguration.

Start des Connect Servers im Vordergrund

Um den Connect Server im Vordergrund zu starten, gehen Sie wie folgt vor:

Start des Connect Servers im Hintergrund

Um den Connect Server im Hintergrund zu starten, gehen Sie wie folgt vor:

Es empfiehlt sich für diese Aktion ein entsprechendes Skript anzulegen. Entsprechende Vorlagen finden Sie im Ordner Scripts/Templates.

Beenden des Connect Servers

Um einen im Vordergrund laufenden Connect Server zu beenden, drücken Sie Ctrl + C.

Um alle im Hintergrund laufenden Connect Server zu beenden, gehen Sie wie folgt vor:

Es empfiehlt sich für diese Aktion ein entsprechendes Skript anzulegen. Entsprechende Vorlagen finden Sie im Ordner Scripts/Templates.

Installation unter Docker

Der Connect Server kann unter Docker betrieben werden. Unter Windows wird nur die “moderne” Docker-Variante (Docker mit WSL2) unterstützt. Für den Betrieb unter Docker empfehlen wir die Verwendung der Auslieferung als portable .NET Assembly, da die plattformspezifischen Varianten des Connect Servers nicht explizit für den Betrieb unter Docker getestet werden.

Als Basis für die Erstellung des Images benötigen Sie eine Linux Distribution sowie die aktuelle Version der ASP.NET Core 5.0 Laufzeitumgebung. Ein entsprechendes Image wird z. B. von Microsoft zur Verfügung gestellt, es kann jedoch auch entsprechende der eigenen Anforderungen selbst erstellt werden.

Das Connect-Auslieferungspaket enthält bereits ein Dockerfile für die Erstellung eines Images des Connect Servers auf Basis der von Microsoft bereitgestellten Umgebung für ASP.NET 5.0.

Vor der Erstellung des Images kann das Dockerfile bei Bedarf, an eigene Anforderungen angepasst werden. Das Folgende Beispiel zeigt ein Dockerfile zur Erstellung eines Containers mit der Debian basierten ASP.NET Core Laufzeitumgebung, zusätzlichen Netzwerk-Tools, einem Editor und dem Connect Server:

Zur Erstellung des Docker Images wechseln Sie mit Hilfe des cd Kommandos in das Arbeitsverzeichnis. Führen Sie dort folgende Kommando aus, um ein Image mit dem Namen “connect” zu erstellen:

In diesem Beispiel verwendet der Webserver Innerhalb des Docker Images die Standardkonfiguration und ist per HTTP auf Port 80 zu erreichen. Bei Bedarf kann eine HTTPS-Konfiguration auf Port 443 ergänzt werden. Nach außen hin kann für den Container ein beliebiger Port verwendet werden.

Damit die persistenten Daten nicht innerhalb des Containers gehalten werden, wird in diesem Beispiel ein externes Verzeichnis mit dem Namen „c:\connect\data“ angelegt. In diesem Verzeichnis kann eine JSON-Datei mit dem Namen “appsettings.json” erstellt werden, welche die Umgebungsspezifischen Konfigurationseinstellungen enthält.

Bei Bedarf können benötigte Repositories in einem Unterverzeichnis mit dem Namen “repositories” abgelegt werden.

Im Folgenden wird ein Container mit dem Namen “myconnect” erstellt, welcher auf dem Image “connect” basiert und den Port 8000 für den Zugriff über HTTP verwendet. Zur Auflösung von Servernamen muss für den Container ein DNS-Server spezifiziert werden (in diesem Beispiel die 192.168.1.110). Erzeugen und starten Sie den Container über folgendes Kommando:

Falls erforderlich, können Sie einen DNS-Suffix hinzufügen, indem Sie den Parameter --dns-search <suffix> vor dem Parameter --name angeben.

Weitere Informationen finden Sie in der Dokumentation unter folgendem Link:

https://docs.docker.com