Web-Client-Konfiguration

Information

• Im Folgenden wird die Konfiguration des PLANTA Web-Clients beschrieben.

Grundlagen

Information

• Es gibt verschiedene Optionen, um Konfigurationen anzuwenden. Im Folgenden werden die Möglichkeiten von der niedrigsten zur höchsten Priorität aufgelistet.
•  Wenn eine Variable an mehr als einem Ort definiert ist, wird die Stelle mit der höchsten Priorität angewandt:
  1. appsettings.json: Haupt-(Default-)Konfiguration, Änderungen nicht empfohlen
  2. appsettings.[Environment].json: umgebungsspezifische (z. B. Produktion) Konfiguration
  3. Umgebungsvariablen: werden im Host-Betriebssystem definiert (z. B. mithilfe eines -e flag in einem Docker Container weitergegeben)
  4. Kommandozeilenparameter: können angewendet werden, wenn die Anwendung beispielsweise mithilfe eines Shell Scripts gestartet wurde

Parameter außerhalb des JSON-Formats definieren

Information

• Für Umgebungsvariablen und Kommandozeilenparameter muss ein bestimmtes Format verwendet werden:

Parameter innerhalb eines Blocks definieren

{
    "ConnectionSettings": {
        "User": "username"
    }
}

--ConnectionSettings:User=username

Parameter innerhalb eines Arrays definieren

{
    "ConnectionSettings": {
        "Servers": [
            {
             "Host":"serverA",
             "Port":1234
            },
            {
                "Host":"ServerB",
                "Port":4567
            }
        ]
    }
}

--ConnectionSettings:Servers:1:Port=9999

Parameter

Information

• Die folgenden Parameter können zur Konfiguration des Web-Clients verwendet werden.

Verbindungseinstellungen

Information

• Parameter, die den Serverstart und die Kommunikation mit dem PLANTA-Server definieren.
• Müssen innerhalb eines ConnectionSettings-Blocks definiert werden.

Server-Einstellungen

Authentifizierungs-Einstellungen

Information

• Parameter, mit denen konfiguriert wird, ob und wie der Reverse-Proxy uns über den authentifizierten Benutzer informiert. Hierzu ist der Einsatz von PLANTA secure erforderlich.
• Müssen innerhalb eines AuthenticationSettings-Blocks definiert werden.

WebAPI Authentifizierungs-Einstellungen

Adaptive Cards-Einstellungen

Signierungseinstellungen

Upload-Einstellungen

Information

• Parameter, die das Verhalten bei Datei-Uploads definieren.
• Müssen innerhalb eines FileUploadSettings-Blocks definiert werden.

Message Dumper-Einstellungen

Information

• Message Dumper speichert die Kommunikation mit dem PLANTA-Server, eine xml-Datei pro Session.
• Die Parameter müssen innerhalb eines MessageDumperSettings-Blocks definiert werden.

Logging-Einstellungen

Information

• Der PLANTA Web-Client verwendet Serilog für das Logging.
• Serilog verwendet so genannte "Sinks", um Logs anzuzeigen. Der Web-Client unterstützt derzeit die folgenden Sinks:
  • Konsole
  • Datei

Host-URL ändern

Information

• Defaultmäßig verwenden ASP.Net Core-Anwendungen die Ports 5000 (http) und 5001 (https).
• Mit dem Urls-Parameter kann das wie folgt überschrieben werden:

"Urls": "http://localhost:9000;https://localhost:9001",

--Urls:http://localhost:9000;https://localhost:9001