Upgrading to Version 5.6.14+230403

Add docker-compose example with Apache reverse-proxy

3.0/apache/Dockerfile

@@ -1,4 +1,4 @@
-FROM php:8.0-apache
+FROM docker.io/php:8.0-apache
 LABEL maintainer="markus@martialblog.de"
 
 # Install OS dependencies
@@ -59,8 +59,8 @@ RUN a2enmod headers rewrite remoteip; \
 # Use the default production configuration
 RUN mv "$PHP_INI_DIR/php.ini-production" "$PHP_INI_DIR/php.ini"
 
-ARG version="3.28.20+220719"
-ARG sha256_checksum="44a55d6e7934cf0769823c2d6af7a668388e9fc5c722551595552175afeed197"
+ARG version="3.28.55+230328"
+ARG sha256_checksum="7f820259aa68fcd2fff7a23e9261ad65af0b28085ef93a69bf14cc068ee829c5"
 ARG archive_url="https://github.com/LimeSurvey/LimeSurvey/archive/${version}.tar.gz"
 ARG USER=root
 ARG LISTEN_PORT=80

3.0/fpm-alpine/Dockerfile

@@ -1,4 +1,4 @@
-FROM php:8.0-fpm-alpine
+FROM docker.io/php:8.0-fpm-alpine
 LABEL maintainer="markus@martialblog.de"
 
 # Install OS dependencies
@@ -33,8 +33,8 @@ RUN set -ex; \
         tidy \
         zip
 
-ARG version="3.28.20+220719"
-ARG sha256_checksum="44a55d6e7934cf0769823c2d6af7a668388e9fc5c722551595552175afeed197"
+ARG version="3.28.55+230328"
+ARG sha256_checksum="7f820259aa68fcd2fff7a23e9261ad65af0b28085ef93a69bf14cc068ee829c5"
 ARG archive_url="https://github.com/LimeSurvey/LimeSurvey/archive/${version}.tar.gz"
 ENV LIMESURVEY_VERSION=$version
 

3.0/fpm/Dockerfile

@@ -1,4 +1,4 @@
-FROM php:8.0-fpm
+FROM docker.io/php:8.0-fpm
 LABEL maintainer="markus@martialblog.de"
 
 # Install OS dependencies
@@ -46,8 +46,8 @@ RUN set -ex; \
         tidy \
         zip
 
-ARG version="3.28.20+220719"
-ARG sha256_checksum="44a55d6e7934cf0769823c2d6af7a668388e9fc5c722551595552175afeed197"
+ARG version="3.28.55+230328"
+ARG sha256_checksum="7f820259aa68fcd2fff7a23e9261ad65af0b28085ef93a69bf14cc068ee829c5"
 ARG archive_url="https://github.com/LimeSurvey/LimeSurvey/archive/${version}.tar.gz"
 ENV LIMESURVEY_VERSION=$version
 

5.0/apache/Dockerfile

@@ -1,4 +1,4 @@
-FROM php:8.0-apache
+FROM docker.io/php:8.0-apache
 LABEL maintainer="markus@martialblog.de"
 
 # Install OS dependencies
@@ -60,8 +60,8 @@ RUN a2enmod headers rewrite remoteip; \
 # Use the default production configuration
 RUN mv "$PHP_INI_DIR/php.ini-production" "$PHP_INI_DIR/php.ini"
 
-ARG version="5.3.26+220720"
-ARG sha256_checksum="e05eade1175ae5b87be3a22721480f011f37c197c3f29bb4a2a7bfe95b591593"
+ARG version="5.6.14+230403"
+ARG sha256_checksum="671689d54db6c018c5dd764c852fccd5e582c4cf743bd7fe50329d2fbab5f8a7"
 ARG archive_url="https://github.com/LimeSurvey/LimeSurvey/archive/${version}.tar.gz"
 ARG USER=www-data
 ARG LISTEN_PORT=8080

5.0/fpm-alpine/Dockerfile

@@ -1,4 +1,4 @@
-FROM php:8.0-fpm-alpine
+FROM docker.io/php:8.0-fpm-alpine
 LABEL maintainer="markus@martialblog.de"
 
 # Install OS dependencies
@@ -34,8 +34,8 @@ RUN set -ex; \
         tidy \
         zip
 
-ARG version="5.3.26+220720"
-ARG sha256_checksum="e05eade1175ae5b87be3a22721480f011f37c197c3f29bb4a2a7bfe95b591593"
+ARG version="5.6.14+230403"
+ARG sha256_checksum="671689d54db6c018c5dd764c852fccd5e582c4cf743bd7fe50329d2fbab5f8a7"
 ARG archive_url="https://github.com/LimeSurvey/LimeSurvey/archive/${version}.tar.gz"
 ARG USER=www-data
 ENV LIMESURVEY_VERSION=$version

5.0/fpm/Dockerfile

@@ -1,4 +1,4 @@
-FROM php:8.0-fpm
+FROM docker.io/php:8.0-fpm
 LABEL maintainer="markus@martialblog.de"
 
 # Install OS dependencies
@@ -46,8 +46,8 @@ RUN set -ex; \
         tidy \
         zip
 
-ARG version="5.3.26+220720"
-ARG sha256_checksum="e05eade1175ae5b87be3a22721480f011f37c197c3f29bb4a2a7bfe95b591593"
+ARG version="5.6.14+230403"
+ARG sha256_checksum="671689d54db6c018c5dd764c852fccd5e582c4cf743bd7fe50329d2fbab5f8a7"
 ARG archive_url="https://github.com/LimeSurvey/LimeSurvey/archive/${version}.tar.gz"
 ARG USER=www-data
 ENV LIMESURVEY_VERSION=$version

CONTRIBUTING.md

@@ -2,6 +2,15 @@
 
 Every Pull Request is welcome.
 
+## Branches
+Choosing a proper name for a branch helps us identify its purpose and possibly find an associated bug or feature. Generally a branch name should include a topic such as `fix` or `feature` followed by a description. Branches should have only changes relevant to a specific issue.
+
+```
+git checkout -b fix/bug-in-connection
+git checkout -b feature/improved-config-handling
+git checkout -b doc/fix-typo
+```
+
 ## Upgrading the Version
 
 The versions in this repository should correspond to the [GitHub LimeSurvey Releases](https://github.com/LimeSurvey/LimeSurvey/releases)

Makefile

@@ -1,14 +1,14 @@
-# .PHONY: apache fpm fpm-alpine
+RUNTIME?=podman
 
 apache-lts:
-	docker build --pull -t docker.io/martialblog/limesurvey:3-apache 3.0/apache
+	$(RUNTIME) build --pull -t docker.io/martialblog/limesurvey:3-apache 3.0/apache
 apache-latest:
-	docker build --pull -t docker.io/martialblog/limesurvey:5-apache 5.0/apache
+	$(RUNTIME) build --pull -t docker.io/martialblog/limesurvey:5-apache 5.0/apache
 fpm-alpine-lts:
-	docker build --pull -t docker.io/martialblog/limesurvey:3-fpm-alpine 3.0/fpm-alpine
+	$(RUNTIME) build --pull -t docker.io/martialblog/limesurvey:3-fpm-alpine 3.0/fpm-alpine
 fpm-alpine-latest:
-	docker build --pull -t docker.io/martialblog/limesurvey:5-fpm-alpine 5.0/fpm-alpine
+	$(RUNTIME) build --pull -t docker.io/martialblog/limesurvey:5-fpm-alpine 5.0/fpm-alpine
 fpm-lts:
-	docker build --pull -t docker.io/martialblog/limesurvey:3-fpm 3.0/fpm
+	$(RUNTIME) build --pull -t docker.io/martialblog/limesurvey:3-fpm 3.0/fpm
 fpm-latest:
-	docker build --pull -t docker.io/martialblog/limesurvey:5-fpm 5.0/fpm
+	$(RUNTIME) build --pull -t docker.io/martialblog/limesurvey:5-fpm 5.0/fpm

README.md

@@ -85,6 +85,12 @@ For further details on the settings see: https://manual.limesurvey.org/Data_encr
 
 # Reverse Proxy configuration
 
+If you are running LimeSurvey behind a Reverse Proxy you might need some additional configuration in the Proxy. For example:
+
+* Apache: `ProxyPreserveHost On`
+* Nginx: `fastcgi_param HTTP_HOST my-survey.example.local;`
+* Traefik: Set the Host Header explicitly via a customRequestHeaders
+
 ## Traefik example
 
 **Hint**: if you want to deploy LimeSurvey on a sub-path (e.g. https://example.com/limesurvey) you have to set the BASE_URL and adjust the Containers Webservers. See the docker-compose Traefik example in the repository.
@@ -117,7 +123,7 @@ For further details on the settings see: https://manual.limesurvey.org/Data_encr
 | BASE_URL        | Application Base URL                      |
 | URL_FORMAT      | URL Format. path or get                   |
 | TABLE_SESSION   | Enable table sessions (true)              |
-| SHOW_SCRIPT_NAME | Script name in URL (true|false). Default: true |
+| SHOW_SCRIPT_NAME | Script name in URL (true\|false). Default: true |
 | DEBUG           | Debug level (0, 1, 2). Default: 0         |
 | DEBUG_SQL       | SQL Debug level (0, 1, 2). Default 0      |
 | ENCRYPT_KEYPAIR  | Data encryption keypair                  |
@@ -185,6 +191,15 @@ drwxr-xr-x 3 82 82 4096 Jun  3 13:51 surveys
 
 If you are using the Apache2 Images, the default port will now be **8080**. Depending on your setup the port configurations might need adjustment.
 
+# Known Issues
+
+## LimeSurvey behind a reverse proxy with a subdirectory
+
+When running LimeSurvey behind a reverse proxy with a subdirectory (i.e. example.com/limesurvey), the admin area might not be displayed correctly due to a routing issue. The application will forward you to the base url regardless. See:
+- https://github.com/martialblog/docker-limesurvey/issues/49
+- https://github.com/martialblog/docker-limesurvey/issues/127
+- https://github.com/martialblog/docker-limesurvey/issues/106
+
 # References
 
 - https://www.limesurvey.org/

docker-compose.apache.yml

@@ -0,0 +1,29 @@
+version: "3.0"
+services:
+  limesurvey:
+    image: docker.io/martialblog/limesurvey:3-apache
+    links:
+      - lime-db
+    depends_on:
+      - lime-db
+    environment:
+      - "DB_HOST=lime-db"
+      - "DB_PASSWORD=secret"
+      - "ADMIN_PASSWORD=foobar"
+      - "PUBLIC_URL=http://my.survey.localhost:8080"  # Example, Change this
+      - "BASE_URL=http://my.survey.localhost:8080"  # Example, Change this
+  proxy:
+    image: docker.io/httpd:bullseye
+    volumes:
+      - "./examples/apache-httpd.conf:/usr/local/apache2/conf/httpd.conf:ro"
+      - "./examples/apache-reverse-proxy.conf:/usr/local/apache2/conf/reverse-proxy.conf:ro"
+    ports:
+      - "8080:8080"
+  lime-db:
+    image: docker.io/mysql:5.7
+    environment:
+      - "MYSQL_USER=limesurvey"
+      - "MYSQL_DATABASE=limesurvey"
+      - "MYSQL_PASSWORD=secret"
+      - "MYSQL_ROOT_PASSWORD=secret"
+

docker-compose.example.yml

@@ -1,7 +1,7 @@
 version: '3'
 services:
   limesurvey:
-    image: martialblog/limesurvey:latest
+    image: docker.io/martialblog/limesurvey:latest
     restart: always
     environment:
       - DB_TYPE=pgsql
@@ -22,7 +22,7 @@ services:
     depends_on:
       - db
   db:
-    image: postgres:10-alpine
+    image: docker.io/postgres:10-alpine
     restart: always
     volumes:
       - db-data:/var/lib/postgresql

docker-compose.fpm-certbot.yml

@@ -33,14 +33,14 @@ services:
     environment:
       - "HOSTNAMES=www.example.com example.com"
   certbot:
-    image: certbot/certbot
+    image: docker.io/certbot/certbot
     restart: unless-stopped
     volumes:
       - ./certbot/conf:/etc/letsencrypt
       - ./certbot/www:/var/www/certbot
     entrypoint: "/bin/sh -c 'trap exit TERM; while :; do certbot renew; sleep 12h & wait $${!}; done;'"
   lime-db:
-    image: mysql:5.7
+    image: docker.io/mysql:5.7
     environment:
       - "MYSQL_USER=limesurvey"
       - "MYSQL_DATABASE=limesurvey"

docker-compose.fpm.alpine.yml

@@ -17,7 +17,7 @@ services:
       - "DB_PASSWORD=secret"
       - "ADMIN_PASSWORD=foobar"
   lime-web:
-    image: nginx:alpine
+    image: docker.io/nginx:alpine
     links:
       - limesurvey
     depends_on:
@@ -28,7 +28,7 @@ services:
       - ./examples/nginx.conf:/etc/nginx/nginx.conf:ro
       - lime:/var/www/html
   lime-db:
-    image: mysql:5.7
+    image: docker.io/mysql:5.7
     environment:
       - "MYSQL_USER=limesurvey"
       - "MYSQL_DATABASE=limesurvey"

docker-compose.fpm.yml

@@ -17,7 +17,7 @@ services:
       - "DB_PASSWORD=secret"
       - "ADMIN_PASSWORD=foobar"
   lime-web:
-    image: nginx
+    image: docker.io/nginx
     links:
       - limesurvey
     ports:
@@ -26,7 +26,7 @@ services:
       - ./examples/nginx.conf:/etc/nginx/nginx.conf:ro
       - lime:/var/www/html
   lime-db:
-    image: mysql:5.7
+    image: docker.io/mysql:5.7
     environment:
       - "MYSQL_USER=limesurvey"
       - "MYSQL_DATABASE=limesurvey"

docker-compose.pgsql.yml

@@ -22,7 +22,7 @@ services:
       - "DB_PASSWORD=secret"
       - "ADMIN_PASSWORD=foobar"
   lime-db:
-    image: postgres:10
+    image: docker.io/postgres:10
     volumes:
       - db-data:/var/lib/postgresql/data
     environment:

docker-compose.traefik.domain.yml

@@ -0,0 +1,42 @@
+version: "3.0"
+services:
+  limesurvey:
+    build:
+      context: 5.0/apache/
+      dockerfile: Dockerfile
+    labels:
+      traefik.enable: 'true'
+      traefik.http.routers.limesurvey-http-router.entrypoints: "http"
+      traefik.http.routers.limesurvey-http-router.rule: "Host(`my.survey.localhost`)"
+      traefik.http.services.limesurvey-service.loadbalancer.server.port: "8080"
+    links:
+      - lime-db
+    depends_on:
+      - lime-db
+    environment:
+      - "DB_HOST=lime-db"
+      - "DB_PASSWORD=secret"
+      - "ADMIN_PASSWORD=foobar"
+      - "PUBLIC_URL=http://my.survey.localhost:8888"
+      - "BASE_URL=http://my.survey.localhost:8888"
+  traefik:
+    image: docker.io/traefik:v2.9
+    container_name: "traefik"
+    command:
+      - "--api.insecure=true"
+      - "--providers.docker=true"
+      - "--providers.docker.exposedbydefault=false"
+      - "--entrypoints.http.address=:8888"
+    ports:
+      - "8888:8888"
+      - "8080:8080"
+    volumes:
+      - "/var/run/docker.sock:/var/run/docker.sock:ro"
+  lime-db:
+    image: docker.io/mysql:5.7
+    environment:
+      - "MYSQL_USER=limesurvey"
+      - "MYSQL_DATABASE=limesurvey"
+      - "MYSQL_PASSWORD=secret"
+      - "MYSQL_ROOT_PASSWORD=secret"
+

docker-compose.traefik.yml

@@ -24,7 +24,7 @@ services:
       - "PUBLIC_URL=http://localhost:8888/limesurvey"
       - "BASE_URL=http://localhost:8888/limesurvey"
   traefik:
-    image: "traefik:v2.5"
+    image: docker.io/traefik:v2.9
     container_name: "traefik"
     command:
       - "--api.insecure=true"
@@ -37,7 +37,7 @@ services:
     volumes:
       - "/var/run/docker.sock:/var/run/docker.sock:ro"
   lime-db:
-    image: mysql:5.7
+    image: docker.io/mysql:5.7
     environment:
       - "MYSQL_USER=limesurvey"
       - "MYSQL_DATABASE=limesurvey"

docker-compose.yml

@@ -20,7 +20,7 @@ services:
       # If you require an empty table prefix, use a space as the DB_TABLE_PREFIX
       # - "DB_TABLE_PREFIX= "
   lime-db:
-    image: mysql:5.7
+    image: docker.io/mysql:5.7
     environment:
       - "MYSQL_USER=limesurvey"
       - "MYSQL_DATABASE=limesurvey"

examples/apache-httpd.conf

@@ -0,0 +1,131 @@
+ServerRoot "/usr/local/apache2"
+Listen 8080
+
+LoadModule mpm_event_module modules/mod_mpm_event.so
+LoadModule authn_file_module modules/mod_authn_file.so
+LoadModule authn_core_module modules/mod_authn_core.so
+LoadModule authz_host_module modules/mod_authz_host.so
+LoadModule authz_groupfile_module modules/mod_authz_groupfile.so
+LoadModule authz_user_module modules/mod_authz_user.so
+LoadModule authz_core_module modules/mod_authz_core.so
+LoadModule access_compat_module modules/mod_access_compat.so
+LoadModule auth_basic_module modules/mod_auth_basic.so
+LoadModule watchdog_module modules/mod_watchdog.so
+LoadModule reqtimeout_module modules/mod_reqtimeout.so
+LoadModule filter_module modules/mod_filter.so
+LoadModule mime_module modules/mod_mime.so
+LoadModule log_config_module modules/mod_log_config.so
+LoadModule env_module modules/mod_env.so
+LoadModule headers_module modules/mod_headers.so
+LoadModule setenvif_module modules/mod_setenvif.so
+LoadModule version_module modules/mod_version.so
+LoadModule proxy_module modules/mod_proxy.so
+LoadModule proxy_connect_module modules/mod_proxy_connect.so
+LoadModule proxy_ftp_module modules/mod_proxy_ftp.so
+LoadModule proxy_http_module modules/mod_proxy_http.so
+LoadModule proxy_fcgi_module modules/mod_proxy_fcgi.so
+LoadModule proxy_scgi_module modules/mod_proxy_scgi.so
+LoadModule proxy_uwsgi_module modules/mod_proxy_uwsgi.so
+LoadModule proxy_fdpass_module modules/mod_proxy_fdpass.so
+LoadModule proxy_wstunnel_module modules/mod_proxy_wstunnel.so
+LoadModule proxy_ajp_module modules/mod_proxy_ajp.so
+LoadModule proxy_balancer_module modules/mod_proxy_balancer.so
+LoadModule proxy_express_module modules/mod_proxy_express.so
+LoadModule proxy_hcheck_module modules/mod_proxy_hcheck.so
+LoadModule slotmem_shm_module modules/mod_slotmem_shm.so
+LoadModule ssl_module modules/mod_ssl.so
+LoadModule lbmethod_byrequests_module modules/mod_lbmethod_byrequests.so
+LoadModule lbmethod_bytraffic_module modules/mod_lbmethod_bytraffic.so
+LoadModule lbmethod_bybusyness_module modules/mod_lbmethod_bybusyness.so
+LoadModule lbmethod_heartbeat_module modules/mod_lbmethod_heartbeat.so
+LoadModule unixd_module modules/mod_unixd.so
+LoadModule status_module modules/mod_status.so
+LoadModule autoindex_module modules/mod_autoindex.so
+#LoadModule suexec_module modules/mod_suexec.so
+<IfModule !mpm_prefork_module>
+</IfModule>
+<IfModule mpm_prefork_module>
+</IfModule>
+LoadModule dir_module modules/mod_dir.so
+LoadModule alias_module modules/mod_alias.so
+<IfModule unixd_module>
+
+User daemon
+Group daemon
+
+</IfModule>
+
+ServerAdmin you@example.com
+#
+<Directory />
+    AllowOverride none
+    Require all denied
+</Directory>
+
+DocumentRoot "/usr/local/apache2/htdocs"
+<Directory "/usr/local/apache2/htdocs">
+    Options Indexes FollowSymLinks
+    AllowOverride None
+    Require all granted
+</Directory>
+
+<IfModule dir_module>
+    DirectoryIndex index.html
+</IfModule>
+
+<Files ".ht*">
+    Require all denied
+</Files>
+
+ErrorLog /proc/self/fd/2
+
+LogLevel warn
+
+<IfModule log_config_module>
+    LogFormat "%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-Agent}i\"" combined
+    LogFormat "%h %l %u %t \"%r\" %>s %b" common
+
+    <IfModule logio_module>
+      # You need to enable mod_logio.c to use %I and %O
+      LogFormat "%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-Agent}i\" %I %O" combinedio
+    </IfModule>
+
+    CustomLog /proc/self/fd/1 common
+</IfModule>
+
+<IfModule alias_module>
+    ScriptAlias /cgi-bin/ "/usr/local/apache2/cgi-bin/"
+
+</IfModule>
+
+<IfModule cgid_module>
+</IfModule>
+
+<Directory "/usr/local/apache2/cgi-bin">
+    AllowOverride None
+    Options None
+    Require all granted
+</Directory>
+
+<IfModule headers_module>
+    RequestHeader unset Proxy early
+</IfModule>
+
+<IfModule mime_module>
+    TypesConfig conf/mime.types
+
+    AddType application/x-compress .Z
+    AddType application/x-gzip .gz .tgz
+</IfModule>
+
+# Configure mod_proxy_html to understand HTML4/XHTML1
+<IfModule proxy_html_module>
+Include conf/extra/proxy-html.conf
+</IfModule>
+
+<IfModule ssl_module>
+SSLRandomSeed startup builtin
+SSLRandomSeed connect builtin
+</IfModule>
+
+IncludeOptional conf/reverse-proxy.conf

examples/apache-reverse-proxy.conf

@@ -0,0 +1,8 @@
+<VirtualHost *:8080>
+    ServerAdmin admin@localhost.local
+    ServerName my.survey.localhost
+
+    ProxyPass / http://limesurvey:80/
+    ProxyPassReverse / http://limesurvey:80/
+    ProxyPreserveHost On
+</VirtualHost>

examples/nginx.conf

@@ -33,6 +33,8 @@ http {
             fastcgi_pass  limesurvey:9000;
             fastcgi_param  SCRIPT_FILENAME  $document_root$fastcgi_script_name;
             fastcgi_param  SCRIPT_NAME      $fastcgi_script_name;
+            # For Subdomains like https://survey.example.com
+            # fastcgi_param  HTTP_HOST      survey.example.com;
         }
     }
 }