Installation primedocs-Server

Owned by Daniela Zimmermann
Last updated: Jul 26, 2024 by Robert Mühsig
4 min read

Diese Seite betrifft die OnPremises-Variante.
Bei der "Software as a Service"-Variante sind keine Serverinstallationen durch den Kunden notwendig.

Bevor Sie beginnen:

Voraussetzung für die Installation des primedocs-Servers ist eine Microsoft SQL Server Datenbank zum Speichern der Daten. Falls Sie keinen vorhandenen Datenbankserver verwenden können, können Sie eine SQL Express-Installation durchführen wie hier beschrieben. Die korrekte Konfiguration des SQL-Benutzers für primedocs ist hier beschrieben.

Installation

Im Installationspaket ist ein PowerShell-Skript "Install.ps1" enthalten, das die Installation vornimmt. Das Skript muss als Administrator ausgeführt werden, da unter anderem fehlende Windows Features aktiviert werden.

HINWEIS
Das Installationsskript ("Install.ps1") ist für die Installation von genau einer primedocs-Umgebung auf einem Server ausgelegt. Wenn mehrere primedocs-Umgebungen auf demselben Server laufen sollen, dann sind zusätzliche manuelle Konfigurationsschritte nötig. Siehe z. B. Multiple In-Process Applications in same Process auf der Seite Troubleshooting / Problembehandlung.

Execution Policy

Um das Skript zu starten, muss die Execution Policy auf Unrestricted gesetzt sein:

Set-ExecutionPolicy Unrestricted

Wenn Sie die Execution Policy nur temporär für die Installation anpassen möchten, kann diese wie folgt gesetzt werden:

Set-ExecutionPolicy Unrestricted -Scope Process

Die folgende Frage muss mit y für "Yes" beantwortet werden:

Execution Policy Change The execution policy helps protect you from scripts that you do not trust. Changing the execution policy might expose you to the security risks described in the about_Execution_Policies help topic at http://go.microsoft.com/fwlink/?LinkID=135170. Do you want to change the execution policy? [Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "N"): y

Skript ausführen

Die Installations-Zip-Datei muss vorgängig entpackt werden.

In der Datei "Install_Customization.ps1" können Anpassungen vorgenommen werden, falls es sich nicht um eine Standardinstallation handelt. Die entsprechenden Einstellungsmöglichkeiten sind in der Datei beschrieben.

Beim Aufruf von "Install.ps1" können Argumente mitgegeben werden. Diese sind in der Datei in einem grossen Kommentar beschrieben (unter "Usages").

Standardaufruf (hierfür muss zuvor ins Installationsverzeichnis navigiert werden, z. B. mit cd "C:\temp\primedocs_Install_Package"):

Weitere Aufrufmöglichkeiten sind in "Install.ps1" unter "Usages" beschrieben, so z. B. die Angabe eines Service Accounts, falls kein SQL-Benutzer genutzt werden soll.

Die beiden Datenbanken vom obigen Beispiel ("primedocs_Prod" und "primedocs_Prod_Operation") können entweder als leere Datenbanken bereits existieren. Ansonsten werden sie automatisch durch die primedocs-Serverapplikationen angelegt (Bedingungen siehe SQL-Server-Rollen / -Berechtigungen).

HINWEIS
Bei einer Installation der "WithoutIdS"-Variante (siehe Varianten) ist kein OperationDbConnectionString nötig.

Standardmässig fragt das Skript den Benutzer nach Informationen und Bestätigungen. Falls dies nicht gewünscht ist, kann als Argument -Force $true mitgegeben werden.

Skript-Ablauf

1. Benötigte Windows Features überprüfen

Im ersten Schritt wird überprüft, ob alle erforderlichen Windows Features (u. A. der Internet Information Service (IIS) mit http://ASP.NET) installiert sind und ob das Hosting Bundle für .NET 6-Applikationen installiert ist.

2. "primedocs"-Website im IIS

Im nächsten Schritt wird überprüft, ob bereits eine "primedocs"-Website mit den Application Pools im IIS registriert ist. Ist das der Fall, wird zum nächsten Schritt gegangen.

Falls die Website nicht gefunden wird, werden Sie gefragt, ob diese angelegt werden soll, mit der Angabe des Installationspfades und des Port. Die Standardeinstellungen werden in der Ausgabe angezeigt. Das Skript legt zudem folgende Application Pools im IIS an:

  • primedocs-Managed:
    Ist für die .NET Framework-basierten Serverapplikationen zuständig.

  • primedocs-Unmanaged-[...]:
    Für alle Serverapplikationen wird ein eigener Application Pool angelegt, wie z. B. primedocs-Unmanaged-AddressService für den "AddressService" oder primedocs-Unmanaged-HealthMonitor für den "HealthMonitor".

3. "primedocs"-Webapplikationen

In diesem Schritt werden die eigentlichen Webapplikationen in der "primedocs"-Website hinterlegt. Falls die Anwendungen bereits installiert sind, werden Sie gefragt, ob eine Aktualisierung stattfinden soll. Im Fall einer Aktualisierung handelt es sich um ein Server-Update, weswegen wir die Kontaktaufnahme mit unserem Support empfehlen.

4. "primedocs JobHost"-Scheduled Task

Im letzten Schritt erfolgt eine Abfrage, ob der "primedocs-JobHost" als "Scheduled Task" eingerichtet werden soll. Der primedocs-JobHost ist ein Konsolenprogramm, das z. B. Benutzerdaten im Hintergrund in einem bestimmten Intervall aktualisiert. Er sollte daher installiert werden.

Abschluss der Server-Installation

Nach der Installation sollten sowohl der IIS als auch die Webapplikationen und der Scheduled Task installiert sein.

Service Account

Die Standardinstallation geht von der Nutzung eines SQL-Benutzers aus. Es ist jedoch auch möglich, die primedocs-Serverapplikationen unter einem Service Account zu betreiben.

Stellen Sie hierfür folgende Konfiguration sicher:

  1. Der Service Account kann sich mit dem SQL Server bzw. mit der zukünftigen Datenbank verbinden.

  2. Der Service Account ist Mitglied der "IIS_IUSRS"-Group.
    Dieser Schritt wird vom Installationsskript automatisch erledigt, wenn beim Aufruf über die Argumente ein Security Account angegeben wird (siehe "Usages" in "Install.ps1"-Datei) und die entsprechende Abfrage bestätigt wird.

  3. Für die IIS_IUSRS-Gruppe muss in der Local Security Policy Log on as batch und Impersonate a client after authentication hinterlegt sein (dies entspricht einer Standard-IIS-Installation).
    Administrative Tools → Local Security Policy → Local Policies → User Rights Assignment

  4. Der Service Account hat Ändern-Rechte auf dem primedocs-Applikations- und Logverzeichnis (in der Standardinstallation ist das derselbe Ordner).
    Dieser Schritt wird für das Applikationsverzeichnis vom Installationsskript automatisch erledigt, wenn beim Aufruf über die Argumente ein Security Account angegeben wird (siehe "Usages" in "Install.ps1"-Datei) und die entsprechende Abfrage für die Ändern-Rechte bestätigt wird.

  5. Der Service Account muss im IIS als Benutzer in allen primedocs-Application Pools hinterlegt werden
    IIS → Application Pools → Advanced Settings → Identity → Custom account
    Zusätzlich muss Load User Profile auf true eingestellt werden (dies entspricht einer Standard-IIS-Installation).
    Dieser Schritt wird vom Installationsskript automatisch erledigt, wenn beim Aufruf über die Argumente ein Security Account angegeben wird (siehe "Usages" in "Install.ps1"-Datei).

  6. Der Service Account muss als ausführender Benutzer im "PrimeDocs.JobHost"-Task hinterlegt werden
    Task Scheduler → Task Scheduler Library → PrimeDocs.JobHost → Properties
    Dieser Schritt wird vom Installationsskript automatisch erledigt, wenn beim Aufruf über die Argumente ein Security Account angegeben wird (siehe "Usages" in "Install.ps1"-Datei).

  7. Im SQL-ConnectionString wird der Service Account verwendet (bei der Installation als Argument übergeben oder in "primedocs.config"-Datei anpassen)
    Dieser Schritt wird vom Installationsskript automatisch erledigt, wenn beim Aufruf über die Argumente der korrekte ConnectionString angegeben wird (siehe "Usages" in "Install.ps1"-Datei).

PrimeSoft AG, Bahnhofstrasse 4, 8360 Eschlikon, Switzerland