Installation

docker-compose.yml

Dies ist ein möglichst umfangreiches Beispiel für eine docker-compose.yml. Es werden in den meisten Fällen keineswegs alle hier demonstrierten Einstellungsmöglichkeiten benötigt. Die einzelnen Optionen werden im Verlauf dieses Abschnitts näher erläutert. Auskommtierte Zeilen sind initiell optional.

docker-compose.yml

version: '3'

services:
    gws:
        image: gbdconsult/gws-amd64:8.0
        container_name: gws
#       restart: unless-stopped
#       logging:
#           driver: syslog
#           options:
#               tag: GWS_APP
        ports:
            - "80:80"
#           - "443:443"
        volumes:
            - /var/gws/data:/data:ro
            - /var/gws-var:/gws-var
#           - /var/raster:/data/raster:ro
#           - /etc/letsencrypt/live/webgis.example.com:/data/ssl:ro
        tmpfs:
            - /tmp
        environment:
#           - MANIFEST=/data/MANIFEST.json
#           - GWS_CONFIG=/data/config.cx
#           - PGSERVICEFILE=/data/pg_service.conf
#           - GWS_LOG_LEVEL=INFO
#           - HTTP_PROXY=http://proxy.example.com:8080
#           - HTTPS_PROXY=http://proxy.example.com:8080
#           - NO_PROXY=localhost
#       extra_hosts:
#           - "host.docker.internal:host-gateway"
#       depends_on:
#           - qgis

    qgis:
        image: gbdconsult/qgis-amd64:8.0
        container_name: qgis
#       restart: unless-stopped
#       logging:
#           driver: syslog
#           options:
#               tag: GWS_QGIS
        volumes:
            - /var/gws/data:/data:ro
            - /var/gws-var:/gws-var
#           - /var/raster:/data/raster:ro
        tmpfs:
            - /tmp
        environment:
#           - PGSERVICEFILE=/data/pg_service.conf
#           - QGIS_SERVER_PROJECT_CACHE_STRATEGY=periodic
#           - QGIS_DEBUG=0
#           - QGIS_WORKERS=4
#           - SVG_PATHS=/data/web/svg
#           - HTTP_PROXY=http://proxy.example.com:8080
#           - HTTPS_PROXY=http://proxy.example.com:8080
#           - NO_PROXY=localhost
#       extra_hosts:
#           - "host.docker.internal:host-gateway"

Images & Versions

Die Images für die GBD WebSuite sind unter https://hub.docker.com/u/gbdconsult zu finden. Die relevanten Images sind: gws-amd64, qgis-amd64, gws-arm64 und qgis-arm64.

Es stehen Images für amd64 sowie arm zur Verfügung.

Version 8.0 zeigt stets auf die aktuellste 8.0.x. Sobald der nächste Release (z.B. 8.1) stabil ist, wird dies auf https://gbd-websuite.de/help.html angekündigt. Releases sind nicht immer Kompatibel, es ist also zu erwarten, dass Sie ein paar Änderungen an der Konfiguration vornehmen müssen wenn Sie von z.B. 8.0 auf 8.1 upgraden.

Es gibt sowohl ein Image für die GBD WebSuite gbdconsult/gws-<arch>:<version>, sowie für den unterstüzenden QGIS-Server (gbdconsult/qgis-<arch>:<version>). Für die Verfügbarkeit einiger Features müssen beide Images laufen.

Volumes & Mounts

Im docker-compose.yml Beispiel werden Verzeichnisse vom Host-Dateisystem in den Container eingebunden.

Sollen Volumes verwendet werden, muss für den Anwender der die Konfiguration in /data schreibt eine Zugriffsmöglichkeit durch einen weiteren Container geschaffen werden welcher scp/sftp/smb zur Verfügung stellt.

Für die im Beispiel verwendete Möglichkeit mit Dateisystem Mounts, ist zu beachten dass die Berechtigungen im Host Dateisystem relevant sind. Dafür kann es nötig sein die uid/gid (Default: 1000/1000) des Users im Container explizit zu setzen. Siehe Umgebungsvariablen.

Ports

Die GBD WebSuite antwortet auf HTTP und HTTPS Anfragen auf den Standardports 80/http und 443/https. Haben Sie durch Hinterlegen von Zertifikaten in der Konfiguration HTTPS aktiviert, so wird ein permanenter Redirect auf https hinterlegt.

Logging

Ohne den auskommentierten Logging Block im Beispiel wird das Logging von Docker verwendet, und die Logs sind über docker logs gws bzw. docker logs qgis abrufbar.

Wird der Logging Block einkommentiert, werden alle Ausgaben in die Datei /var/log/syslog weitergeleitet und mit einem entsprechenden Tag versehen nach dem gefiltert werden kann. z.B. sudo tail -f /var/log/syslog | grep "GWS_".

Dies sind Features von Docker, nicht von der GBD WebSuite. Weitere Informationen dazu sind in der Dokumentation von Docker zu finden.

Umgebungsvariablen

WebServer, URLS, Rewrites

Der interne WebServer (nginx) des gws-Containers benötigt mindestens eine Konfigurierte site mit entsprechenden Rewrites um die einzelnen Seiten und Karten der Applikation unter leserlichen URLs anzeigen zu können.

Eine minimale Beispielhafte Konfiguration finden Sie im TODO LINK starterguide

Eine Auführliche Dokumentation finden Sie im Thema TODO LINK (WEBSERVER SITES URLS REWRITES)

web.ssl {
    crt "/data/ssl/example.com.crt"
    key "/data/ssl/example.com.key"
}

QGIS Server

In dem docker-compose.yml Beispiel ist der qgis-Container für den gws-Container wie folgt zu erreichen. Falls Sie die Konfiguration modifizieren müssen sind dies die relevanten Einträge in der /data/config.cx:

server.qgis.host "qgis"
server.qgis.port 80

Diverse Umgebungsvariablen für den qgis-Container sind auch hier setzbar, siehe gws.server.core.QgisConfig

PostgreSQL/PostGIS Datenbank

Damit die GBD WebSuite auf die Datenbank zugreifen kann muss ein Datenbank Provider in der /data/config.cx hinterlegt werden. Hostname muss dem gws-Container bekannt sein, evtl extra_hosts Eintrag in der docker-compose.yml ergänzen (für beide Container).

database.providers+ {
    type postgres
    uid "mydb" // beliebig setzbar, kann an anderen orten in der config dazu verwendet werden einen db provider eindeutig zu identifizieren
    host "db.example.com"
    port 5432
    username "bob"
    password "*****"
}

Es wird sehr empfohlen die Verwendung von pg_service.conf in Betracht zu ziehen, mehr dazu hier: #TODO link zu thema pg_service, qgis-projekte in postgis

Locale

Damit in der Benutzeroberfläche richtige Beschriftungen angezeigt werden, sowie Korrekte Zahlen- und Datumsformate ist ein locale zu setzen:

locales ["de_DE"]

Server Settings

Es wird empfohlen einmal durch gws.server.core.Config zu schauen um einen Überblick darüber zu erhalten welche Einstellungen noch interessant sein können.

z.B. Anzahl Worker/Threads, Timeouts, Timezones, maxRequestLengths, logging, FS-Monitoring & automatic Config reloading, ...