# qwc-docker

**Repository Path**: mirrors_grst/qwc-docker

## Basic Information

- **Project Name**: qwc-docker
- **Description**: Docker containers for qwc-services
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-08
- **Last Updated**: 2026-05-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# A preconfigured version of QWC2 

Experimenting with qwc-docker to get a ready-to-run 
online GIS that displays some custom maps. 

-----

Original README: 

Docker containers for QWC Services
==================================

Overview
--------

                                   external services    :    internal services
                                                        :
                  +-------------------+
                  |                   |
                  |  API Gateway      |
                  |  localhost:8088   |
                  +---------+---------+
                            |
    .-----------------------v---------------------------.
    '                                                   '
    +-------------------+
    |                   |
    |  Admin GUI        +-----------------------------------------------------------------------------+
    |  localhost:5031   |                                                                             |
    +-------------------+                                                                             |
                                                                                                      |
    +-------------------+                                                                             |
    |                   |  group registration requests                                                |
    |  Registration GUI +-------------------------------------------------------------------------+   |
    |  localhost:5032   |                                                                         |   |
    +-------------------+                                                                         |   |
                                                                                                  |   |
                                +-------------------+                                             |   |
                 authentication |                   |                                             |   |
              +----------------->  Auth Service     +-----------------------------------------+   |   |
              |                 |  localhost:5017   |                                         |   |   |
              |                 +-------------------+                                         |   |   |
              |                                                                               |   |   |
    +---------+---------+                                                             +-----------------------+
    |                   |  Viewer config and maps                                     |       |   |   |       |
    |  QWC Map Viewer   +---------------------------------------------+               |  PostGIS  |   |       |
    |  localhost:5030   |                                             |               |  localhost:5439       |
    +---------+---------+                                             |               |       |   |   |       |
              |                                                       |               |       |   |   |       |
              |                 +-------------------+       +---------v---------+     | +-----v---v---v-----+ |
              |  GeoJSON        |                   |       |                   +------->                   | |
              +----------------->  Data Service     +---+--->  Config Service   |     | |  Config DB        | |
              |                 |  localhost:5012   |   |   |  localhost:5010   +--+  | |                   | |
              |                 +-------------------+   |   +---------+---------+  |  | +-------------------+ |
              |                                         |             |            |  |                       |
              |                 +-------------------+   |   +---------v---------+  |  | +-------------------+ |
              |  WMS            |                   +---+   |                   |  +---->                   | |
              +----------------->  OGC Service      |   |   |  QGIS Server      |     | |  Geo DB           | |
              |                 |  localhost:5013   +------->  localhost:8001   +------->                   | |
              |                 +-------------------+   |   +-------------------+     | +--^----------------+ |
              |                                         |                             |    |                  |
              |                 +-------------------+   |   +-------------------+     +-----------------------+
              |                 |                   +---+   |                   |          |
              +----------------->  Search Service   |------->  Apache Solr      +----------+
                                |  localhost:5011   +---+   |  localhost:8983   |          |
                                +-------------------+   |   +-------------------+          |
                                                        +----------------------------------+

Containers:

* `qwc-admin-gui`: Admin GUI (http://localhost:8088/qwc_admin/)
* `qwc-api-gateway`: API Gateway, forwards requests to individual services (http://localhost:8088)
* `qwc-auth-service`: Authentication service with local user database (default users: `admin:admin`, `demo:demo`) (http://localhost:8088/auth/login)
* `qwc-config-service`: Service configurations and permissions (http://localhost:5010/api)
* `qwc-data-service`: Data edit using GeoJSON (http://localhost:8088/api/v1/data/api)
* `qwc-map-viewer`: QWC2 map viewer (http://localhost:8088)
* `qwc-ogc-service`: Proxy for WMS/WFS requests filtered by permissions, calls QGIS Server (http://localhost:8088/ows/api)
* `qwc-postgis:` QWC ConfigDB and Demo PostGIS GeoDB (user: `qwc_admin:qwc_admin`) (http://localhost:5439)
* `qwc-qgis-server`: Demo QGIS Server 2.18 (http://localhost:8001)
* `qwc-registration-gui`: GUI for requesting group memberships (http://localhost:8088/registration/register)


Docker installation
-------------------

* https://docs.docker.com/engine/installation/linux/ubuntu/

* docker-compose (https://docs.docker.com/compose/install/):

```
dockerComposeVersion=1.21.2
curl -L https://github.com/docker/compose/releases/download/$dockerComposeVersion/docker-compose-`uname -s`-`uname -m` > ~/bin/docker-compose
chmod +x ~/bin/docker-compose
```


Setup
-----

Setup docker-compose configuration from example:

    cp docker-compose-example.yml docker-compose.yml

Copy additional fonts for QGIS Server. Example:

    unzip /tmp/frutiger_ltcom55.zip -d qgis-server/fonts/

Copy QWC2 files from a production build (see [QWC2 Quick start](https://github.com/qgis/qwc2-demo-app/blob/master/doc/QWC2_Documentation.md#quick-start)):

    SRCDIR=path/to/qwc2-app/ DSTDIR=$PWD/volumes
    cd $SRCDIR && \
    cp -r assets $DSTDIR/qwc2 && \
    cp -r translations/data.* $DSTDIR/qwc2/translations && \
    cp dist/QWC2App.js $DSTDIR/qwc2/dist/ && \
    cp index.html $DSTDIR/qwc2/ && \
    sed -e '/proxyServiceUrl/d' \
      -e 's!permalinkServiceUrl":\s*".*"!permalinkServiceUrl": "/permalink"!' \
      -e 's!elevationServiceUrl":\s*".*"!elevationServiceUrl": "/elevation"!' \
      -e 's!searchServiceUrl":\s*".*"!searchServiceUrl": "/search"!' \
      -e 's!editServiceUrl":\s*".*"!editServiceUrl": "/data"!' \
      -e 's!authServiceUrl":\s*".*"!authServiceUrl": "/auth"!' \
      -e 's!mapInfoService":\s*".*"!mapInfoService": "/mapinfo"!' \
      -e 's!featureReportService":\s*".*"!featureReportService": "/document"!' \
      -e 's!{"key": "Login", "icon": "img/login.svg"}!{{ login_logout_item }}!g' \
      config.json > $DSTDIR/qwc2/config.json && \
    cd -

Copy QWC2 themes config file from example:

    cp volumes/qwc2/themesConfig-example.json volumes/qwc2/themesConfig.json

Container Build:

    docker-compose build

**NOTE:** Building the PostGIS container overwrites its database

Setup PostgreSQL connection service file `~/.pg_service.conf`
for DB connections to PostGIS container:

```
cat >>~/.pg_service.conf <<EOS
[qwc_configdb]
host=localhost
port=5439
dbname=qwc_demo
user=qwc_admin
password=qwc_admin
sslmode=disable

[qwc_geodb]
host=localhost
port=5439
dbname=qwc_demo
user=qwc_service_write
password=qwc_service_write
sslmode=disable

[qwc_webmapping]
host=localhost
port=5439
dbname=qwc_demo
user=qgis_server
password=qgis_server
sslmode=disable
EOS
```


Usage
-----

Start all containers:

    docker-compose up -d

Follow log output:

    docker-compose logs -f

Open map viewer:

    http://localhost:8088/

Connect to config DB:

    psql "service=qwc_configdb"

Stop all containers:

    docker-compose down

Update service containers to latest versions from Git:

    ./build-services.sh

Update PostGIS container to ConfigDB migration `ALEMBIC_VERSION` (**NOTE**: Overwrites current database):

    docker-compose build --build-arg ALEMBIC_VERSION=e9c31b610e0a qwc-postgis


Health checks for Kubernetes
----------------------------

Health checks are a simple way to let the system know if an instance of the app is working or not working. If an instance of the app is not working, then other services should not access it or send a request to it. Instead, requests should be sent to another instance of the app that is ready, or retried at a later time. The system should also bring the app back to a healthy state.

### Readyness:

Readiness probes are designed to let Kubernetes know when the app is ready to serve traffic. Kubernetes makes sure the readiness probe passes before allowing a service to send traffic to the pod. If a readiness probe starts to fail, Kubernetes stops sending traffic to the pod until it passes.

**Check is available at: /ready**

Example check:

* Return ok, if web service is initialized and running

### Liveness:

**Check is available at: /healthz**

Liveness probes let Kubernetes know if the app is alive or dead. If the app is alive, then Kubernetes leaves it alone. If the app is dead, Kubernetes removes the Pod and starts a new one to replace it.

Example checks:

* Check database connection (Example service: qwc-admin-gui)
* Check if all data files are available and readable (Example service: qwc-elevation-service)