2 1. Installation
René Kreijveld edited this page 2026-05-31 09:54:47 +02:00

Installation

Requirements

  • A working DDEV installation
  • macOS, Linux, or Windows with WSL2
  • curl and unzip available in your shell

Install

Run the following command in your terminal:

/bin/bash -c "$(curl -fsSL https://code.kreijveld.com/renekreijveld/ddev-joomla/raw/branch/main/installer/ddev-joomla-installer.sh)"

The installer will:

  1. Create the configuration directory ~/.config/ddevjoomla/
  2. Prompt you for your preferred settings:
    • Root folder where your Joomla sites will live (default: ~/Development/sites)
    • Backup folder where backups will be stored (default: ~/Development/backup)
    • Default webserver type (nginx or apache)
  3. Download all scripts from GitHub and install them to /usr/local/bin/
  4. Make all scripts executable
  5. Add the required gosite shell function to your ~/.zshrc or ~/.bashrc
  6. Create an installation log at ~/.config/ddevjoomla/ddev-joomla-install.log

Note: The installer automatically creates backups of any existing configuration files and scripts before making changes.

After Installation

Restart your terminal (or run source ~/.zshrc / source ~/.bashrc) to activate the gosite shell function.

Verify the installation by running:

jddev

This will display all available scripts and their options.

Configuration

The installer creates a configuration file at ~/.config/ddevjoomla/config. You can edit this file at any time to change your defaults. See the Configuration page for details.