Konfiguration der Portal Applikation¶
Datei _config/portal.config¶
Die Installation des Portals ist optional. Wenn WebGIS nur als API für HTML/JavaScript-Clients genutzt wird, kann darauf verzichtet werden. In diesem Fall können Kartenanwendungen jedoch nur ohne zusätzliche Werkzeuge erstellt werden. Zudem steht ohne die Installation des Portals auch kein MapBuilder zur Verfügung.
Diese Datei wird – falls nicht vorhanden – beim ersten Start der API mit Default-Werten angelegt. Dieser Abschnitt zeigt, wie die Datei an eigene Anforderungen für einen produktiven Betrieb angepasst werden kann.
Die Datei ist – ähnlich wie die api.config – eine XML-Datei, die verschiedene Schlüssel-Werte-Paare enthält.
<?xml version="1.0" encoding="utf-8"?>
<configuration>
<appSettings>
<!-- Shared Crypto Keys -->
<add key="shared-crypto-keys-path" value="C:\apps\webgis/test/webgis-repository/security/keys" />
<!-- Allgemein -->
<add key="company" value="my-company" />
<add key="portal-name" value="webGIS Portal" />
<add key="portal-name-url" value="http://www.e-steiermark.com" />
<!-- Security -->
<!-- windows, token, clientid, forms, anonym (url) -->
<add key="security" value="anonym" />
<!-- erlaubte Methoden mit Beistrich getrennt, keine Leerzeichen !! -->
<add key="security_allowed_methods" value="anonym" />
<!-- Für die Erzeugung von Auswahllisten (Wenn Windows Auth verwendet wird) -->
<add key="portal-windows-authentication-ldap-directory" value="LDAP://my-domain" />
<add key="portal-windows-authentication-ldap-format" value="my-domain\{0}" />
<add key="use-local-url-scheme" value="true" />
<add key="allow-subscriber-user-access-page-settings" value="true" />
<!-- Advanced Security -->
<!-- default: true wenn false, ist kein Login mehr möglich (Security: In Internet keine Konfiguration mehr) -->
<add key="allow-subscriber-login" value="true" />
<!-- Erlaubte Origins (CORS) für den HMAC-Endpunkt, mit Beistrich getrennt -->
<add key="add-cors-origins-for-hmac" value="https://localhost,https://example.com" />
<!-- Url zum Portal, so wie es auch vom Anwender sichtbar ist -->
<add key="api" value="http://localhost:5001" />
<!-- Url zum Portal, wie es von Server aus sichtbar ist -->
<add key="api-internal-url" value="http://localhost:5001" />
<add key="portal-url" value="http://localhost:5002" />
<add key="portal-custom-content-rootpath"
value="C:\apps\webgis/test/webgis-repository/portal-page-content" />
<!-- EPSG Code der hauptsächlich verwendet wird und in dem Entfernungen gerechnet werden sollten -->
<add key="map-calc-crs" value="3857" />
<!-- Progessive Web App true/false, zu Zeit nicht in Verwendung -->
<add key="register-serviceworker" value="false" />
<!-- Cache -->
<add key="cache-provider" value="fs" />
<!-- Gleicher Connectionstring wie in api.config -->
<add key="cache-connectionstring" value="C:\apps\webgis/test/webgis-repository/db/cache" />
<!-- Cache Aside -->
<!-- optional: leer, redis, inapp -->
<add key="cache-aside-provider" value="inapp" />
<!-- 3600 Sekunden caching --> <!-- ConnectionString zu redis, zB localhost:6379 -->
<add key="cache-aside-connectionstring" value="3600" />
<!-- Subscriber Database -->
<!-- GleicherConnectionstring wie in api.config -->
<add key="subscriber-db-connectionstring"
value="fs:C:\apps\webgis/test/webgis-repository/db/subscriber" />
<!-- Benutzerdefinierte Layouots erlauben -->
<add key="query-custom-map-layout" value="true" />
</appSettings>
</configuration>
Abschnitt Allgemein¶
Attribut |
Beschreibung |
|---|---|
|
Eindeutige Kennung für das Unternehmen des Portalbetreibers (z. B. |
|
Text, der in der Titelzeile aller Portalseiten angezeigt wird (Standardwert: WebGIS Portal). |
|
URL zur Webseite des Portalbetreibers. Wird aufgerufen, wenn der Benutzer auf den Titelzeilen-Text klickt. |
Abschnitt Security¶
Siehe auch
Anhang Sicherheitsmaßnahmen für das WebGIS Portal: Überblick, Risikostufen und Empfehlungen für alle sicherheitsrelevanten Schlüssel.
Attribut |
Beschreibung |
|---|---|
|
Legt die Authentifizierungsmethode für die Anmeldung am Portal fest. Mögliche Werte sind |
|
Erlaubt die Anmeldung mit einer anderen Methode als der in |
|
Bestimmt, ob autorisierte Subscriber Inhalte auf Portalseiten bearbeiten dürfen. In geschlossenen Systemen kann dieser Wert auf |
|
In lokalen oder Offline-Umgebungen kann dieser Wert auf Gefahr Dieser Wert sollte nur in lokalen oder Offline-Umgebungen (z. B. für Testzwecke) auf |
Zusätzlich können hier optionale Anmeldeinformationen für gesicherte Endpunkte definiert werden, z. B. für das Löschen des (User) Caches. Diese Endpunkte sollten mit einem Passwort geschützt werden, um unbefugten Zugriff zu verhindern. Die folgenden Schlüssel ermöglichen die Konfiguration dieser Anmeldeinformationen:
<section name="security">
<!-- optional: credentials for secured endpoints, e.g. cache/clear -->
<add key="secure-endpoint-url-password" value="****************************" />
<add key="secure-endpoint-basicauth-username" value="admin" />
<add key="secure-endpoint-basicauth-password" value="**************************************" />
<!-- default: false. true disables the validation of TLS server certificates for outbound connections (not recommended) -->
<add key="allow-untrusted-server-certificates" value="false" />
</section>
Geändert in Version 8.26.4301: Serverzertifikate bei ausgehenden HTTPS-Verbindungen werden jetzt standardmäßig geprüft. Bei internen Diensten mit selbstsignierten Zertifikaten
sollte die interne CA im Zertifikatsspeicher des Servers installiert werden. Nur wenn das nicht möglich ist, kann die Prüfung mit
allow-untrusted-server-certificates auf true abgeschaltet werden (Sicherheitsrisiko: Man-in-the-Middle). Details siehe Ausgehende TLS-Verbindungen (Serverzertifikate).
Abschnitt Auswahllisten¶
Bei Verwendung der Windows-Authentifizierung können hier Konfigurationswerte für das LDAP-Verzeichnis definiert werden. Diese Werte werden beispielsweise genutzt, wenn einem Subscriber Berechtigungen für eine Portalseite zugewiesen werden. Die möglichen Optionen werden dann in Auswahllisten zur Verfügung gestellt.
Attribut |
Beschreibung |
|---|---|
|
Gibt das LDAP-Verzeichnis an, das für die Authentifizierung verwendet wird.
Beispiel: |
|
Definiert das Format für die Anmeldung im LDAP-Verzeichnis.
Beispiel: |
Abschnitt Cache Datenbank¶
Diese Datenbank speichert die Sessions. Sie muss die Tabelle webgis_cache enthalten (siehe oben). Wird zusätzlich die Portal-Anwendung genutzt, müssen sowohl die API als auch das Portal denselben Session-Cache verwenden.
Die Werte müssen mit denen in der api.config übereinstimmen:
Attribut |
Beschreibung |
|---|---|
|
Definiert den Speicherort des Caches. Mögliche Werte:
|
|
Connection-String für die Datenbank oder Pfad im Filesystem. |
Abschnitt Cache Aside (optional)¶
Die hier angegebenen Werte müssen mit denen in der api.config übereinstimmen.
Attribut |
Beschreibung |
|---|---|
|
Bestimmt den Cache-Mechanismus für das Cache-Aside-Verfahren. Mögliche Werte: |
|
Definiert die Verbindungseinstellungen für den Cache-Anbieter. Beispiel: |
Abschnitt Subscriber Datenbank¶
Die hier angegebenen Werte müssen mit denen in der api.config übereinstimmen.
Attribut |
Beschreibung |
|---|---|
|
Connection-String zur zuvor eingerichteten Datenbank oder Pfad zum entsprechenden Verzeichnis im Filesystem. |
Abschnitt Urls¶
Attribut |
Beschreibung |
|---|---|
|
URL zur API, wie sie für den Anwender sichtbar ist. |
|
Interne URL, die vom Portal für die Kommunikation mit der API genutzt wird, z. B. für den Zugriff auf den Storage. Wenn beide Anwendungen auf demselben Server installiert sind, kann eine lokale Adresse verwendet werden, z. B. |
|
URL des Portals (dieser Anwendung), wie sie für den Anwender sichtbar ist. Diese wird beispielsweise verwendet, um Links für das Teilen von Karten zu generieren. |
Abschnitt Advanced Security¶
Siehe auch
Anhang Portal-CORS und CORS und der HMAC-Endpunkt sowie Übersicht aller sicherheitsrelevanten Schlüssel.
Attribut |
Beschreibung |
|---|---|
|
Steuert, ob sich Subscriber an dieser Instanz anmelden können. Eine detaillierte Beschreibung dieses Schlüssels befindet sich in der |
|
Ermöglicht die Verwendung benutzerdefinierter Layouts im Kartenviewer, abhängig von der Bildschirmgröße. Mit diesem Schlüssel kann festgelegt werden, ob benutzerdefinierte Layouts zugelassen ( |
|
Kommagetrennte Liste der Origins (Server), von denen aus der Über diesen Endpunkt werden Zugangsdaten (Keys) für den Zugriff auf die API für den aktuell angemeldeten Benutzer abgeholt. Das darf nicht von beliebigen Seiten aus möglich sein: Eine Schadseite könnte sonst im Hintergrund den Der Wert Eine ausführliche Erklärung mit Beispiel steht im Anhang: CORS und der HMAC-Endpunkt. Gefahr Der Wildcard |
|
Kommagetrennte Liste zusätzlicher Origins (Server), die Aufrufe an das Portal (alle Seiten außer Die Portal-Url und die API-Url sind immer erlaubt und müssen nicht angegeben werden. Aufrufe von nicht angeführten Origins werden vom Browser blockiert. Normalerweise ist hier kein Eintrag notwendig. Die Angabe erfolgt mit Schema und ggf. Port, ohne Pfad (z. B. Der Wert Bisher wurde für diese Aufrufe jede anfragende Origin (inklusive Anmeldung) erlaubt. Seiten auf fremden Servern müssen nun hier angeführt werden. Gefahr Der Wildcard |
|
Standard: |
Abschnitt Logging¶
<!-- only for debugging, never in production -->
<add key="trace" value="true" />
<add key="tracePath" value="C:\\apps\\webgis\\local\\webgis-repository\\logs" />
Attribut |
Beschreibung |
|---|---|
|
Aktiviert das Logging für Debugging-Zwecke. Bei Aktivierung wird eine Gefahr Diese Funktion sollte ausschließlich zu Debugging-Zwecken genutzt und niemals in einer Produktionsumgebung aktiviert werden. |
|
Definiert das Verzeichnis, in dem die |