ddev-oxid

ddev-oxid is a DDEV add-on designed to streamline the installation and configuration of the OXID eShop within a DDEV environment. It automates common setup tasks, making it easier and faster for developers to get a fully configured OXID eShop up and running locally.

Why use ddev-oxid?

• Simplified Installation:
  Automatically installs the OXID eShop via Composer and sets up the environment with a single interactive command.

• Automated Configuration:
  Runs the necessary OXID CLI commands to configure your shop, including shop setup, demo data installation, administrator creation, license addition, and theme activation.

• Optimized for DDEV:
  Leverages DDEV’s containerized environment, ensuring consistent configuration and dependencies, and uses DDEV environment variables (e.g., for dynamic shop URL generation).

• Customizable and Interactive:
  The add-on provides interactive prompts to select the OXID version, set database parameters (defaulting to DDEV’s standard values), and optionally run additional configuration steps.

Requirements

• DDEV:
  Version 1.24.10 or above is required.

• PHP:
  Ensure that the PHP version configured in DDEV matches the requirements of the selected OXID eShop version (OXID 7.x needs PHP 8.0+ (7.5 needs 8.3), OXID 6.5 runs on PHP 7.4 to 8.1). The installer filters out versions that are too old or too new for the configured PHP version. Composer runs inside the DDEV web container, so it does not need to be installed on the host.

• Git:
  Git is required for fetching the add-on from the repository.

• Apache FPM:
  This add-on is configured to run with Apache FPM. The document root is set to htdocs/source for proper serving of the OXID eShop.

Quick start

In an empty project directory:

ddev config --project-type=php --php-version=8.3
ddev add-on get dazi-web/ddev-oxid
ddev restart
ddev install-oxid

ddev install-oxid guides you through the rest:

1. Pick OXID 7 (default) or 6.
2. Pick a version. Only versions that fit the PHP version of the project are listed, the newest is recommended (just press Enter).
3. Choose the quick installation (demo data, an admin user with a generated password, default theme) or answer the individual questions.

At the end you get the shop URL, the admin URL and the login. The checks run before the first question: a non-empty htdocs, a missing ddev restart (wrong docroot) or a PHP version that does not fit are reported right away.

Which PHP version to use: OXID 7.5 needs PHP 8.3, 7.2 to 7.4 need 8.2 or newer, 7.1 needs 8.1, 7.0 needs 8.0. OXID 6.5 runs on PHP 7.4 to 8.1.

Non-interactive installation

--quick (or -y) accepts all defaults without any question: OXID 7 unless --major is given, the newest stable version that fits the project’s PHP version, demo data, an admin user [email protected] with a generated password, the default theme. Every flag overrides its default:

ddev install-oxid --quick
ddev install-oxid --major=7 --version=dev-b-7.4-ce --language=de --demo-data \
  --admin-email=[email protected] --admin-password=secret --theme=apex

Flags: --quick / -y, --major (6 or 7), --version (e.g. dev-b-7.4-ce), --edition (ce default, pe, ee), --language (OXID 7), --demo-data / --no-demo-data, --admin-email, --admin-password (or env OXID_ADMIN_PASSWORD), --no-admin, --license-key, --theme, --shop-url.

Tested with

Installation and all commands were tested with OXID CE 7.4 (PHP 8.2) and OXID CE 6.5 (PHP 7.4) on DDEV 1.25. The minimum PHP versions for the other OXID releases are taken from the OXID requirements and have not been tried out, and the PE and EE editions have not been tested.

Note: --admin-password and ddev oxid-admin pass the password as a command line argument, so it is visible in the process list inside the container while the command runs. This is fine for local development.

Commands

Tips

• Mail: DDEV routes PHP mail() to Mailpit (ddev launch -m). Keep OXID’s mail method on “mail” to see outgoing mails there.
• Xdebug: Enable with ddev xdebug on; the project root maps to /var/www/html in PhpStorm.

OXID 6 and OXID 7

ddev install-oxid asks for the major version (or takes --major=6|7). The versions differ, and the add-on handles that:

After an OXID 6 installation, the setup directory is removed for security. The two SQL files needed by ddev oxid-reset are kept outside the web root in .ddev/oxid/legacy-sql.

Commands that do not exist in the installed version say so instead of failing with a stack trace. OXID 6 is no longer maintained, use it for legacy projects only.