Setup ddev environment (docker based)¶
On this page:
- Clone your website repository (in case for typo3.org - find it here)
- Copy the ./auth.json.example to ./auth.json
- Edit the ./auth.json file and add your gitlab (gitlab.typo3.org) account
- Download and extract the ZIP file the DB dump, see Download assets
ddev import-dband follow the wizard to import the SQL file into the database
- Browse to the frontend or the backend
To download the database dump, you need to visit the CI/CD area. For e.g. the typo3.org project, it’s here.
Check for an existing maintenance stage in one of the pipelines:
Then open the stage and click on the play button to create a dump for local environment:
Wait for the build to end and click on the result page.
There you can see the
Download link in the right column:
The CSS and JS are built on every start of ddev. If you need to update them, just run
If you work on CSS and JS, you are able to use the built-in
npm in the docker container by
npm watch --prefix=private/typo3conf/ext/t3olayout/Build
- Change CSS and JS, the changes are generated live
As there are no backend users in the dump, you need to setup a local admin account.
../bin/typo3cms database:updateschemato update the database because the dump included in the assets you downloaded is missing some tables like sys_domain or caching related ones.
../bin/typo3cms backend:createadminand set your username and password in the prompt. (You may need to call one of the scripts directly in the given directory, f.e. `php typo3-console.php backend:createadmin
If you want to use the Solr server (important for TER) you need to use the built-in Solr docker container. You can access the Solr admin panel: typo3.org.ddev.local:8983
The Solr docker image is running by default and is usable without configuration.
- The command
ddev startfails due to npm processes. What can I do?
- You need to remove the folder
private/typo3conf/ext/t3olayout/Build/and clear the npm caches on the machine with
ddev exec npm cache clear --force. After that,
ddev startshould work again.
- I can’t login in the frontend with my LDAP user.
- Due to data protection issues, LDAP login isn’t working for the local development. You need to setup an own frontend user.