TYPO3 Core contribution setup with DDEV

Prerequisites

• Install Docker and other ddev system requirements.
• Install DDEV as described in the Installation instructions.
• You have cloned the TYPO3 git repository as described in git clone and have switched to the directory which contains the local git repository.

Configure DDEV

For the TYPO3 CMS core latest (main branch) DDEV v1.16.5 or later is suggested to have the correct setup included

ddev config

DDEV should suggest the correct defaults and you just need to press ENTER:

> Project name (t3coredev):

> Docroot Location (current directory):

> Found a typo3 codebase at /var/www/t3coredev.
> Project Type [backdrop, drupal6, drupal7, drupal8, drupal9, laravel, magento, magento2, php, typo3, wordpress] (typo3):

Change configuration

In order to make further changes to the configuration, use ddev config as shown below or edit the configuration file .ddev/config.yaml manually.

# Set correct PHP version:
ddev config --php-version='8.2'

# Change to Apache webserver because using htaccess rules works out of the TYPO3-box
# and needs no custom NGINX configuration
ddev config --webserver-type='apache-fpm'

# Add necessary packages for the npm build process,
# (only needed if you are working on assets):
ddev config --nodejs-version='22'
ddev config --webimage-extra-packages='automake,build-essential,locales-all'

Optionally, set a new HTTP/HTTPS port to avoid conflicts with local defaults. Error message: Failed to start t3coredev: Unable to listen on required ports, port 80 is already in use,

ddev config --router-http-port='8090'
ddev config --router-https-port='8443'

Start DDEV

ddev start

DDEV should now show a URL under which the site can be reached:

> TYPO3 does not seem to have been set up yet, missing LocalConfiguration.php (/var/www/t3coredev/typo3conf/LocalConfiguration.php)
> Generating AdditionalConfiguration.php file for database connection.
> Successfully started t3coredev
> Project can be reached at http://t3coredev.ddev.site http://127.0.0.1:32773

Ignore the warning about missing LocalConfiguration.php for now. We will take care of that below.

Build

It is recommended to run tasks such as composer install etc. via the runTests.sh script. We provide the direct commands in some places - in case there is good reason to run the commands directly. But, if you need the direct commands, you are encouraged to look them up using the instructions in Direct commands without Docker.

ddev composer install

Build/Scripts/runTests.sh -s composerInstall

The following is not necessary for the initial build, but once you change some assets (for example Typescript, SCSS files), you must build them. You might like to try this now:

cd Build
nvm use
npm install
npm run build
// or: npm run watch:build

ddev exec "cd Build && npm install"
ddev exec "cd Build && npm run build"

Build/Scripts/runTests.sh -s build

The first command is required once, the second (build) command is required after every change of a resource file.

Be aware that until TYPO3 v11.5 yarn was used.

DDEV describe

Let DDEV dump information:

ddev describe

Displays information about the project, its URLs and access to phpMyAdmin, MailHog and the MySQL database.

FIRST_INSTALL

Create a file FIRST_INSTALL:

touch FIRST_INSTALL

Setup your TYPO3 installation

Now load the URL by running the command ddev launch.

You will now be guided through the basic installation steps by TYPO3.

Additional setup

Be sure to add the .ddev directory to your local gitignore (e.g. .git/info/exclude).

Shutdown DDEV

When you are done you can do:

ddev stop

For a list of commands see:

ddev help

Next step

If you are in the middle of setting up a TYPO3 installation for core development, continue with

• Use EXT:styleguide.

Resources

Remember, you can use the Slack channels to ask for help! Follow the general convention for the channels: not too chatty, get straight to the point and ask, be nice. Register for the TYPO3 slack workspace if you have not done so already.