renekreijveld/ddev-joomla
Watch
1
0
Fork
You've already forked ddev-joomla
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Page: 1. Installation
Pages
1. Installation 2. Configuration 3. Site Management 4. Database Operations 5. Backup 6. Site Navigation 7. Utilities 8. Updating Home
5 1. Installation
René Kreijveld edited this page 2026-09-24 11:46:36 +02:00
Table of contents

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)
    • Document root subfolder created inside every project folder (default: empty, meaning the project folder itself is the document root)
    • Backup folder where backups will be stored (default: ~/Development/Backups)
    • Default webserver type (nginx or apache)
  3. Download all scripts from the repository and install them to /usr/local/bin/
  4. Make all scripts executable
  5. Add the required gosite shell function to your shell startup file (~/.zshrc for zsh, ~/.bash_profile for bash on macOS, ~/.bashrc for bash on Linux)
  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.

Installing from a local zip file

If you downloaded and extracted a zip of the repository instead of running the command above (for example on a machine without direct access to the Forgejo repository), use installer/ddev-joomla-installer-local.sh instead. It installs the scripts from your local copy of the repository rather than downloading them:

cd installer
./ddev-joomla-installer-local.sh

It asks the same questions, creates the same config file and log, and installs the same scripts to /usr/local/bin/ — the only difference is where the scripts come from. It must be run from its location inside the extracted repository, since it looks for the scripts in ../src/Scripts relative to itself.

After Installation

Restart your terminal (or run source on the startup file the installer reported) to activate the gosite shell function.

Verify the installation by running:

jddev

This will display all available scripts and their options.

To check the configuration the installer wrote and whether all scripts were installed correctly, run:

jddev-status

See jddev-status for an example of its output.

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.

Uninstall

To remove the ddev-joomla scripts again, run:

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

The uninstaller will:

  1. Remove all installed ddev-joomla scripts from /usr/local/bin/
  2. Remove the gosite shell function from your shell startup file (a backup of that file is made first)
  3. Ask whether you also want to remove the configuration directory ~/.config/ddevjoomla/, which holds the config file and the log files

Your Joomla projects, websites, databases and backups are never touched by the uninstaller.

ddev-joomla