Installations- und Updateanleitung CMI API

Einleitung

In diesem Kapitel wird der Betrieb der CMI API mit dem IIS (Microsoft Internet Information Services) beschrieben. Grundsätzlich kann der IIS gemäss der Dokumentation von Microsoft für eine ASP.NET Core konfiguriert werden.

Fachwörter (wie Application Pool) beziehen sich auf ein Windows mit englischem Sprachpaket. Diese Anleitung beschreibt eine Basis IIS Application Installation und kann daher an das eigene Deployment angepasst werden.

Voraussetzungen

• Die .NET Runtime (Version 8.0) muss auf dem Server installiert sein. Diese kann unter https://dotnet.microsoft.com/en-us/download/dotnet/thank-you/runtime-aspnetcore-8.0.0-windows-hosting-bundle-installer heruntergeladen werden.
• Ein IIS muss verfügbar sein.

Abhängigkeiten

Die technischen Abhängigkeiten sind hier zu finden.

Installation

Die CMI API wird als eine IIS Applikation installiert. Diese Anleitung beschreibt eine minimale Installation im IIS.

Application Pool

1. Unter "Application Pools" einen neuen Application Pool hinzufügen
2. Folgende Parameter befüllen:
   • Name: Frei wählbar (Bsp. cmi-api)
   • .NET CLR Version: No Managed Code
   • Managed pipeline mode: Integrated
   • Start application pool immediately: Aktiviert
3. Mit OK bestätigen.

Website

1. Im IIS unter Sites eine neue Website hinzufügt
2. Folgende Parameter befüllen:
   • Site name: Beliebig wählbar (Bsp. cmi-api)
   • Application pool: Den erstellen Application pool vom obigen Schritt auswählen
   • Physical path: Beliebiger Pfad, unter welchem sich die Installationsdateien der Applikation befinden werden
   • Binding type: Https oder Http (je nach Bedarf)
   • IP-Adresse: All Unassigned
   • Port: Frei wählbar
   • Hostname: Domäne eintragen
   • SSL certificate: Ein gültiges SSL-certificate, welches auf dem Host name gebunden ist (nur bei Https)
   • Start Website: immediately
3. Das ausgelieferte ZIP auf dem Server kopieren und den Inhalt im Zielverzeichnis kopieren.
   • Zielverzeichnis ist das Verzeichnis was beim Physical path eingetragen wurde
   • Den Application Pool recyclen

Appsettings.json

Die Konfiguration der Schnittstelle erfolgt in der Datei appsettings.json. Die Dokumentation dazu ist hier zu finden. Nach Anpassung der appsettings.json-Datei muss der Application-Pool Recyclet werden.

Validierung

Wird die Website aufgerufen, so sollte folgendes sichtbar sein:

Update-Anleitung

1. Die IIS-Website stoppen
2. Alle Dateien und Ordner bis auf die folgenden löschen:
   • (Datei) appsettings.json
3. Das ausgelieferte ZIP auf den Server kopieren und den Inhalt in das Zielverzeichnis kopieren (Achtung! Die oben aufgelisteten Dateien und Ordner nicht überschreiben)
4. Die IIS-Website wieder starten

Validierung

Wird die Website aufgerufen, so sollte folgendes sichtbar sein: