Page Comparison

...

Content

Voraussetzungen

...

Requirements

As runtime environment for the Connect Server wird .NET 5.0 (mit with ASP.NET Core) ab Patchlevel from patch level 5.0.7 vorausgesetzt. Diese kann über folgenden Link heruntergeladen werdenis required. This can be downloaded via the following link:

...

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

...

Use the "Hosting Bundle" package under Windows or the "binaries" for the corresponding processor architecture under other platforms. Alternatively, you can also use the SDK, but this is not mandatory.

The required resources vary greatly depending on the scenario. For orientation purposes, here are the recommendations for the use of company-internal ticket synchronization:

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 For small and medium installations, there is no reason not to share an existing (virtual) machine with sufficient capacity.

On the network side, it must be ensured that the Connect runtime environment can communicate with all participating peripheral systems via http or https.

Installation under Windows

Installation as console application

Installing the Runtime Environment

Download the latest "Hosting Bundle" for the ASP.NET Core 5.0 Laufzeitumgebung herunter und führen sie das Installationsprogramm aus. Der Download wird von Microsoft unter folgendem Link bereitgestelltruntime environment and run the installer. The download is provided by Microsoft at the following link:

...

...

Installing the Connect

...

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 Web­server 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

...

Server

Extract the provided ZIP archive to a folder using the Connect Server.

Configuration of the Connect Server

The Connect Server is delivered with a ready-to-run configuration. The integrated web server is available on port 80 after startup and responds to HTTP requests. For more information on customizing the configuration, please refer to the Configuration chapter.

Starting the Connect Server

Open a shell (cmd), change to the folder with the Connect Server and start the executable file named "GalileoGroup.Connect.Server.Backend.exe".exe”

...

Exiting the Connect

...

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

...

Server

Activate the console window and exit the Connect Server by pressing Ctrl + C or close the Connect Server console window.

Installation as Windows service

Installing the Runtime Environment

Download the latest "Hosting Bundle" for the ASP.NET Core 5.0 Laufzeitumgebung herunter und führen sie das Installationsprogramm aus. Der Download wird von Microsoft unter folgendem Link bereitgestelltruntime environment and run the installer. The download is provided by Microsoft at the following link:

...

...

Installing the Connect

...

Server

Extract the provided ZIP archive with the Connect Server to a folder (e.g. "C:\Program Files\GalileoGroup\Connect”Connect").

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

...

Creating a local user to run the service

To create the local user, enter the following commands in a PowerShell with administrator privileges:

$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 “CAfter the user has been successfully created, it must be assigned the authorization to log on as a Windows service. Press the keys Win + R and enter secpol.msc in the following input window. Now a window will be displayed with a tree structure on the left side. There, open the node "Local Policies" and then click on the node "Assign user rights". In the right half of the screen, select the entry "Log on as service" via double-click.

In the following dialog window, click the "Add user or group" button and select the newly created local user. If the user is not found, restrict the search path to the local computer name.

Now the new user must be allowed access to the folder where the application was installed. In this example, the folder "C:\Program Files\GalileoGroup\Connect” verwendet. Geben Sie hierfür folgende Kommandos in eine PowerShell mit Administratorrechten einConnect" is used. To do this, enter the following commands in a PowerShell with administrator privileges:

$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

...

Registering the Connect Server as a Windows Service

Registration can also be accomplished using PowerShell. Here is an example which can be used as a template:

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

...

Deregistering the Windows

...

Service

If you want to remove the Windows service, you can do this with the following command in a shell with administrator privileges ("<ServiceName>" please replace with the name of the desired service):

sc delete <ServiceName>

Konfiguration des Connect Servers

Der Connect Server mit bereits mit einer Lauffähigen Konfiguration ausgeliefert. Der integrierte Web­server 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

...

Configuration of the Connect Server

The Connect Server is delivered with a ready-to-run configuration. The integrated web server is available on port 80 after startup and responds to HTTP requests. For more information on customizing the configuration, please refer to the Configuration chapter.

Installation as IIS Website

Installing the Runtime Environment

Download the latest "Hosting Bundle" for the ASP.NET Core 5.0 Laufzeitumgebung herunter und führen sie das Installationsprogramm aus. Der Download wird von Microsoft unter folgendem Link bereitgestelltruntime environment and run the installer. The download is provided by Microsoft at the following link:

...

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 vorDuring installation, please note that the Connect Server provides its frontend as a WebAssembly and therefore requires some environment-specific configuration adjustments. Please discuss the exact procedure with our support team.

Installation under Linux

Preparations under CentOS

Since CentOS does not have the library for developing international Unicode components installed by default, you may need to install it manually. Proceed as follows:

sudo yum install libicu

...

Preparations under 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 vorSince Debian does not have the library for developing international Unicode components and curl installed by default, you may need to install them manually. Proceed as follows:

sudo apt update
sudo apt install libicu-dev
sudo apt install curl

Anlegen des Benutzers

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

...

Creating the user

It is recommended to create a separate user for the execution of the Connect Server.

The following example shows the creation of a new user with the name "connect":

CONNECT_USER=connect

sudo useradd -m $CONNECT_USER
sudo passwd $CONNECT_USER

...

Installing the 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:The installation can be done either via a package manager (global) or via the installation script provided by Microsoft.

To do this, run the following commands to download and run the installation script:

CONNECT_USER=connect
su - $CONNECT_USER

DOTNET_ROOT=$HOME/.dotnet
DOTNET_INSTALL_URI=https://dot.net/v1/dotnet-install.sh
DOTNET_CHANNEL=5.0
DOTNET_RUNTIME=aspnetcore

curl -sSL $DOTNET_INSTALL_URI | bash /dev/stdin --channel $DOTNET_CHANNEL --runtime $DOTNET_RUNTIME
--install-dir $DOTNET_ROOT

Alternativ können Sie auch das benötigte Paket für Linux unter Alternatively, you can download the required package for Linux at https://dotnet.microsoft.com/download/dotnet/5.0 herunterladen, im Home-Verzeichnis des für Connect angelegten Benutzers ablegen und wie folgt entpacken in the home directory of the user created for Connect and unpack it as follows:

CONNECT_USER=connect
su - $CONNECT_USER

DOTNET_ROOT=$HOME/.dotnet
DOTNET_ARCHIVE=$HOME/aspnetcore-runtime-5.0.4-linux-x64.tar.gz

mkdir -p $DOTNET_ROOT
tar zxf $DOTNET_ARCHIVE -C $DOTNET_ROOT
rm $DOTNET_ARCHIVE

Allgemeine Informationen zur Installation der For general information about installing the .NET Core Runtime finden Sie unter folgendem Link, see the following link:

...

Informationen zu dem verwendeten Installationsskript finden Sie unter folgendem Link

Information about the installation script used can be found at the following link:

...

...

Installing the Connect

...

Server

To install the Connect Server, copy the archive containing the Connect Server and the archive containing the custom configuration to the home directory of the user created for Connect. Follow these steps to install the software (replace the blue highlighted name config.tar.gz with the name of the archive with configuration data provided for you):

CONNECT_USER=connect
su - $CONNECT_USER

CONNECT_ROOT=$HOME/connect
CONNECT_SERVER_ARCHIVE=$HOME/GalileoGroup.Connect.Server.Backend.tar.gz
CONNECT_CONFIG_ARCHIVE=$HOME/config.tar.gz

mkdir -p "$CONNECT_ROOT"

tar zxf "$CONNECT_SERVER_ARCHIVE" -C "$CONNECT_ROOT"
rm "$CONNECT_SERVER_ARCHIVE"

tar zxf "$CONNECT_CONFIG_ARCHIVE" -C "$CONNECT_ROOT"
rm "$CONNECT_CONFIG_ARCHIVE"

Konfiguration des Connect Servers

Der Connect Server mit bereits mit einer Lauffähigen Konfiguration ausgeliefert. Der integrierte Web­server 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

...

Configuration of the Connect Server

The Connect Server is delivered with a ready-to-run configuration. The integrated web server is available on port 80 after startup and responds to HTTP requests. For more information on customizing the configuration, please refer to the Configuration chapter.

Start the Connect Server in the foreground

To start the Connect Server in the foreground, proceed as follows:

CONNECT_USER=connect
su - $CONNECT_USER

DOTNET_ROOT=$HOME/.dotnet
CONNECT_ROOT=$HOME/connect

cd "$CONNECT_ROOT"

"$DOTNET_ROOT/dotnet" GalileoGroup.Connect.Server.Backend.dll

Start des Connect Servers im Hintergrund

...

Starting the Connect Server in the background

To start the Connect Server in the background, proceed as follows:

CONNECT_USER=connect
su - $CONNECT_USER

DOTNET_ROOT=$HOME/.dotnet
CONNECT_ROOT=$HOME/connect

LOG_DIR=$CONNECT_ROOT/log
LOG_FILE="$LOG_DIR/log-`date "+%Y%m%d-%H%M%S"`.txt"

mkdir -p $LOG_DIR

cd "$CONNECT_ROOT"

eval "nohup "$DOTNET_ROOT/dotnet" GalileoGroup.Connect.Server.Backend.dll >"$LOG_FILE" 2>&1 &"

echo "- PID:     $!"
echo "- Output: $LOG_FILE"

Es empfiehlt sich für diese Aktion ein entsprechendes Skript anzulegen. Entsprechende Vorlagen finden Sie im Ordner It is recommended to create a corresponding script for this action. You can find corresponding templates in the Scripts/Templates folder.

...

Exiting the Connect

...

Server

To terminate a Connect Server running in the foreground, press Ctrl + C.Um

alle im Hintergrund laufenden Connect Server zu beenden, gehen Sie wie folgt vorTo terminate all Connect Servers running in the background, proceed as follows:

CONNECT_USER=connect
su - $CONNECT_USER

DOTNET_ROOT=$HOME/.dotnet

ps -af | awk "{ if (\$8 == \"$DOTNET_ROOT/dotnet\" && \$9 == \"GalileoGroup.Connect.Server.Backend.dll\") { printf \"%s\\n\", \$2} }" | while read pid
do
  echo "Stopping process with PID $pid."
  kill $pid
done

Es empfiehlt sich für diese Aktion ein entsprechendes Skript anzulegen. Entsprechende Vorlagen finden Sie im Ordner It is recommended to create a corresponding script for this action. You can find corresponding templates in the Scripts/Templates folder.

Installation

...

under Docker

Der The 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 can be operated under Docker. On Windows, only the "modern" Docker variant (Docker with WSL2) is supported. For operation under Docker, we recommend using the delivery as a portable .NET assembly, since the platform-specific variants of the Connect Server are not explicitly tested for operation under Docker.

As a basis for creating the image, you need a Linux distribution and the current version of the 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 ASPruntime environment. A corresponding image is provided by Microsoft, for example, but it can also be created according to your own requirements.

The Connect delivery package already contains a Dockerfile for creating an image of the Connect Server based on the environment for 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 provided by Microsoft.

Before creating the image, the Dockerfile can be adapted to your own requirements, if necessary. The following example shows a Dockerfile for creating a container with the Debian based ASP.NET Core runtime environment, additional network tools, an editor and the Connect Server:

FROM http://mcr.microsoft.com/dotnet/aspnet

LABEL Description="This image contains the Connect! Server." Vendor="Galileo Group AG" Version="2021.0510"

RUN apt -y update
RUN apt -y upgrade
RUN apt -y install net-tools
RUN apt -y install iputils-ping
RUN apt -y install vim

COPY . /connect/app

RUN rm -r /connect/app/Repositories
RUN rm -r /connect/app/Certificates

VOLUME /connect/data

WORKDIR /connect/app

ENV Connect__Server__Paths__RepositoryPath=/connect/data/repositories
ENV Connect__Server__Paths__CertificatePath=/connect/data/certificates

ENTRYPOINT ["dotnet", "GalileoGroup.Connect.Server.Backend.dll", "settings=/connect/data/appsettings.json?"]

EXPOSE 80/tcp
EXPOSE 443/tcp

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 erstellenTo create the Docker image, change to the working directory using the cd command. Execute the following command to create an image with the name "connect":

docker build -t connect .

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 this example, the web server inside the Docker image uses the default configuration and can be reached via HTTP on port 80. If required, an HTTPS configuration on port 443 can be added. Externally, any port can be used for the container.

To avoid keeping the persistent data inside the container, this example creates an external directory named "c:\connect\data". In this directory, a JSON file with the name "appsettings.json" can be created, which contains the environment-specific configuration settings.

If necessary, required repositories can be placed in a subdirectory named "repositories".

In the following, a container with the name "myconnect" is created, which is based on the image "connect" and uses port 8000 for access via HTTP. To resolve server names, a DNS server must be specified for the container (in this example, 192.168.1.110). Erzeugen und starten Sie den Container über folgendes KommandoCreate and start the container using the following command:

docker run -d -v c:\connect\data:/connect/data -p 8000:80 --dns 192.168.1.110 --name myconnect connect

Falls erforderlich, können Sie einen DNS-Suffix hinzufügen, indem Sie den Parameter If necessary, you can add a DNS suffix by specifying the --dns-search <suffix> vor dem Parameter parameter before the --name angeben.Weitere Informationen finden Sie in der Dokumentation unter folgendem Linkparameter.

For more information, see the documentation at the following link:

...