add entrypoint script for drush site install and update readme

Author: garyGoDev

.github/workflows/docker-build.yml

@@ -11,6 +11,10 @@ on:
   push:
     branches:
       - 'main'
+    paths-ignore:
+      - 'example/**'
+      - 'README.md'
+      - 'docs/**'
 
 jobs:
   docker-build:

Dockerfile

@@ -1,5 +1,8 @@
 # Start from the original Drupal image
 FROM drupal:10.2.6-php8.2-apache-bookworm
+# Set default environment variables
+# Set default config sync directory
+ENV DRUPAL_CONFIG_SYNC_DIRECTORY /var/configsync
 # Set working directory to root of drupal project set in base image
 WORKDIR /opt/drupal
 # Install drush and any additional Drupal extensions using Composer
@@ -14,12 +17,16 @@ RUN cp /usr/local/etc/php/php.ini-production /usr/local/etc/php/php.ini \
 RUN pecl install apcu \
     && docker-php-ext-enable apcu
 # Configure APCu
-RUN echo "apc.enabled=1" >> /usr/local/etc/php/php.ini \
-    && echo "apc.shm_size=256M" >> /usr/local/etc/php/php.ini \
-    && echo "apc.ttl=7200" >> /usr/local/etc/php/php.ini \
-    && echo "apc.enable_cli=0" >> /usr/local/etc/php/php.ini
+RUN { \
+        echo "apc.enabled=1"; \
+        echo "apc.shm_size=256M"; \
+        echo "apc.ttl=7200"; \
+        echo "apc.enable_cli=0"; \
+    } > /usr/local/etc/php/conf.d/apcu.ini
 # Copy default.settings.php to settings.php
 RUN cp /var/www/html/sites/default/default.settings.php /var/www/html/sites/default/settings.php
+# Create the DRUPAL_CONFIG_SYNC_DIRECTORY if it does not exist
+RUN mkdir -p $DRUPAL_CONFIG_SYNC_DIRECTORY && chown -R www-data:www-data $DRUPAL_CONFIG_SYNC_DIRECTORY
 # Append database configuration to settings.php
 # Append hash salt to settings.php
 # Append configuration sync directory to settings.php
@@ -39,6 +46,12 @@ RUN echo "\$databases['default']['default'] = array (" >> /var/www/html/sites/de
 # Set file permissions
 RUN chown -R www-data:www-data /var/www/html/sites/default/settings.php && \
     chmod 644 /var/www/html/sites/default/settings.php
+# Entrypoint script
+COPY entrypoint.sh /entrypoint.sh
+RUN chmod +x /entrypoint.sh
+ENTRYPOINT ["/entrypoint.sh"]
+# Run Apache in the foreground
+CMD ["apache2-foreground"]
 # Docs
-LABEL description="Single Dockerfile build of Drupal with drush and defaulted settings including Postgres"
-LABEL version="1.0"
+LABEL description="Dockerfile build of Drupal with drush and defaulted settings including Postgres"
+LABEL version="1.1"

README.md

@@ -1,2 +1,82 @@
-# docker-drupal-postgres
-Single Dockerfile build of Drupal with drush and defaulted settings including Postgres
+# Dockerized Drupal with Drush and Postgres
+
+This Dockerfile creates a Docker image for a Drupal application with Drush and Postgres support. It is based on the official Drupal image and includes additional configurations and extensions to support a more robust Drupal development environment.
+
+[![docker-build](https://github.com/garyGoDev/docker-drupal-postgres/actions/workflows/docker-build.yml/badge.svg)](https://github.com/garyGoDev/docker-drupal-postgres/actions/workflows/docker-build.yml)
+
+[DockerHub cloudgrounds/drupal-postgres](https://hub.docker.com/r/cloudgrounds/drupal-postgres)
+
+## Features
+
+- Based on `drupal:10.2.6-php8.2-apache-bookworm` image from [the official Drupal image](https://hub.docker.com/_/drupal/)
+- Includes Drush, a command-line shell and scripting interface for Drupal
+- Configured to use Postgres as the database
+- Includes APCu PHP extension for caching
+- Configures PHP for output buffering
+- Sets up default Drupal settings and file permissions
+
+## Usage
+
+To build the Docker image, navigate to the directory containing the Dockerfile and run:
+
+```bash
+docker build -t your-custom-image:1.0 .
+```
+
+To run drupal from the image use `docker compose` with the example file
+
+```bash
+HASH_SALT=yourreallyreallylongandrandomhash DRUPAL_ADMIN_PASS=yourfirstsupersafepassword POSTGRES_PASSWORD=yourothersupersafepassword docker-compose up -d
+```
+
+## Environment Variables
+
+The Dockerfile uses the following environment variables:
+
+- `POSTGRES_DB`: The name of your Postgres database
+- `POSTGRES_USER`: The username for your Postgres database
+- `POSTGRES_PASSWORD`: The password for your Postgres database
+- `POSTGRES_HOST`: The host of your Postgres database
+- `DRUPAL_HASH_SALT`: The hash salt for your Drupal application
+- `DRUPAL_CONFIG_SYNC_DIRECTORY`: The directory for Drupal configuration synchronization files. This should be outside web root. This defaults to `/var/configsync`
+- `DRUPAL_ADMIN_USER`: The username for your Drupal admin account
+- `DRUPAL_ADMIN_PASS`: The password for your Drupal admin account
+- `DRUPAL_ADMIN_EMAIL`: The email for your Drupal admin account
+
+## Volumes
+
+The Dockerfile specifies volumes for the Drupal installation and files directories. This allows you to persist data across container restarts and share data between containers. See the **Volumes** section in the official Drupal image.
+
+## Entrypoint Script
+
+The `entrypoint.sh` script is executed when the Docker container starts. It performs several checks and operations to ensure the Drupal site is properly set up.
+
+### Script Overview
+
+The script performs the following operations:
+
+1. Checks the status of the database connection and Drupal bootstrap using [Drush](https://www.drush.org/).
+2. If the database is not connected and Drupal is not bootstrapped, it installs the Drupal site using the `drush site-install` command.
+3. If the database is connected or Drupal is bootstrapped, it updates the database using the `drush updatedb` command and rebuilds the cache using the `drush cache-rebuild` command.
+4. Finally, it executes the command passed to the `docker run` command.
+
+Environment variables are included above and should be set in your Docker environment or in your `docker-compose.yml` file.
+
+### Drush
+
+[Drush](https://www.drush.org/) is a command-line shell and Unix scripting interface for Drupal. Drush core ships with lots of useful commands for interacting with code like modules/themes/profiles. Similarly, it runs update.php, executes SQL queries and DB migrations, and misc utilities like run cron or clear cache.
+
+For more information about the Drush commands used in this script, see the following links:
+
+- [drush status](https://www.drush.org/13.x/commands/core_status/)
+- [drush site-install](https://www.drush.org/13.x/commands/site_install/)
+- [drush updatedb](https://www.drush.org/13.x/commands/updatedb/)
+- [drush cache-rebuild](https://www.drush.org/13.x/commands/cache_rebuild/)
+
+## Running Apache
+
+By default, the Docker container will run Apache in the foreground.
+
+## Versions
+
+Versions are based on the run number in the GitHub Actions publication workflow.

entrypoint.sh

@@ -0,0 +1,19 @@
+#!/bin/bash
+# exit on error
+set -e
+# get drush status for checking if the site is installed
+DB_STATUS=$(drush status | grep "Database" | awk '{print $NF}')
+echo "Database connected: $DB_STATUS"
+DRUPAL_BOOTSTRAP_STATUS=$(drush status | grep "Drupal bootstrap" | awk '{print $NF}')
+echo "Drupal bootstrap: $DRUPAL_BOOTSTRAP_STATUS"
+# check if the site is installed
+if [ "$DB_STATUS" != "Connected" ] && [ "$DRUPAL_BOOTSTRAP_STATUS" != "Successful" ]; then
+    drush site-install standard --db-url=pgsql://$POSTGRES_USER:$POSTGRES_PASSWORD@$POSTGRES_HOST:5432/$POSTGRES_DB --site-name=$DRUPAL_SITE_NAME --account-name=$DRUPAL_ADMIN_USER --account-pass=$DRUPAL_ADMIN_PASS --account-mail=$DRUPAL_ADMIN_EMAIL --no-interaction
+fi
+# if the site is installed, run drush updatedb and cache-rebuild
+if [ "$DB_STATUS" == "Connected" ] || [ "$DRUPAL_BOOTSTRAP_STATUS" == "Successful" ]; then
+    drush updatedb --no-interaction
+    drush cache-rebuild
+fi
+# run the command passed to the docker run
+exec "$@"

example/docker-compose.yml

@@ -0,0 +1,26 @@
+# Drupal with PostgreSQL
+version: '3.1'
+
+services:
+
+  drupal:
+    image: your-custom-image:1.0
+    ports:
+      - 8080:80
+    environment:
+      POSTGRES_DB: postgres
+      POSTGRES_USER: postgres
+      POSTGRES_PASSWORD: ${POSTGRES_PASSWORD}
+      POSTGRES_HOST: postgres
+      DRUPAL_HASH_SALT: ${HASH_SALT}
+      DRUPAL_SITE_NAME: example
+      DRUPAL_ADMIN_USER: admin
+      DRUPAL_ADMIN_PASS: ${DRUPAL_ADMIN_PASS}
+      DRUPAL_ADMIN_EMAIL: [email protected]
+    restart: always
+
+  postgres:
+    image: postgres:16
+    environment:
+      POSTGRES_PASSWORD: ${POSTGRES_PASSWORD}
+    restart: always