Initial commit

Author: manisandro

.github/workflows/main.yml

@@ -0,0 +1,30 @@
+name: build
+
+on: [push, pull_request]
+
+jobs:
+
+    build:
+      runs-on: ubuntu-latest
+      if: github.event_name == 'push' && contains(github.ref, 'refs/tags/')
+      steps:
+
+      - uses: actions/checkout@master
+
+      - name: Get version tag
+        id: get_tag
+        run: |
+          if [ ${{ endsWith(github.ref, '-lts') }} = true ]; then
+            echo "tag=latest-lts,latest-${GITHUB_REF:11:4}-lts,${GITHUB_REF:10}" >>$GITHUB_OUTPUT
+          else
+            echo "tag=latest,${GITHUB_REF:10}" >>$GITHUB_OUTPUT
+          fi
+
+      - name: Publish to Registry
+        uses: elgohr/Publish-Docker-Github-Action@v5
+        if: github.event_name != 'pull_request'
+        with:
+          name: sourcepole/${{ github.event.repository.name }}
+          username: ${{ secrets.DOCKER_HUB_USER }}
+          password: ${{ secrets.DOCKER_HUB_PASSWORD }}
+          tags: "${{ steps.get_tag.outputs.tag }}"

Dockerfile

@@ -0,0 +1,24 @@
+FROM alpine:3.21
+
+RUN apk add --no-cache curl cronie
+
+WORKDIR /app
+COPY qgs_cache_preseed.sh /app/qgs_cache_preseed.sh
+RUN chmod +x /app/qgs_cache_preseed.sh
+
+# Default cron schedule: every day at 03:00
+ENV CRON_SCHEDULE="0 3 * * *"
+# Whether to execute the script directly on startup before running cron
+ENV EXECUTE_ON_STARTUP=0
+# The QGIS project file extension to look for
+ENV QGS_EXT=.qgs
+# The number of FCGI instances (i.e. the number if simultaneous requests to send)
+ENV FCGI_INSTANCES=10
+# The sleep interval in seconds between sending requests
+ENV SLEEP_INTERVAL=1
+
+
+COPY entrypoint.sh /entrypoint.sh
+RUN chmod +x /entrypoint.sh
+
+ENTRYPOINT ["/entrypoint.sh"]

README.md

@@ -0,0 +1,56 @@
+[![](https://github.com/qwc-services/qwc-qgs-cache-preseed/workflows/build/badge.svg)](https://github.com/qwc-services/qwc-qgs-cache-preseed/actions)
+[![docker](https://img.shields.io/docker/v/sourcepole/qwc-qgs-cache-preseed?label=Docker%20image&sort=semver)](https://hub.docker.com/r/sourcepole/qwc-qgs-cache-preseed)
+
+QWC QGS Cache Pre-Seed
+======================
+
+Docker image for pre-seeding the QGIS Server QGS project cache.
+
+This image will periodically query the capabilities for all QGS projects below
+the projects directory to ensure that the projects are cached in the QGIS Server
+project cache, helping to avoid slow server responses which occur when a project
+is not in cache.
+
+Setup
+-----
+
+Add the `qwc-qgs-cache-preseed` container configuration to your QWC `docker-compose.yml`:
+```yml
+  qwc-qgis-server:
+    image: docker.io/sourcepole/qwc-qgis-server:<tag>
+    environment:
+      FCGI_MIN_PROCESSES: 10
+      FCGI_MAX_PROCESSES: 10
+      ...
+    volumes:
+      - ./volumes/qgs-resources:/data:ro
+      ...
+      
+  qwc-qgs-cache-preseed:
+    image: docker.io/sourcepole/qwc-qgs-cache-preseed:<tag>
+    environment:
+      EXECUTE_ON_STARTUP: 1
+      CRON_SCHEDULE: "0 3 * * *"
+      QGS_EXT: ".qgs"
+      FCGI_INSTANCES: 10
+    volumes:
+      - ./volumes/qgs-resources:/data:ro
+```
+
+Configuration
+-------------
+
+Make sure to mount the `qgs-resources` dir (or whichever directory is mounted to `/data` for `qwc-qgis-server`) to `/data`.
+
+The following environment variables can be set:
+
+| Name                 | Default     | Description                                                                      |
+|----------------------|-------------|----------------------------------------------------------------------------------|
+| `CRON_SCHEDULE`      | `0 3 * * *` | Interval at which the pre-seeding script is run. Default: every day at 03:00.    |
+| `EXECUTE_ON_STARTUP` | `0`         | Whether to run the script when the container starts.                             |
+| `QGS_EXT`            | `.qgs`      | The QGS project extension to look for (`.qgs` or `.qgz`).                        |
+| `FCGI_INSTANCES`     | `10`        | The number of FCGI instances (i.e. the number if simultaneous requests to send). |
+| `SLEEP_INTERVAL`     | `1`         | The sleep interval in seconds between sending requests.                          |
+
+*Note*: You should set `FCGI_MIN_PROCESSES` equals to `FCGI_MAX_PROCESSES` in the `qwc-qgis-server` container configuration
+and `FCGI_INSTANCES` to the same number in the `qwc-qgs-cache-preseed` container configuration.

entrypoint.sh

@@ -0,0 +1,30 @@
+#!/bin/sh
+mkdir -p $HOME/.cache
+
+# Wait for qwc-qgis-server
+while true; do
+  echo -n "Waiting for qwc-qgis-server"
+  status_code=$(curl -o /dev/null -s -w "%{http_code}" http://qwc-qgis-server/ows)
+  if [ "$status_code" -eq 000 ]; then
+    echo -n "."
+    sleep 1
+  else
+    echo " Online!"
+    break
+  fi
+done
+
+if [ ${EXECUTE_ON_STARTUP:-0} -eq 1 ]; then
+  /app/qgs_cache_preseed.sh
+fi
+
+# Setup cron job
+cat > $HOME/.cron_env <<EOF
+export QGS_EXT=.qgs
+export FCGI_INSTANCES=10
+export SLEEP_INTERVAL=1
+EOF
+echo "$CRON_SCHEDULE . $HOME/.cron_env; /app/qgs_cache_preseed.sh >/proc/1/fd/1 2>/proc/1/fd/2" | crontab -
+
+echo "Starting cron..."
+exec crond -f

qgs_cache_preseed.sh

@@ -0,0 +1,35 @@
+#!/bin/sh
+
+projects=$(find /data -name '*'${QGS_EXT})
+
+preseed() {
+  service_name=$1
+  nr=$2
+  echo "- Sending request $nr"
+  code=$(curl -o /dev/null -s -w "%{http_code}" "http://qwc-qgis-server/ows/${service_name}?SERVICE=WMS&REQUEST=GetCapabilities&VERSION=1.3.0")
+  echo "- Request $nr completed with status code $code"
+}
+
+
+find /data -name 'qwc_demo'${QGS_EXT} -print0 | while IFS= read -r -d $'\0' file; do
+  echo "Processing project $file"
+  service_name=$(echo $file | sed 's|^\/data/||' | sed "s|$QGS_EXT||")
+  echo "- Service name is ${service_name}"
+
+  pids=""
+  for i in $(seq 1 $FCGI_INSTANCES); do
+    preseed "${service_name}" $i &
+    pid=$!
+    pids="$pids $pid"
+  done
+
+  for pid in $pids; do
+      wait $pid
+  done
+
+  echo ""
+  echo "Sleeping for $SLEEP_INTERVAL seconds..."
+  sleep $SLEEP_INTERVAL
+  echo ""
+done
+echo "Done!"