Konfigurierbare Umgebungsvariablen

Beim Erstellen des OPC Router Containers können Umgebungsvariablen angelegt werden, die innerhalb des Containers sichtbar sind. Mithilfe der hier angegebenen Umgebungsvariablen kann der OPC Router konfiguriert werden, indem diese beim Start ausgelesen werden.

hinweis

Diese Umgebungsvariablen gelten nicht nur für den OPC Router Docker Container, sondern auch für Windows-Installationen. Allerdings müssen auch bei Windows-Installationen die Dienste „OPCRouter5-Service“ und „OPCRouter5-Management“ neu gestartet werden, damit die geänderten Umgebungsvariablen erkannt werden.

Allgemeine Umgebungsvariablen

Umgebungsvariable	Beschreibung	Beispielwert
OR_I_ACCEPT_EULA	Durch Setzen auf true wird der Endbenutzer-Lizenzvereinbarung zugestimmt. Erforderlich, damit die Anwendung ausgeführt werden kann.	true
INITIAL_USERNAME	Legt den Namen des initialen Benutzerkontos für das Web Management fest. Der initiale Benutzer verfügt über die Rolle Admin (siehe Nutzerrollen) und wird bei einem Neustart des Containers automatisch wieder mit dieser Rolle angelegt.	or5
INITIAL_PASSWORD	Legt das Passwort des initialen Benutzerkontos für das Web Management fest. Benutzen Sie entweder dies oder INITIAL_PASSWORD_FILE.	Don'tUseThis,ItWouldn'tBeSecure!
INITIAL_PASSWORD_FILE	Gibt den Pfad zu einer Datei auf dem Container an, aus der das Passwort für das initiale Benutzerkonto für das Web Management entnommen wird. Benutzen Sie entweder dies oder INITIAL_PASSWORD.	/inray/defaultpw

Umgebungsvariablen für das Web Management

Umgebungsvariable	Beschreibung	Beispielwert
OR_WEB_HTTP_PORT	Legt den Port für HTTP-Verbindungen fest. Wenn HTTPS verfügbar ist, verweist der Port auf den HTTPS-Port. (Standardwert: 8080)	80
OR_WEB_HTTPS_PORT	Legt den Port für HTTPS-Verbindungen fest. HTTPS erfordert ein gültiges SSL-Zertifikat. (Standardwert: 8443)	443
OR_WEB_HTTPS_CERTIFICATE_PEM	Setzt PEM-Enkodiertes SSL-Zertifikat. Benutzen Sie entweder dies oder OR_WEB_HTTPS_CERTIFICATE_PEM_FILE.	-----BEGIN CERTIFICATE----- [...] -----END CERTIFICATE-----
OR_WEB_HTTPS_CERTIFICATE_PEM_FILE	Gibt den Pfad zu einer PEM-Enkodierten Datei auf dem Container an, aus das SSL-Zertifikat entnommen wird. Benutzen Sie entweder dies oder OR_WEB_HTTPS_CERTIFICATE_PEM.	/inray/https.pem
OR_WEB_HTTPS_CERTIFICATE_KEY_PEM	Setzt privaten Schlüssel des PEM-Enkodierten SSL-Zertifikat. Benutzen Sie entweder dies oder OR_WEB_HTTPS_CERTIFICATE_PEM_FILE.	-----BEGIN RSA PRIVATE KEY----- [...] -----END RSA PRIVATE KEY-----
OR_WEB_HTTPS_CERTIFICATE_KEY_PEM_FILE	Gibt den Pfad zum privaten Schlüssel des PEM-Enkodierten SSL-Zertifikats auf dem Container an. Benutzen Sie entweder dies oder OR_WEB_HTTPS_CERTIFICATE_KEY_PEM.	/inray/https.key
OR_ENABLE_HTTP_LOGGING	Kann auf true gesetzt werden, um die Protokollierung von Webanfragen zu aktivieren.	true
OR_WEB_DISABLE_HTTPS	Kann auf false gesetzt werden, um HTTPS zu aktivieren. (Standardwert: true)	false
OR_RATE_LIMITING_ENABLED	Kann auf false gesetzt werden, um das Rate Limiting zu deaktivieren (Standardwert: true)	false

Umgebungsvariablen für die Authentifizierung im Web Management

Umgebungsvariable	Beschreibung	Beispielwert
INITIAL_USERNAME	Legt den Namen des initialen Benutzerkontos für das Web Management fest.	or5
INITIAL_PASSWORD	Legt das Passwort des initialen Benutzerkontos für das Web Management fest. Benutzen Sie entweder dies oder INITIAL_PASSWORD_FILE.	Don'tUseThis,ItWouldn'tBeSecure!
INITIAL_PASSWORD_FILE	Gibt den Pfad zu einer Datei auf dem Container an, aus der das Passwort für das initiale Benutzerkonto für das Web Management entnommen wird. Benutzen Sie entweder dies oder INITIAL_PASSWORD.	/inray/defaultpw
AUTH_DB_CONNECTION_STRING	Setzt den Verbindungsstring zur OPC Router Authentifizierungsdatenbank. Benutzen Sie entweder dies oder AUTH_DB_CONNECTION_STRING_FILE.	Data Source=OPCRouterWebConfig.db;
AUTH_DB_CONNECTION_STRING_FILE	Gibt den Pfad zu einer Datei auf dem Container an, aus dem der Verbindungsstring zur OPC Router Authentifizierungsdatenbank entnommen wird. Benutzen Sie entweder dies oder AUTH_DB_CONNECTION_STRING.	/inray/authdbconn
AZURE_AD_INSTANCE	Setzt die Azure Active Directory Instanz.	https://login.microsoftonline.com/
AZURE_AD_DOMAIN	Setzt die Domäne des Azure Active Directory Tenants.	contoso.onmicrosoft.com
AZURE_AD_TENNANT_ID	Setzt die Azure Active Directory Tenant ID.	123456ab-1a2b-3c45-67de-1234ab-567cd8
AZURE_AD_CLIENT_ID	Setzt die Azure Client ID.	11111111-1111-1111-1111-111111111111
AZURE_AD_CALLBACK_PATH	Setzt den relativen Request-Pfad, dem der User-Agent übergeben wird. (Standardwert: /signin-oidc)	/signin-oidc
AZURE_AD_SIGNED_OUT_CALLBACK_PATH	Setzt den relativen Request-Pfad, dem der User-Agent nach Ausloggen vom Identity Provider übergeben wird. Siehe post_logout_redirect_uri in http://openid.net/specs/openid-connect-session-1_0.html#RedirectionAfterLogout. (Standardwert: /signout-callback-oidc)	/signout-callback-oidc
OR_DISABLE_AUTH	Schaltet die Nutzerauthentifizierung des Web Managements aus, wenn auf true gesetzt.	true
OR_DISABLE_WIN_AUTH	Schaltet die Windows-Nutzerauthentifizierung des Web Managements aus, wenn auf true gesetzt.	true

Umgebungsvariablen für die Lizenzierung

Umgebungsvariable	Bedeutung
OR_LICENSE_KEY	Der Lizenzschüssel der Lizenz
OR_LICENSE_KEY_FILE (alternativ zu OR_LICENSE_KEY)	Pfad zu einer Datei mit dem Lizenzschlüssel der Lizenz.
OR_LICENSE_OPCROUTERID	Die OPC Router ID der Lizenz
OR_INSTANCE_NAME	Name für das Lizenzierte System
OR_LICENSE_IGNORE_ACTIVATION_ERROR (optional)	Wenn dieser Parameter auf true gesetzt ist, werden Fehler bei der Aktivierung ignoriert.
OR_LICENSE_HOLDER (optional)	Name des Lizenznehmers
OR_LICENSE_LOCATION (optional)	Standort des Systems
OR_LICENSE_DESCRIPTION (optional)	Zusätzliche Beschreibung

Umgebungsvariablen für die Redundanz

OR_REDUNDANCY_MODE

Wert	Bedeutung
0 oder disabled	Die Redundanz ist inaktiv
1 oder primary	Der OPC Router ist als Primärdienst aktiv
2 oder secondary	Der OPC Router ist als Sekundärdienst aktiv

hinweis

Groß- und Kleinschreibung wird nicht unterschieden

Umgebungsvariable	Default	Beschreibung
OR_REDUNDANCY_SHARED_KEY		Zeichenfolge, die für die Authentifizierung des OPC Routers genutzt wird. Dieser Schlüssel muss beim Primär- und Sekundärdienst gleich sein. Ein leerer Schlüssel ist ungültig und verhindert den Verbindungsaufbau.
OR_REDUNDANCY_SHARED_KEY_FILE		Alternativ kann der Schlüssel auch als Textdatei angegeben übergeben werden.
OR_REDUNDANCY_ADDRESS		Adresse des Primärdienstes. Diese wird im URL-Format angegeben (http(s):Hostname/IP-Adresse:Port). Als Port muss der Port angegeben werden, unter dem das Web Management (die Web-Oberfläche des OPC Routers) erreichbar ist. Beispiel: https://example.local:5000
OR_REDUNDANCY_PRIMARY_TIMEOUT	10	Zeit in Sekunden, nach der der Sekundärdienst als getrennt gilt, wenn kein Heartbeat gesendet wurde.
OR_REDUNDANCY_SECONDARY_HEARTBEAT_INTERVAL	5	Das Intervall in Sekunden, in dem der Sekundärdienst versucht den Primärdienst zu erreichen. Hinweis: Dieser Wert muss unter dem Timeout des Primärdienstes liegen, damit die Verbindung im Primärdienst nicht ständig als getrennt angesehen wird.

Umgebungsvariablen der Datenbank

Umgebungsvariable	Beschreibung	Beispielwert
OR_DATABASE_CONNECTION_STRING	Setzt den Verbindungsstring zum Aufbau einer Verbindung zu einer externen MongoDB. Überschreibt die Verbindung zur internen Datenbank, falls vorhanden. Benutzen Sie entweder dies oder OR_DATABASE_CONNECTION_STRING_FILE.	mongodb://127.0.0.1:27017
OR_DATABASE_CONNECTION_STRING_FILE	Gibt den Pfad zu einer Datei auf dem Container an, aus der der Verbindungsstring zum Aufbau einer Verbindung zu einer externen MongoDB entnommen wird. Überschreibt die Verbindung zur internen Datenbank, falls vorhanden. Benutzen Sie entweder dies oder OR_DATABASE_CONNECTION_STRING.	/inray/dbconnection
OR_DATABASE_USERNAME	Setzt den MongoDB-Benutzer, der für die Authentifizierung verwendet werden soll.	root
OR_DATABASE_PASSWORD	Setzt das Passwort des MongoDB-Benutzers, das für die Authentifizierung verwendet werden soll. Benutzen Sie entweder dies oder OR_DATABASE_PASSWORD_FILE.	AlsoDon'tUseThis!
OR_DATABASE_PASSWORD_FILE	Gibt den Pfad zu einer Datei auf dem Container an, aus der das Passwort für den MongoDB-Benutzer, der für die Authentifizierung verwendet wird, entnommen wird. Benutzen Sie entweder dies oder OR_DATABASE_PASSWORD.	/inray/dbpw
OR_DATABASE_NAME_PREFIX	Setzt ein Namens-Prefix für die Config, Runtime und Status Datenbanken.	OR5
OR_DATABASE_CERTIFICATE_FILE	Gibt den Pfad zu einer Datei auf dem Container an, aus der das x.509-Zertifikat für die Authentifizierung mit der MongoDB entnommen wird.	/inray/db.pem

Umgebungsvariablen zum Import von Projektdateien

Umgebungsvariable	Beschreibung	Beispielwert
OR_IMPORT_SOURCE	Gibt den Pfad zu einer OPC Router Projektdatei auf dem Container an, die beim Start werden soll.	/inray/project.rpe
OR_IMPORT_CLEAR_CONFIG		true

Relevante Umgebungsvariablen von ASP.NET

Umgebungsvariable	Beschreibung	Beispielwert
ASPNETCORE_FORWARDEDHEADERS_ENABLED	Wenn auf true gesetzt, werden die Header-Informationen der Anwendung übertragen. Dies ist für die Verbindung mit Reverse-Proxys erforderlich. (Standardwert: false)	true