Merge pull request #1459 from camptocamp/lighttpd

Add support of lighttpd

Author: sbrunner

.github/dpkg-versions.yaml

@@ -309,6 +309,7 @@ camptocamp/qgis-server:latest:
   ubuntu_24_04/libxxhash0: 0.8.2-2build1
   ubuntu_24_04/libzip4t64: 1.7.3-1.1ubuntu2
   ubuntu_24_04/libzstd1: 1.5.5+dfsg2-2build1.1
+  ubuntu_24_04/lighttpd: 1.4.74-1ubuntu3
   ubuntu_24_04/login: 1:4.13+dfsg1-4ubuntu3.2
   ubuntu_24_04/logsave: 1.47.0-2.4~exp1ubuntu4.1
   ubuntu_24_04/mawk: 1.3.4.20240123-1build1
@@ -686,6 +687,7 @@ camptocamp/qgis-server:latest-debug:
   ubuntu_24_04/libxxhash0: 0.8.2-2build1
   ubuntu_24_04/libzip4t64: 1.7.3-1.1ubuntu2
   ubuntu_24_04/libzstd1: 1.5.5+dfsg2-2build1.1
+  ubuntu_24_04/lighttpd: 1.4.74-1ubuntu3
   ubuntu_24_04/login: 1:4.13+dfsg1-4ubuntu3.2
   ubuntu_24_04/logsave: 1.47.0-2.4~exp1ubuntu4.1
   ubuntu_24_04/mawk: 1.3.4.20240123-1build1

Dockerfile

@@ -174,7 +174,8 @@ FROM runner AS runner-server
 
 RUN --mount=type=cache,target=/var/lib/apt/lists,id=apt-list \
     --mount=type=cache,target=/var/cache,id=var-cache,sharing=locked \
-    DEBIAN_FRONTEND=noninteractive apt-get install --assume-yes --no-install-recommends libfcgi
+    DEBIAN_FRONTEND=noninteractive apt-get install --assume-yes --no-install-recommends \
+        apache2 libapache2-mod-fcgid libfcgi lighttpd spawn-fcgi
 
 # Be able to install font as nonroot
 RUN chmod u+s /usr/bin/fc-cache \
@@ -188,7 +189,14 @@ ENV APACHE_CONFDIR=/etc/apache2 \
     APACHE_RUN_DIR=/tmp/apache2 \
     APACHE_PID_FILE=/tmp/apache2/apache2.pid \
     APACHE_LOCK_DIR=/var/lock/apache2 \
-    APACHE_LOG_DIR=/var/log/apache2
+    APACHE_LOG_DIR=/var/log/apache2 \
+    SERVER=apache \
+    LIGHTTPD_CONF=/etc/lighttpd/lighttpd.conf \
+    LIGHTTPD_PORT=8080 \
+    LIGHTTPD_FASTCGI_HOST=spawn-fcgi \
+    LIGHTTPD_FASTCGI_PORT=3000 \
+    LIGHTTPD_FASTCGI_SOCKET= \
+    LIGHTTPD_ACCESSLOG_FORMAT="%h %V %u %t \"%r\" %>s %b"
 
 RUN a2enmod fcgid headers status \
     && a2dismod -f auth_basic authn_file authn_core authz_user autoindex dir \
@@ -236,6 +244,7 @@ RUN adduser www-data root \
 
 RUN ldconfig
 
+VOLUME /tmp
 WORKDIR /etc/qgisserver
 EXPOSE 8080
 CMD ["/usr/local/bin/start-server"]

README.md

@@ -13,7 +13,7 @@ docker run --detach --publish=8380:80 --volume=${PWD}/qgis:/etc/qgisserver campt
 With the previous command, you'll get to your server with this URL:
 http://localhost:8380/?MAP=/etc/qgisserver/project.qgz&SERVICE=WMS&REQUEST=GetCapabilities
 
-## Tuning
+## Apache Tunings
 
 You can use the following variables (`-e` option in `docker run`):
 
@@ -35,6 +35,27 @@ You can use the following variables (`-e` option in `docker run`):
 
 Fonts present in the `/etc/qgisserver/fonts` directory will be installed and thus usable by QGIS.
 
+## Lighttpd
+
+You can also use lighttpd as the web server.
+
+The main benefit of that is to have only one running process per container, that's useful especially on Kubernetes.
+
+For that you need tow containers, one for the MapServer and `spawn-fcgi`, and one for `lighttpd`.
+
+The environment variable needed by mapserver should be on the `spawn-fcgi` container.
+
+The MapServer logs will be available on the 'lighttpd' container.
+
+Used environment variables:
+
+- `LIGHTTPD_CONF`: The lighttpd configuration file (defaults to `/etc/lighttpd/lighttpd.conf`)
+- `LIGHTTPD_PORT`: The port lighttpd will listen on (defaults to `8080`)
+- `LIGHTTPD_FASTCGI_HOST`: The host of the FastCGI server (`spawn-fcgi`, defaults to `spawn-fcgi`)
+- `LIGHTTPD_FASTCGI_PORT`: The port of the FastCGI server (`spawn-fcgi`, defaults to `3000`)
+- `LIGHTTPD_FASTCGI_SOCKET`: The socket of the FastCGI server (defaults to `''`)
+- `LIGHTTPD_ACCESSLOG_FORMAT`: The format of the access log (defaults to `"%h %V %u %t \"%r\" %>s %b"`)
+
 ## Get a stack trace in case of segfault
 
 To get a good stack trace you should use the `-debug` image.

acceptance_tests/Dockerfile

@@ -1,4 +1,4 @@
-FROM python:3.13.1 as base-all
+FROM python:3.13.1 AS base-all
 LABEL maintainer "info@camptocamp.org"
 
 # Fail on error on pipe, see: https://github.com/hadolint/hadolint/wiki/DL4006.
@@ -17,7 +17,7 @@ ENV PATH=/venv/bin:$PATH
 
 # Used to convert the locked packages by poetry to pip requirements format
 # We don't directly use `poetry install` because it force to use a virtual environment.
-FROM base-all as poetry
+FROM base-all AS poetry
 
 # Install Poetry
 WORKDIR /tmp

acceptance_tests/conftest.py

@@ -53,3 +53,11 @@ def connection_landingpage():
     Fixture that returns a connection to a running batch container.
     """
     return Connection("http://qgis-landingpage:8080/", "http://www.example.com/")
+
+
+@pytest.fixture
+def connection_lighttpd():
+    """
+    Fixture that returns a connection to a running batch container.
+    """
+    return Connection("http://qgis-lighttpd:8080/", "http://www.example.com/")

acceptance_tests/docker-compose.yaml

@@ -44,6 +44,33 @@ services:
       - acceptance_config
     user: www-data
 
+  qgis-spawn-fcgi:
+    image: camptocamp/qgis-server:${DOCKER_TAG}
+    environment:
+      SERVER: spawn-fcgi
+      QGIS_SERVER_LOG_LEVEL: '0'
+      QGIS_PROJECT_FILE: /etc/qgisserver/project.qgs
+    read_only: true
+    links:
+      - db
+    volumes:
+      - cache:/var/cache/qgisserver
+    volumes_from:
+      - acceptance_config
+    user: 12311:12311
+
+  qgis-lighttpd:
+    image: camptocamp/qgis-server:${DOCKER_TAG}
+    environment:
+      SERVER: lighttpd
+      LIGHTTPD_FASTCGI_HOST: qgis-spawn-fcgi
+    read_only: true
+    links:
+      - db
+    # ports:
+    #   - 8385:8080
+    user: 12311:12311
+
   db:
     image: camptocamp/postgres:17-postgis-3
     environment:

acceptance_tests/test_wms.py

@@ -16,6 +16,20 @@ def test_get_capabilities(connection):
     ], ElementTree.dump(answer)
 
 
+def test_get_capabilities_lighttpd(connection_lighttpd):
+    ns = "{http://www.opengis.net/wms}"
+    answer = connection_lighttpd.get_xml(
+        "?SERVICE=WMS&REQUEST=GetCapabilities&VERSION=1.3.0",
+        cache_expected=CacheExpected.DONT_CARE,
+        cors=False,
+    )
+    assert [e.text for e in answer.findall(f"{ns}Service/{ns}Title")] == ["test"], ElementTree.dump(answer)
+    assert [e.text for e in answer.findall(f".//{ns}Layer/{ns}Name")] == [
+        "test",
+        "polygons",
+    ], ElementTree.dump(answer)
+
+
 def test_get_map(connection):
     answer = connection.get_raw(
         "?SERVICE=WMS&VERSION=1.3.0&REQUEST=GetMap&LAYERS=polygons&STYLES=&"

runtime/etc/lighttpd/gen-server

@@ -0,0 +1,25 @@
+#!/bin/bash -e
+
+if [[ "${LIGHTTPD_FASTCGI_SOCKET}" == "" ]]; then
+    echo '
+fastcgi.server = ( "" =>
+    (
+        (
+            "host" => env.LIGHTTPD_FASTCGI_HOST,
+            "port" => env.LIGHTTPD_FASTCGI_PORT,
+            "check-local" => "disable",
+        ),
+    )
+)
+'
+else
+    echo 'fastcgi.server = ( "" =>
+    (
+        (
+            "socket" => env.LIGHTTPD_FASTCGI_SOCKET,
+            "check-local" => "disable",
+        ),
+    )
+)
+'
+fi

runtime/etc/lighttpd/lighttpd.conf

@@ -0,0 +1,10 @@
+server.modules = ( "mod_accesslog", "mod_auth", "mod_fastcgi" )
+
+server.document-root = "/none"
+server.port = env.LIGHTTPD_PORT
+server.errorlog = "/dev/fd/2"
+
+accesslog.format = env.LIGHTTPD_ACCESSLOG_FORMAT
+accesslog.filename = "/dev/fd/2"
+
+include_shell "./gen-server"

runtime/usr/local/bin/start-server

@@ -5,26 +5,46 @@ if [ -e /etc/qgisserver/fonts/ ]; then
     fc-cache --really-force --system-only
 fi
 
-# save the environment to be able to restore it in the FCGI daemon (used
-# in /usr/local/bin/qgis_mapsev_wrapper) for the startup code.
-# shellcheck disable=SC2086
-${GET_ENV} ${FILTER_ENV} | sed -e 's/^\([^=]*\)=.*/PassEnv \1/' > /tmp/pass-env
-
-# Save the list of variables to be passed along with the FCGI requests (used in
-# /etc/apache2/conf-enabled/qgis.conf).
-# shellcheck disable=SC2086
-${GET_ENV} ${FILTER_ENV} | sed -e 's/.\+/export "\0"/' > /tmp/init-env
-
-if [ "${UID}" == 0 ]; then
-    echo "Switching listen port to 80"
-    cd /tmp
-    sed -i -e 's/<VirtualHost \*:8080>/<VirtualHost *:80>/' /etc/apache2/sites-available/000-default.conf
-    sed -i -e 's/Listen 8080$/Listen 80/' /etc/apache2/ports.conf
-fi
+if [[ "${SERVER}" == spawn-fcgi ]]; then
+    echo "Starting with spawn-fcgi"
+    # Save the environment to be able to restore it in the FCGI daemon (used in /usr/local/bin/qgis-mapserv-wrapper)
+    # shellcheck disable=SC2086
+    ${GET_ENV} ${FILTER_ENV} | sed -e 's/.\+/export "\0"/' > /tmp/init-env
+    if [[ "${LIGHTTPD_FASTCGI_SOCKET}" == "" ]]; then
+        exec /usr/bin/spawn-fcgi -p "${LIGHTTPD_FASTCGI_PORT}" -n -- /usr/local/bin/qgis-mapserv-wrapper
+    else
+        exec /usr/bin/spawn-fcgi -s "${LIGHTTPD_FASTCGI_SOCKET}" -n -- /usr/local/bin/qgis-mapserv-wrapper
+    fi
+else
+    if [[ "${SERVER}" == lighttpd ]]; then
+        echo "Starting lighttpd"
+        lighttpd -tt -f "${LIGHTTPD_CONF}"
+        exec /usr/sbin/lighttpd -D -f "${LIGHTTPD_CONF}"
+    else
+        echo "Starting with apache2"
+
+        # save the environment to be able to restore it in the FCGI daemon (used
+        # in /usr/local/bin/qgis-mapserv-wrapper) for the startup code.
+        # shellcheck disable=SC2086
+        ${GET_ENV} ${FILTER_ENV} | sed -e 's/^\([^=]*\)=.*/PassEnv \1/' > /tmp/pass-env
+
+        # Save the list of variables to be passed along with the FCGI requests (used in
+        # /etc/apache2/conf-enabled/qgis.conf).
+        # shellcheck disable=SC2086
+        ${GET_ENV} ${FILTER_ENV} | sed -e 's/.\+/export "\0"/' > /tmp/init-env
 
-trap 'echo "caught a SIGTERM"; kill -TERM $PID2; wait $PID2; kill -TERM $PID1; wait $PID1' TERM
-trap '' WINCH
+        if [[ "${UID}" == 0 ]]; then
+            echo "Switching listen port to 80"
+            cd /tmp
+            sed -i -e 's/<VirtualHost \*:8080>/<VirtualHost *:80>/' /etc/apache2/sites-available/000-default.conf
+            sed -i -e 's/Listen 8080$/Listen 80/' /etc/apache2/ports.conf
+        fi
 
-rm -f "${APACHE_PID_FILE}"
+        trap 'echo "caught a SIGTERM"; kill -TERM $PID2; wait $PID2; kill -TERM $PID1; wait $PID1' TERM
+        trap '' WINCH
 
-exec apache2 -DFOREGROUND
+        rm -f "${APACHE_PID_FILE}"
+
+        exec apache2 -DFOREGROUND
+    fi
+fi