Drupal Local Development Environment

This project provides a Docker-based local development environment for Drupal 11 using PHP-FPM, Nginx, and PostgreSQL.

Prerequisites

• Docker
• Docker Compose
• mkcert (for local HTTPS trust)

Setup Guide

1. Initial Installation

Run the following script to create your .env file (interactively), build Docker images, and download Drupal:

./site setup

2. Start Services

Use the management script to handle /etc/hosts updates, HTTPS certificates, and start the containers:

./site start

Note: This will prompt for your sudo password to update /etc/hosts.

3. Drupal Installation

• Open https://drupal.local
• Database Settings (PostgreSQL):
  • Database name: drupal_db (or as set in .env)
  • Database username: drupal_user
  • Database password: verystrongpassword (or as set in .env)
  • Host: postgres

Maintenance

Management Script (site)

The ./site script provides easy management of the containers and local configuration:

• ./site setup: Interactively creates .env, builds images, and initializes Drupal.
• ./site start: Verifies ports 80/443, updates /etc/hosts, generates SSL certs, and starts containers.
• ./site stop: Stops and removes all containers for the project.
• ./site restart: Stops and then starts the environment again.
• ./site reset: Danger: Resets the project back to the clean boilerplate state.

Common Tasks

Shell Access

To enter the PHP container and run commands directly:

docker exec -it ${PROJECT_NAME}_php bash

(Alternatively, you can use docker compose exec php bash)

Using Drush

Drush is installed as a Composer dependency. You can run it easily using the helper script:

./drush [command]

Example: Clear all caches:

./drush cr

Using Composer

Install new modules or dependencies:

docker compose exec php composer require drupal/[module_name]

Database Management

To enter the PostgreSQL shell:

docker compose exec postgres psql -U drupal_user -d drupal_db

Project Structure

• web/: Drupal root (index.php, themes, modules).
• vendor/: Composer-managed dependencies and Drush.
• nginx.conf.template: Template for Nginx server configuration.
• Dockerfile: Custom PHP image definition.
• docker-compose.yml: Service orchestration.