Automate local WordPress setup

Author: Tsvetan Stoychev

.env.example

@@ -0,0 +1,13 @@
+# Local Docker development defaults. Copy to .env to override them.
+WORDPRESS_PORT=8080
+WORDPRESS_DB_HOST=db:3306
+WORDPRESS_DB_NAME=wordpress
+WORDPRESS_DB_USER=wordpress
+WORDPRESS_DB_PASSWORD=wordpress
+WORDPRESS_DB_ROOT_PASSWORD=root
+
+WP_URL=http://localhost:8080
+WP_TITLE=Basicrum Local
+WP_ADMIN_USER=admin
+WP_ADMIN_PASSWORD=basicrum-dev-password
+WP_ADMIN_EMAIL=admin@example.test

.gitignore

@@ -4,6 +4,9 @@
 *.swp
 *.swo
 
+# Local Docker configuration
+/.env
+
 # Composer
 /plugins/basicrum/vendor/
 

Makefile

@@ -2,6 +2,7 @@ COMPOSE ?= docker compose
 PHP_SERVICE = php
 WP_SERVICE = wordpress
 DB_SERVICE = db
+WPCLI_SERVICE = wpcli
 PLUGIN_DIR = plugins/basicrum
 PLUGIN_WORKDIR = /workspace
 TEST_DB_NAME = wordpress_test
@@ -10,12 +11,13 @@ TEST_DB_PASS = root
 TEST_DB_HOST = db
 WP_TEST_VERSION ?= latest
 
-.PHONY: help build up down restart logs shell composer-install lint lint-fix lint-php unit integration-setup integration test package clean
+.PHONY: help build up down restart logs shell composer-install wp-install lint lint-fix lint-php integration-setup integration test package clean
 
 help:
 	@echo "Targets:"
 	@echo "  build              Build or rebuild local Docker images"
-	@echo "  up                 Start WordPress and MySQL for local development"
+	@echo "  up                 Start and provision local WordPress with Basicrum active"
+	@echo "  wp-install         Install WordPress and activate Basicrum if needed"
 	@echo "  down               Stop containers"
 	@echo "  restart            Restart containers"
 	@echo "  logs               Tail logs from WordPress and MySQL"
@@ -34,7 +36,12 @@ build:
 	$(COMPOSE) build $(PHP_SERVICE)
 
 up:
+	$(MAKE) composer-install
+	$(MAKE) wp-install
+
+wp-install:
 	$(COMPOSE) up -d $(DB_SERVICE) $(WP_SERVICE)
+	$(COMPOSE) run --rm $(WPCLI_SERVICE) sh /tools/setup-wordpress.sh
 
 down:
 	$(COMPOSE) down
@@ -77,4 +84,4 @@ package:
 clean:
 	$(COMPOSE) down -v
 	rm -f basicrum.zip
-	rm -rf release
+	rm -rf release

README.md

@@ -25,7 +25,16 @@ make lint
 make package
 ```
 
-The WordPress development site is exposed at `http://localhost:8080`.
+### Local WordPress
+
+`make up` installs Composer dependencies, starts the stack, provisions
+WordPress on a new database, and activates Basicrum. The development site is at
+`http://localhost:8080/wp-admin/`.
+
+Default local administrator credentials are `admin` /
+`basicrum-dev-password`. Copy `.env.example` to `.env` to override the
+port, database, site, or administrator values. `make down` preserves the
+site data; `make clean` resets it.
 
 ## Plugin Source
 

docker-compose.yml

@@ -4,16 +4,16 @@ services:
     container_name: basicrum-db
     command: --default-authentication-plugin=mysql_native_password
     environment:
-      MYSQL_DATABASE: wordpress
-      MYSQL_USER: wordpress
-      MYSQL_PASSWORD: wordpress
-      MYSQL_ROOT_PASSWORD: root
+      MYSQL_DATABASE: ${WORDPRESS_DB_NAME:-wordpress}
+      MYSQL_USER: ${WORDPRESS_DB_USER:-wordpress}
+      MYSQL_PASSWORD: ${WORDPRESS_DB_PASSWORD:-wordpress}
+      MYSQL_ROOT_PASSWORD: ${WORDPRESS_DB_ROOT_PASSWORD:-root}
     ports:
       - "3306:3306"
     volumes:
       - db_data:/var/lib/mysql
     healthcheck:
-      test: ["CMD", "mysqladmin", "ping", "-h", "127.0.0.1", "-proot"]
+      test: ["CMD", "mysqladmin", "ping", "-h", "127.0.0.1", "-p${WORDPRESS_DB_ROOT_PASSWORD:-root}"]
       interval: 10s
       timeout: 5s
       retries: 10
@@ -25,16 +25,37 @@ services:
       db:
         condition: service_healthy
     environment:
-      WORDPRESS_DB_HOST: db:3306
-      WORDPRESS_DB_NAME: wordpress
-      WORDPRESS_DB_USER: wordpress
-      WORDPRESS_DB_PASSWORD: wordpress
+      WORDPRESS_DB_HOST: ${WORDPRESS_DB_HOST:-db:3306}
+      WORDPRESS_DB_NAME: ${WORDPRESS_DB_NAME:-wordpress}
+      WORDPRESS_DB_USER: ${WORDPRESS_DB_USER:-wordpress}
+      WORDPRESS_DB_PASSWORD: ${WORDPRESS_DB_PASSWORD:-wordpress}
     ports:
-      - "8080:80"
+      - "${WORDPRESS_PORT:-8080}:80"
     volumes:
       - wordpress_data:/var/www/html
       - ./plugins/basicrum:/var/www/html/wp-content/plugins/basicrum
 
+  wpcli:
+    image: wordpress:cli-php8.2
+    user: "33:33"
+    depends_on:
+      db:
+        condition: service_healthy
+    environment:
+      WORDPRESS_DB_HOST: ${WORDPRESS_DB_HOST:-db:3306}
+      WORDPRESS_DB_NAME: ${WORDPRESS_DB_NAME:-wordpress}
+      WORDPRESS_DB_USER: ${WORDPRESS_DB_USER:-wordpress}
+      WORDPRESS_DB_PASSWORD: ${WORDPRESS_DB_PASSWORD:-wordpress}
+      WP_URL: ${WP_URL:-http://localhost:8080}
+      WP_TITLE: ${WP_TITLE:-Basicrum Local}
+      WP_ADMIN_USER: ${WP_ADMIN_USER:-admin}
+      WP_ADMIN_PASSWORD: ${WP_ADMIN_PASSWORD:-basicrum-dev-password}
+      WP_ADMIN_EMAIL: ${WP_ADMIN_EMAIL:-admin@example.test}
+    volumes:
+      - wordpress_data:/var/www/html
+      - ./plugins/basicrum:/var/www/html/wp-content/plugins/basicrum
+      - ./tools:/tools:ro
+
   php:
     build:
       context: ./docker/php

tools/setup-wordpress.sh

@@ -0,0 +1,37 @@
+#!/usr/bin/env sh
+
+set -eu
+
+WP_PATH=${WP_PATH:-/var/www/html}
+
+until [ -f "${WP_PATH}/wp-includes/version.php" ]; do
+	echo "Waiting for WordPress files..."
+	sleep 1
+done
+
+mkdir -p "${WP_PATH}/wp-content/uploads"
+
+if [ ! -f "${WP_PATH}/wp-config.php" ]; then
+	wp config create \
+		--path="${WP_PATH}" \
+		--dbname="${WORDPRESS_DB_NAME}" \
+		--dbuser="${WORDPRESS_DB_USER}" \
+		--dbpass="${WORDPRESS_DB_PASSWORD}" \
+		--dbhost="${WORDPRESS_DB_HOST}" \
+		--skip-check
+fi
+
+if ! wp core is-installed --path="${WP_PATH}"; then
+	wp core install \
+		--path="${WP_PATH}" \
+		--url="${WP_URL}" \
+		--title="${WP_TITLE}" \
+		--admin_user="${WP_ADMIN_USER}" \
+		--admin_password="${WP_ADMIN_PASSWORD}" \
+		--admin_email="${WP_ADMIN_EMAIL}" \
+		--skip-email
+fi
+
+if ! wp plugin is-active basicrum --path="${WP_PATH}"; then
+	wp plugin activate basicrum --path="${WP_PATH}"
+fi