DDEV

DDEV is an open source tool for launching local PHP development environments in minutes.

DDEV creates a config.yaml, this contains all settings for your project. This can be versioned in GIT and supports collaborative work in teams or freelancers.

Install DDEV

DDEV is available for all platforms, please refer to the DDEV documentation for the installation of your platform.

Create project

mkdir contao && cd contao

ddev config --project-type=php --docroot=public --webserver-type=apache-fpm --php-version=8.2

ddev composer create-project contao/managed-edition:5.6

ddev dotenv set .env.local --database-url=mysql://db:db@db:3306/db --mailer-dsn=smtp://localhost:1025

ddev exec contao-console contao:migrate --no-interaction

ddev exec contao-console contao:user:create --username=admin --name=Administrator --email=admin@example.com --language=en --admin

ddev launch contao

mkdir contao && cd contao

ddev config --project-type=php --docroot=public --webserver-type=apache-fpm --php-version=8.2

ddev dotenv set .env.local --database-url=mysql://db:db@db:3306/db --mailer-dsn=smtp://localhost:1025

ddev start
ddev exec "wget -O public/contao-manager.phar.php https://download.contao.org/contao-manager/stable/contao-manager.phar"

ddev launch contao-manager.phar.php

Additional information

You can find more information about managing projects here.

• ddev start starts the project, ddev stop ends it. Make sure beforehand that you have changed to the project folder.

• ddev poweroff can stop all started projects/containers from any directory.

• With ddev ssh you can switch to the shell of the container and work on the console. The ddev binary is not available in the container, so first switch to the host console with exit.

• ddev describe gives an overview of the services available in the project and how to access them.

• ddev xdebug on starts XDebug. Information about the IDE setup

Custom PHP Configuration

DDEV can be used to provide additional PHP configurations for a project. You can add any number of .ini files in the directory .ddev/php/. Subsequent changes require a ddev restart. Further information can be found in the DDEV documentation.

An example file in .ddev/php/my-php.ini could look like this:

[PHP]
memory_limit = -1

Database Tools

If you want to use a database client such as Adminer or phpMyAdmin for example, you can install these as a Addon.

Example: Adminer

ddev add-on get ddev/ddev-adminer && ddev restart

Example: phpMyAdmin

ddev add-on get ddev/ddev-phpmyadmin && ddev restart

With ddev describe you can find out how to access the respective database tool.

Setting up a cron job in DDEV

since 5.5 The back end search can be activated by setting up the Contao cronjob framework.

To do this, first install the cron add-on in DDEV:

ddev add-on get ddev/ddev-cron

Then create a /.ddev/web-build/contao.cron file with the following content:

* * * * * php /var/www/html/vendor/bin/contao-console contao:cron

Then restart the DDEV project/container:

ddev restart

The Contao cronjob is executed every minute. When setting up for the first time, it may take 1-2 minutes before the search bar is available in the back end.

Setting up a local shared repository path inside your DDEV container

If you want to configure a path in your container where all your local bundles are stored and which you can use in your composer.json, you can do so as follows:

Create a file inside the ./ddev folder with the name docker-compose.bundles.yaml.

The content can look like this (Please adjust the paths to suit your needs.):

services:
  web:
    volumes:
    - /home/$USER/repository:/home/$USER/repository:rw

Then restart the container with ddev restart.

Now you can use the repository in your root composer.json.

"repositories": [
  {
    "type": "path",
    "url": "~/repository/my-local-bundle"
  }
],