Skip to main content
Skip table of contents

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

    4. Kommandozeilenparameter

Parameter außerhalb des JSON-Formats definieren

Information

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

Parameter innerhalb eines Blocks definieren

JSON:

Kommandozeile:

JS 
{ 
	"ConnectionSettings": { 
		"User": "username" 
	} 
}
CODE 
--ConnectionSettings:User=username

Parameter innerhalb eines Arrays definieren

JSON:

ServerB-Port in der Kommandozeile überschreiben:

JS 
{ 
	"ConnectionSettings": { 
		"Servers": [ 
			{ 
			 "Host":"serverA", 
			 "Port":1234 
			}, 
			{ 
				"Host":"ServerB", 
				"Port":4567 
			} 
		] 
	} 
}
CODE 
--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.

  • Sie müssen innerhalb des Blocks ConnectionSettings definiert werden.

Parameter

Typ

Default

Beschreibung

CompressionLevel

int

6

Zlib compression level, Zahl zwischen 0 und 9. Wird ignoriert, wenn UseCompression = “false”.

CultureCode

string

de-DE

Culture Code, der von der Anwendung verwendet wird. Hängt vom Host-Betriebssystem ab. Eine Liste von Culture Codes findet sich auch online.

IndividualParameters

string

null

individual_parameters-Parameter, der beim Server-Start gesendet wird

KeepAliveTimeout

int

60

Zeitintervall zwischen Keepalive-Signalen an den PLANTA-Server, in Sekunden

RoutingRequestTimeout

int

5

Request Timeout für Routing-Anfragen an PLANTA link

RoutingWebHook

string

null

Der PLANTA link Webhook, der für das Routing benötigt wird

PanelDestructionDelay

int

1440

Zeit, in der der Web-Server die Panel-Informationen speichert, wenn der Benutzer die Verbindung abgebrochen oder die Seite verlassen hat, in Minuten

Password

string

null

password-Parameter, der beim Server-Start gesendet wird

SessionDestructionDelay

int

7200

Zeit, in der der Web-Server die Session-Informationen speichert, wenn der Benutzer die Verbindung abgebrochen oder die Seite verlassen hat, in Minuten

Servers

array

null

Liste der PLANTA-Server, muss mindestens einen Eintrag enthalten. Mehr Informationen

UseCompression

bool

true

Definiert, ob die Kommunikation mit dem PLANTA-Server komprimiert werden soll

User

string

null

user-Parameter, der beim Server-Start gesendet wird

UseSSL

bool

false

Definiert, ob SSL für die Kommunikation mit dem PLANTA-Server aktiviert sein soll

Einstellungen des Parameters Servers

Parameter

Typ

Beschreibung

Host

string

Server-Host-Name

Port

int

Server-Port

AI-Einstellungen

Parameter

Typ

Beschreibung

ChatHost

string

URL des AI-Assistenten-Chats.

Die Konfiguration des KI-Assistenten wird in einem separaten Container vorgenommen. Siehe hier.

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 PLANTA secure erforderlich.

  • Sie müssen innerhalb des Blocks AuthenticationSettings definiert werden.

Parameter

Typ

Default

Beschreibung

ProxyAuth

bool

false

Wenn diese Option aktiviert ist, sendet der Webclient während der Sitzungsinitialisierung eine Nachricht an den Server, die ihn über die Vorauthentifizierung und die entsprechende Benutzerkennung informiert.

JwtAuth

bool

false

When enabled, the Webclient will use JWT/OIDC for authentication (enables OIDC flows).

JwtAuthOnClient

bool

false

When true the client initiates the OIDC login flow by itself; otherwise the OIDC login flow will be initiated by reverse proxy.

ProxyUserFormat

string

plain

Das Format, in dem der Wert bereitgestellt wird. Bisher ist nur das Format "plain" implementiert, das den Header-Wert an den Server weitergibt.

ProxyUserHeader

string

x-forwarded-user

Der Name des HTTP-Header-Feldes, das die vom Reverse-Proxy authentifizierte Benutzer-ID enthält.

ProxyUserAccessToken

string

x-forwarded-access-token

Der Name des HTTP-Cookies, das das JWT-Zugriffstoken enthält

ProxyUserIdToken

string

x-forwarded-id-token

Der Name des HTTP-Cookies, das das JWT-ID-Token enthält

AppPathBase

string

/

Der Web-Basispfad, den der Reverse-Proxy für den Webclient verwendet, z. B. wenn der Webclient auf dem Reverse-Proxy unter http://www.example.com/webclient erreichbar ist, lautet der Basispfad /webclient.

ProxyLogoutRoute

string

Logout-Route, die aufgerufen wird, wenn der Benutzer seine Sitzung auf dem Reverse-Proxy beenden möchte.

OidcSettings

OIDC settings

Konfiguration für die OpenID Connect-Authentifizierung.

ReverseProxyJwtSettings

ReverseProxyJwtSettings

Konfiguration für die JWT-Authentifizierung über Reverse-Proxy (standardmäßig Cloudflare).

ReverseProxyJWT-Einstellungen

Parameter

Typ

Defaut

Beschreibung

HeaderKey

string

Cf-Access-Jwt-Assertion

The HTTP header key that contains the application JWT from the reverse proxy (default: Cf-Access-Jwt-Assertion). The authentication service also checks if the header name contains Cf- to detect Cloudflare usage.

Der HTTP-Header-Schlüssel, der das Anwendungs-JWT vom Reverse-Proxy enthält. Der Authentifizierungsdienst überprüft auch, ob der Header-Name Cf-enthält, um die Verwendung von Cloudflare zu erkennen.

IssuerUrl

string

Erwarteter iss Claim-Wert des eingehenden Tokens (z. B. Ihre Cloudflare Access Issuer URL).

JwksUrl

string

JWKS-Endpunkt-URL, die zur Validierung der Token-Signatur verwendet wird.

Audience

string

Erwarteter aud Claim-Wert. Bei Cloudflare Access ist dies in der Regel der 64-stellige Hex-Tag.

Hinweise

  • Wenn JwtAuth ist true und JwtAuthOnClient ist false, versucht der Client, die vom Reverse-Proxy bereitgestellten Token entweder in Cookies (Standard-OIDC-Cookies) oder im konfigurierten HeaderKeyzu finden. Wenn HeaderKey ein Cf-Präfix enthält und ein passender Request-Header vorhanden ist, wird der Reverse-Proxy/Cloudflare-Flow verwendet. .

  • Nach erfolgreicher Validierung sendet der Client eine XML-Nachricht vom Typ <ProxyToken type="1" .../> an das Backend, die das Anwendungstoken in access_token enthält. Das Backend muss type="1" unterstützen und access_token als validiertes Reverse-Proxy-JWT behandeln.

OIDC-Einstellungen

Information

  • Parameter zum Konfigurieren der OpenID Connect-Authentifizierung.

  • Sie müssen innerhalb des Blocks AuthenticationSettings.OidcSettings konfiguriert werden.

Parameter

Typ

Default

Beschreibung

ClientId

string

Die OAuth-Client-ID, die für die Token-Validierung verwendet wird.

ClientSecret

string

Der Client-Secret, der für die Authentifizierung beim OIDC-Anbieter verwendet wird.

DiscoveryUrl

string

Die URL für das OIDC-Erkennungsdokument.

Scope

string

Der vom OIDC-Anbieter angeforderte Zugriffsbereich.

WebAPI Authentifizierungs-Einstellungen

Parameter

Typ

Default

Beschreibung

APIKey

string

APIKEY

API-Schlüssel, der zum Erreichen der Web-API-Endpunkte verwendet wird

Adaptive Cards-Einstellungen

Signierungseinstellungen

Parameter

Typ

Default

Beschreibung

RsaPrivateKeyXml

string

XML-formatierter privater RSA-Schlüssel zum Signieren von Adaptive Cards

Upload-Einstellungen

Information

  • Parameter, die das Verhalten bei Datei-Uploads definieren.

  • Sie müssen innerhalb des Blocks FileUploadSettings definiert werden.

Parameter

Typ

Default

Beschreibung

CompressionLevel

int

6

Zlib compression level, Zahl zwischen 0 und 9. Wird ignoriert, wenn UseCompression = false

AllowedExtensions

string

.doc, .docx, .xls, .txt

Dateiendungen, die hochgeladen werden dürfen

MaxFileSize

int

2000000

Maximale Dateigröße von Dateien, in kB

ChunkSize

int

100000

Wenn eine Zahl > 0 definiert wird, wird die Datei in Chunks der angegebenen Größe (in kB) hochgeladen. Wird 0 definiert, wird die Datei in einem Request hochgeladen.

TemporaryFilePath

string

.

Pfad, unter dem Dateien während des Uploads temporär gespeichert werden

Message Dumper-Einstellungen

Information

  • Message Dumper speichert die Kommunikation mit dem PLANTA-Server, eine xml-Datei pro Session.

  • Die Parameter müssen innerhalb des Blocks MessageDumperSettings definiert werden.

Parameter

Typ

Default

Beschreibung

Enabled

bool

true

Message Dump-Feature aktivieren

LogDirectory

string

.\Logs\Dump

Pfad, unter dem Message Dump-Dateien gespeichert 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:

JSON:

Kommandozeile:

JS 
"Urls": "http://localhost:9000;https://localhost:9001",
CODE 
--Urls:http://localhost:9000;https://localhost:9001

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.

Contact Support Close