Installations- und Updateanleitung CMI DocumentSign

Es folgt eine Zusammenfassung, die den Betrieb des DocumentSign Services mit IIS beschreibt. 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

• On Premise Installation - Für CMI-Cloud ein YouTrack Ticket erstellen.
• Die .NET Core Runtime (Version 8.0.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.
• IIS: Wir empfehlen ausschliesslich IIS basiertes Deployment.

Abhängigkeiten

Die Technischen Abhängigkeiten sind hier zu finden.

Installation

Der Service wird als eine IIS Applikation installiert.

Application Pool

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

Bei den "Advanced Settings" für den Application-Pool muss folgendes sichergestellt sein:

• Start Mode = AlwaysRunning

Website

1. Im IIS unter Sites eine neue Website hinzufügt
2. Folgende Parameter befüllen:
   • Site name: Beliebig wählbar (Bsp. cmi-webapi-documentsign)
   • 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 unter \Installationsdateien im Zielverzeichnis kopieren.
   • Zielverzeichnis ist das Verzeichnis was beim Physical path eingetragen wurde
   • Appsettings.json Konfiguration wird von der CMI konfiguriert und ausgeliefert
   • Den Application Pool recyclen
4. Das Appsettings.json wird von der CMI ausgeliefert. Folgende Anpassungen müssen aber gemacht werden:
   • Unter Serilog.WriteTo.Args.Path den Pfad zum Log-Ordner inkl. Dateiname und Endung angeben (Beispiel.: C:\\temp\\logs.log). Die Application Pool Identity muss genügend Rechte haben um in diesem Ordner Dateien anzulegen.

Bei den "Advanced Settings" für die Site muss folgendes sichergestellt sein:

• Preload Enabled = true

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.

Datenbank

Die Datenbank muss initial erstellt werden. Die Anleitung ist hier zu finden.

Validierung

Wird die Website aufgerufen, so sollte eine Mandantenauswahl sichtbar sein.

Update

Anleitung

1. Die IIS-Website stoppen
2. Alle Dateien und Ordner bis auf die folgenden löschen:
   • (Datei) appsettings.json
   • (Datei) *.settings.json
3. Das ausgelieferte ZIP auf dem Server kopieren und den Inhalt unter \Installationsdateien im Zielverzeichnis kopieren (Achtung! Die obig aufgelisteten Dateien und Ordner nicht überschreiben)
4. Datenbank updaten (Anleitung)
5. Die IIS-Website wieder starten

Validierung

Wird die Website aufgerufen, so sollte eine Mandantenauswahl sichtbar sein.