Installation - Windows

Allgemeine Einführung

Diese Anleitung beschreibt die Installation des Procurat-Proxies als Service unter Windows.

Vorbereitung

Schritt 1: Erstellen des Clients im Proxy Controller

Öffnen Sie den Proxy Controller
Erstellen Sie einen neuen Client mit Add client. Die Funktion dynamically update DNS funktioniert ähnlich wie DynDNS, ändert sich die IP-Adresse der Anfragen der Proxy-Healthchecks, wird der Cloudflare-DNS Record ebenfalls aktualisiert

Schritt 2: Konfigurieren des Clients

Der Client lädt die Konfiguration laufend vom Controller herunter, und wendet Änderungen automatisch an. Somit muss die Konfiguration initial in der Weboberfläche erfolgen

Verfügbare Konfigurationswerte

Server Port	Der Port, auf welchem die installierte Anwendung startet und erreichbar ist (z.B 8080). Dieser Wert ist frei wählbar
Application URL	Die vollständige URL, unter welcher die Procurat-Software (nur Schnittstelle) erreichbar ist. Meist nach folgendem Schema: `https://[domain]:8443/procurat/api/v1`
Application Port (`Deprecated)`	Dieser Wert ist veraltet und wird nicht mehr verwendet.

Schritt 3: Erstellen einer Registrierung

Die Registrierungs-URL ist max. 24 gültig und kann nur einmal verwendet werden.

Bei der Installation des Services wird eine Registrierungs-URL benötigt. Diese wird verwendet, um den Client beim Controller anzumelden, einen API-Key zu erstellen und weitere Kommunikation zwischen Client und Controller zu sichern. Diese URL kann vorab erstellt werden

Klicken Sie auf den Tab Registrations in der Übersicht eines Clients
Klicken Sie auf Create Registration um eine neue Registrierungs-URL zu erstellen
Die URL kann nun über einen Toast (unten rechts) kopiert werden
Die Registrierung taucht mit Ablaufdatum und Status in der Übersicht auf. Falls sie durch ein Versehen erstellt wurde, kann sie hier wieder gelöscht werden

Die Serverseitige Einrichtung ist nun abgeschlossen, nun ist nur noch die Installation des Windows-Services nötig.

Einrichtung

Schritt 1: Herunterladen der ausführbaren Datei

Der Service (+ Installer) wird als .exe hier zur Verfügung gestellt: p5_proxy.exe

Schritt 2: Verschieben in Installationsverzeichnis

Der Dienst installiert sich im aktuellen Verzeichnis. Hier werden weitere Artefakte (Ein Verzeichnis für Zertifikate, Konfiguration und Logs) erstellt. Daher wird empfohlen, ein eigenes, wiedererkennbares Verzeichnis für den Dienst zu erstellen

Verschieben Sie den Dienst in das gewünschte Installationsverzeichnis

Schritt 3: Registrieren des Clients

Geben Sie folgenden Befehl (z.B in Powershell oder CMD) ein, um den Client zu registrieren

p5proxy.exe register

Geben Sie die zuvor erstellte Registrierungs-URL ein.

Schritt 4: Installieren als Windows-Dienst

Für diesen Befehl werden Administrationsrechte benötigt

Damit das Proxy zu jeder Zeit läuft, kann es als Dienst registriert werden. Führen Sie dafür folgenden Befehl aus

p5proxy.exe install

Der Dienst ist nun erfolgreich registriert und wird beim nächsten Systemstart automatisch gestartet. Sie können den Dienst mit dem Namen Procurat Proxy Service in der Windows-Dienstübersicht direkt starten.

Schritt 5: Überprüfen der Verbindung

Ist der Client erfolgreich registriert + gestartet, sendet er minütlich Heartbearts an den Controller. Diese aktualisieren den Status in der Oberfläche auf Online

Wird der Client nach spätestens 2 Minuten nicht als Online markiert, ist die Installation nicht erfolgreich abgeschlossen.

Schritt 5: API-Key generieren und in P5 einrichten

API Key generieren

openssl rand -hex 32

Generieren eines sicheren API Keys (z.B mit OpenSSL oder 1PasswordGenerator)
In der Procurat Administration in den Tab Alle Stammdaten wechseln
Eintrag erstellen + generierten Wert eingeben
API Key notieren bzw. im Elternportal eintragen