Add docker

Author: tatevikg1

.dockerignore

@@ -0,0 +1,19 @@
+# Docker build context exclusions
+.git
+.gitignore
+.github
+.idea
+.vscode
+node_modules
+npm-debug.log
+yarn.lock
+composer.phar
+var/cache
+var/logs
+var/sessions
+.env
+Dockerfile*
+docker-compose*.yml
+**/.DS_Store
+**/Thumbs.db
+vendor/

Dockerfile

@@ -0,0 +1,53 @@
+# syntax=docker/dockerfile:1
+
+# Build a production image for phpList base-distribution (Symfony-based)
+FROM php:8.1-apache-bullseye
+
+# Set workdir
+WORKDIR /var/www/html
+
+# Install system dependencies and PHP extensions
+RUN apt-get update \
+    && apt-get install -y --no-install-recommends \
+        git unzip libzip-dev libicu-dev libpng-dev libonig-dev libxml2-dev \
+        libc-client2007e-dev libkrb5-dev libssl-dev \
+    && docker-php-ext-configure intl \
+    && docker-php-ext-configure imap --with-kerberos --with-imap-ssl \
+    && docker-php-ext-install -j"$(nproc)" \
+        pdo pdo_mysql zip intl imap \
+    && rm -rf /var/lib/apt/lists/*
+
+# Enable Apache modules and set DocumentRoot to /public
+RUN a2enmod rewrite headers \
+    && sed -ri 's!/var/www/html!/var/www/html/public!g' /etc/apache2/sites-available/000-default.conf \
+    && sed -ri 's!/var/www/!/var/www/html/public!g' /etc/apache2/apache2.conf \
+    && echo "<Directory /var/www/html/public>\n    AllowOverride All\n    Require all granted\n</Directory>" > /etc/apache2/conf-available/phplist.conf \
+    && a2enconf phplist
+
+# Copy composer definition first and install dependencies
+COPY composer.json composer.lock ./
+
+# Install Composer
+ENV COMPOSER_ALLOW_SUPERUSER=1 \
+    PATH="/usr/local/bin:${PATH}"
+RUN php -r "copy('https://getcomposer.org/installer', 'composer-setup.php');" \
+    && php composer-setup.php --install-dir=/usr/local/bin --filename=composer \
+    && rm composer-setup.php
+
+# Ensure config directory exists for Composer scripts that write into it
+COPY config ./config
+
+# Install PHP dependencies (include scripts so phpList creates config structure)
+RUN composer install --no-dev --no-interaction --prefer-dist --optimize-autoloader
+
+# Copy the rest of the application (except files ignored by .dockerignore)
+COPY . .
+
+# Ensure correct permissions for cache/logs
+RUN chown -R www-data:www-data var public \
+    && find var -type d -exec chmod 775 {} \; \
+    && find var -type f -exec chmod 664 {} \;
+
+# Expose port and run Apache
+EXPOSE 80
+CMD ["apache2-foreground"]

README.md

@@ -176,3 +176,31 @@ contribute and how to run the unit tests and style checks locally.
 This project adheres to a [Contributor Code of Conduct](CODE_OF_CONDUCT.md).
 By participating in this project and its community, you are expected to uphold
 this code.
+
+
+## Docker deployment
+
+The project includes a Docker setup to run phpList with Apache and MySQL.
+
+Quick start (development/test):
+
+- Build and start the stack: `docker compose up --build`
+- Open http://localhost:8080
+
+The app container is configured to read database settings from environment variables that match config/parameters.yml defaults. The provided docker-compose.yml sets:
+
+- PHPLIST_DATABASE_HOST=db
+- PHPLIST_DATABASE_PORT=3306
+- PHPLIST_DATABASE_NAME=phplistdb
+- PHPLIST_DATABASE_USER=phplist
+- PHPLIST_DATABASE_PASSWORD=phplist
+
+Notes:
+
+- For production deployments, build and push the image, then run it behind a reverse proxy or load balancer. Example:
+  - `docker build -t your-registry/phplist-base:latest .`
+  - `docker run -p 8080:80 --env PHPLIST_DATABASE_HOST=... --env PHPLIST_DATABASE_NAME=... --env PHPLIST_DATABASE_USER=... --env PHPLIST_DATABASE_PASSWORD=... your-registry/phplist-base:latest`
+- Persist the MySQL data using the db_data volume defined in docker-compose.yml, or bind mount your own volume.
+- You can also mount ./var to persist logs/cache between restarts. See commented volume in docker-compose.yml.
+- The container uses Apache with DocumentRoot set to /var/www/html/public and mod_rewrite enabled.
+- The base image uses PHP 8.1 (php:8.1-apache-bullseye) to match the Composer constraint (^8.1) and to ensure the IMAP build dependencies are available. You can bump to a newer 8.x tag (e.g., 8.3) if your deployment prefers it, but ensure IMAP build deps are present for that base.

docker-compose.yml

@@ -0,0 +1,43 @@
+version: "3.9"
+
+services:
+  app:
+    build: .
+    image: phplist/base-distribution:latest
+    ports:
+      - "8080:80"
+    environment:
+      # Database connection (mirrors config/parameters.yml expectations)
+      PHPLIST_DATABASE_DRIVER: pdo_mysql
+      PHPLIST_DATABASE_HOST: db
+      PHPLIST_DATABASE_PORT: 3306
+      PHPLIST_DATABASE_NAME: phplistdb
+      PHPLIST_DATABASE_USER: phplist
+      PHPLIST_DATABASE_PASSWORD: phplist
+      # Symfony environment
+      APP_ENV: prod
+      APP_DEBUG: "0"
+    depends_on:
+      - db
+    # Uncomment to persist logs/cache outside container
+    # volumes:
+    #   - ./var:/var/www/html/var
+
+  db:
+    image: mysql:8.0
+    environment:
+      MYSQL_DATABASE: phplistdb
+      MYSQL_USER: phplist
+      MYSQL_PASSWORD: phplist
+      MYSQL_ROOT_PASSWORD: root
+    command: ["--default-authentication-plugin=mysql_native_password", "--innodb-buffer-pool-size=64M"]
+    volumes:
+      - db_data:/var/lib/mysql
+    healthcheck:
+      test: ["CMD-SHELL", "mysqladmin ping -h 127.0.0.1 -u$$MYSQL_USER -p$$MYSQL_PASSWORD || exit 1"]
+      interval: 10s
+      timeout: 5s
+      retries: 10
+
+volumes:
+  db_data: