ddev-joomla

A collection of Bash scripts by René Kreijveld that enhance Joomla development workflows within DDEV.

DDEV is a Docker-based PHP development environment that runs on macOS, Windows (WSL2), and Linux.

Features

• Create a new DDEV Joomla project with a single command
• Clone an existing project (including the database) to a new project name
• Switch the PHP version of a project with a single command
• Automatically download and install the latest Joomla version
• Support for the /api endpoint when running on Nginx
• Optional document root subfolder (public, htdocs, ...) inside the project folder
• Set the essential DDEV values in a Joomla configuration.php
• Export and import MariaDB database dumps (full database or single table)
• Create full website backups (database + files)
• Show Joomla and DDEV info for the current project
• Show and toggle Xdebug
• Delete a Joomla project and clean up all resources
• List all installed Joomla projects (versions 1.0 and up)
• Interactively navigate to any Joomla site folder
• Set correct file and folder permissions

Requirements

A working DDEV installation is required. See ddev.com/get-started for instructions.

Scripts

Script	Purpose
jaddsite	Create a new DDEV Joomla project
jdelsite	Permanently delete a DDEV Joomla project
jclone	Clone an existing DDEV Joomla project (including the database) to a new project name
jsetconfig	Set the essential DDEV values (database, log, tmp and live_site) in configuration.php
jphpswitch	Switch the PHP version of an existing DDEV Joomla project
jxdb	Show, enable or disable Xdebug
jdbdump	Export the DDEV database to a SQL dump file
jdbdumptable	Export a single database table to a SQL dump file
jdbdumpall	Export databases of all DDEV Joomla projects
jdbimp	Import a SQL dump file into the DDEV database
jbackup	Full site backup: database dump + compressed archive
jbackupall	Full backup of all DDEV Joomla projects
gosite	Interactively navigate to a Joomla site folder
jlistjoomlas	List all Joomla sites under the configured root folder
joomlainfo	Show the Joomla version and the DDEV project details of the current site
jddev-vsc-xdb	Show the default VSCode launch.json for debugging with Xdebug
jlatest	Download and extract the latest (or a specific) Joomla release
setrights	Set correct file (644) and folder (755) permissions
jddev	Show all available scripts and their parameters
jddev-status	Show the ddev-joomla configuration and the state of the installation
jddev-update	Update all ddev-joomla scripts from the repository
jddev-checkupdate	Background helper that checks once a day for available script updates

Quick Start

1. Install the scripts with a single curl command
2. Run jaddsite -n mysite -j to create a new Joomla site
3. Run ddev launch inside the site folder to open it in your browser

Support the Project

If you find this tool useful, please consider making a donation to support further development.