From 5110ded7e5897a033e45a8ffc9e6383cb2bff2b1 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Emmanuel=20BENO=C3=8ET?= <tseeker@nocternity.net>
Date: Sun, 5 Jan 2025 21:09:27 +0100
Subject: [PATCH] feat: support running using Docker Compose

This commit adds a Docker Compose file which will run the application
using docker. The application is fronted by Traefik, and runs using
PHP-fpm. nginx is used to accept queries from Traefik and relay them to
the PHP-fpm containers (Traefik doesn't support FastCGI directly).
Sessions are shared between the various PHP containers using memcached.

Part of this work is based on [this repo](https://github.com/wandersonwhcr/docker-nginx-php-fpm)
---
 .gitignore                                   |  1 +
 docker/Dockerfile                            | 37 ++++++++
 docker/app-config.inc.php                    | 15 ++++
 docker/compose.yml                           | 93 ++++++++++++++++++++
 docker/db-config.sql                         |  6 ++
 docker/env.example                           | 23 +++++
 docker/init-sql.sh                           |  5 ++
 docker/nginx-templates/default.conf.template | 21 +++++
 8 files changed, 201 insertions(+)
 create mode 100644 docker/Dockerfile
 create mode 100644 docker/app-config.inc.php
 create mode 100644 docker/compose.yml
 create mode 100644 docker/db-config.sql
 create mode 100644 docker/env.example
 create mode 100644 docker/init-sql.sh
 create mode 100644 docker/nginx-templates/default.conf.template

diff --git a/.gitignore b/.gitignore
index 355afad..e1f8611 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,3 +1,4 @@
 includes/config.inc.php
 database/config.sql
 site/.htaccess
+docker/.env
diff --git a/docker/Dockerfile b/docker/Dockerfile
new file mode 100644
index 0000000..4e7b01a
--- /dev/null
+++ b/docker/Dockerfile
@@ -0,0 +1,37 @@
+# syntax=docker/dockerfile:1.7-labs
+ARG PHP_VERSION=8.3
+ARG POSTGRESQL_VERSION=17
+
+#
+# Application image
+#
+
+FROM php:${PHP_VERSION}-fpm-alpine AS application
+
+RUN <<EOF
+	set -e
+	apk add --no-cache fcgi unzip postgresql-dev libmemcached-dev \
+		libmemcached autoconf pkgconfig g++ zlib-dev make
+	docker-php-ext-install pgsql pdo pdo_pgsql
+	pecl install memcached
+	docker-php-ext-enable memcached
+	mkdir -p /var/www/tasks
+	echo "pm.status_path = /status" >> /usr/local/etc/php-fpm.d/zz-docker.conf
+	echo "chdir = /var/www/tasks/site" >> /usr/local/etc/php-fpm.d/zz-docker.conf
+	curl --silent --remote-name https://raw.githubusercontent.com/renatomefi/php-fpm-healthcheck/v0.5.0/php-fpm-healthcheck
+	install --owner root --group root --mode 755 php-fpm-healthcheck /usr/local/bin/php-fpm-healthcheck
+	rm -rf php-fpm-healthcheck
+	mv "$PHP_INI_DIR/php.ini-production" "$PHP_INI_DIR/php.ini"
+EOF
+HEALTHCHECK --interval=5s \
+    CMD php-fpm-healthcheck || exit 1
+
+COPY --parents site includes arse /var/www/tasks/
+
+#
+# Database image
+#
+
+FROM postgres:${POSTGRESQL_VERSION} AS database
+RUN mkdir /opt/tasks
+COPY --parents database.sql database /opt/tasks/
diff --git a/docker/app-config.inc.php b/docker/app-config.inc.php
new file mode 100644
index 0000000..2caa95e
--- /dev/null
+++ b/docker/app-config.inc.php
@@ -0,0 +1,15 @@
+<?php
+
+ini_set('session.save_handler', 'memcached');
+ini_set('session.save_path', getenv('MEMCACHED_HOST') . ':11211');
+
+$config[ 'core' ][ 'db' ][ 'host' ] = getenv('DB_HOST');
+$config[ 'core' ][ 'db' ][ 'name' ] = getenv('DB_NAME');
+$config[ 'core' ][ 'db' ][ 'user' ] = getenv('DB_USER');
+$config[ 'core' ][ 'db' ][ 'password' ] = file_get_contents(getenv('DB_PASSWORD_FILE'));
+
+$config[ 'core' ][ 'pages' ][ 'baseURL' ] = getenv('BASE_URL') ?: null;
+$config[ 'core' ][ 'pages' ][ 'baseTitle' ] = 'Tasks';
+
+/* Minimal time before a completed task can be deleted. The default is one week. */
+// $config[ 't-data' ][ 'minDeletionTime' ] = 7 * 3600 * 24;
diff --git a/docker/compose.yml b/docker/compose.yml
new file mode 100644
index 0000000..7fd9108
--- /dev/null
+++ b/docker/compose.yml
@@ -0,0 +1,93 @@
+name: tasks
+
+services:
+
+  database:
+    container_name: ${COMPOSE_PROJECT_NAME}-database
+    build:
+      context: ..
+      dockerfile: ./docker/Dockerfile
+      target: database
+      args:
+        POSTGRESQL_VERSION: ${POSTGRESQL_VERSION:-17}
+    restart: always
+    shm_size: 128mb
+    volumes:
+      - database:/var/lib/postgresql/data
+    configs:
+      - source: db_config
+        target: /opt/tasks/database/config.sql
+      - source: db_loader
+        target: /docker-entrypoint-initdb.d/init-sql.sh
+    environment:
+      DB_NAME: ${DB_NAME}
+      DB_USER: ${DB_USER}
+      DB_PASSWORD_FILE: /run/secrets/db_password
+      POSTGRES_PASSWORD_FILE: /run/secrets/pg_password
+    secrets:
+      - db_password
+      - pg_password
+
+  application:
+    build:
+      context: ..
+      dockerfile: ./docker/Dockerfile
+      target: application
+      args:
+        PHP_VERSION: ${PHP_VERSION:-8.3}
+    user: ${UID:-1000}:${GID:-1000}
+    configs:
+      - source: app_config
+        target: /var/www/tasks/includes/config.inc.php
+    environment:
+      BASE_URL: ${BASE_URL}
+      DB_HOST: database
+      DB_NAME: ${DB_NAME}
+      DB_USER: ${DB_USER}
+      DB_PASSWORD_FILE: /run/secrets/db_password
+      MEMCACHED_HOST: memcached
+    secrets:
+      - db_password
+
+  nginx:
+    image: nginx:${NGINX_VERSION:-1.19}-alpine
+    labels:
+      - traefik.enable=true
+      - traefik.http.routers.default.rule=Host(`${PHP_HOSTNAME:-localhost}`)
+      - traefik.port=80
+    volumes:
+      - ./nginx-templates:/etc/nginx/templates:ro
+      - ../site:/var/www/tasks/site:ro
+
+  memcached:
+    image: memcached:${MEMCACHED_VERSION:-1.6}-alpine
+
+  traefik:
+    container_name: ${COMPOSE_PROJECT_NAME}-traefik
+    image: traefik:${TRAEFIX_VERSION:-2.4}
+    ports:
+      - ${HOST_PORT}:80
+    volumes:
+      - "/var/run/docker.sock:/var/run/docker.sock:ro"
+    command:
+      - --entrypoints.web.address=:80
+      - --log.level=DEBUG
+      - --providers.docker.exposedbydefault=false
+      - --providers.docker=true
+
+configs:
+  app_config:
+    file: ./app-config.inc.php
+  db_config:
+    file: ./db-config.sql
+  db_loader:
+    file: ./init-sql.sh
+
+volumes:
+  database:
+
+secrets:
+  db_password:
+    environment: DB_PASSWORD
+  pg_password:
+    environment: PG_PASSWORD
diff --git a/docker/db-config.sql b/docker/db-config.sql
new file mode 100644
index 0000000..08a6474
--- /dev/null
+++ b/docker/db-config.sql
@@ -0,0 +1,6 @@
+\getenv db_name DB_NAME
+\getenv webapp_user DB_USER
+\getenv webapp_password DB_PASSWORD
+
+CREATE ROLE :webapp_user WITH LOGIN ENCRYPTED PASSWORD :'webapp_password';
+CREATE DATABASE :db_name WITH TEMPLATE=template0 ENCODING='UTF8';
diff --git a/docker/env.example b/docker/env.example
new file mode 100644
index 0000000..cd299e2
--- /dev/null
+++ b/docker/env.example
@@ -0,0 +1,23 @@
+# Version of software components
+MEMCACHED_VERSION=1.6
+NGINX_VERSION=1.19
+PHP_VERSION=8.3
+POSTGRESQL_VERSION=17
+TRAEFIX_VERSION=2.4
+
+# Port to bind on the host
+HOST_PORT=80
+# UID and GID to run php-fpm as
+UID=1000
+GID=1000
+# PostgreSQL superuser password
+PG_PASSWORD=...
+# Database name
+DB_NAME=tasks
+# Database access username
+DB_USER=tasks
+# Database access password
+DB_PASSWORD=...
+
+# Base URL, if autodetection fails
+BASE_URL=
diff --git a/docker/init-sql.sh b/docker/init-sql.sh
new file mode 100644
index 0000000..d4c3a6f
--- /dev/null
+++ b/docker/init-sql.sh
@@ -0,0 +1,5 @@
+#!/bin/bash
+
+set -e
+cd /opt/tasks
+DB_PASSWORD="`cat "$DB_PASSWORD_FILE"`" psql -vON_ERROR_STOP=1 -f database.sql
diff --git a/docker/nginx-templates/default.conf.template b/docker/nginx-templates/default.conf.template
new file mode 100644
index 0000000..1f8ec29
--- /dev/null
+++ b/docker/nginx-templates/default.conf.template
@@ -0,0 +1,21 @@
+server {
+    listen 80;
+
+    index index.php;
+    root /var/www/tasks/site;
+
+    location / {
+    	try_files $uri /index.php$request_uri;
+	
+    }
+
+    location /index.php/ {
+        fastcgi_pass application:9000;
+
+	fastcgi_split_path_info ^(.+?\.php)(/.*)$;
+        include fastcgi_params;
+	fastcgi_param PATH_INFO       $fastcgi_path_info;
+	fastcgi_param SCRIPT_NAME     "/index.php";
+	fastcgi_param SCRIPT_FILENAME $document_root/index.php;
+    }
+}