mcpField
T
typo3-ddev

typo3-ddev

github.com/netresearchCloud & DevOps844 installsUpdated 3d ago
Repository

About typo3-ddev

A setup and troubleshooting skill for TYPO3 projects using DDEV, with guidance for version-specific installation, databases, PHP settings, and verification. It also describes a provisioning path for environments without DDEV.

Key features

  1. 01DDEV-based TYPO3 setup
  2. 02Version-specific installation steps
  3. 03Database and PHP configuration
  4. 04Post-setup checks
  5. 05Provisioning without DDEV
  6. 06Troubleshooting guidance

Use cases

  1. 01Setting up TYPO3 versions locally
  2. 02Choosing and configuring a database
  3. 03Verifying installation and login routes
  4. 04Provisioning TYPO3 without DDEV

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/netresearch/typo3-ddev-skill --skill typo3-ddev

After installing, type/typo3-ddevin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

assets/templates/
.envrc
config.redis.php.example
config.yaml
docker-compose.git-info.yaml
docker-compose.ofelia.yaml.optional
docker-compose.services-redis.yaml.optional
docker-compose.services.yaml.optional
docker-compose.web.yaml
index.html.netresearch.template
index.html.typo3.template
Makefile.template
assets/templates/apache/
apache-site.conf
docs.conf
v11.conf
v12.conf
v13.conf
v14.conf
assets/templates/commands/
install-all
install-v11
install-v12
install-v13
install-v14
assets/templates/commands/host/
docs
pre-start-git-info
setup
assets/templates/commands/web/
configure-extension.optional
generate-index
generate-makefile
install-introduction.optional
assets/templates/homeadditions/
.bashrc_additions.optional

Details

From the project README

TYPO3 DDEV Setup Skill

CRITICAL: URL Scheme

NEVER guess URLs. Read name: from .ddev/config.yaml, then apply the subdomain pattern:

https://v{VERSION}.{sitename}.ddev.site/typo3/ · Landing: https://{sitename}.ddev.site/ · Docs: https://docs.{sitename}.ddev.site/

Each version gets a vhost (/var/www/html/v{VERSION}) via additional_hostnames. Never infer URLs from directory listings.

Credentials: admin / Joh316!!

Container Priority

  1. .ddev/ exists → ddev exec
  2. docker-compose.yml → docker compose exec
  3. System tools only if no container. Use project's configured PHP.

No DDEV available (CI, container, agent harness — DDEV drives Docker): read .ddev/config.yaml and .ddev/commands/, then scripts/provision-without-ddev.sh --extension . --serve. The distribution ships no .htaccess, so /typo3/ answers 200 while sub-routes 404 — references/without-ddev.md.

In-container edits: docker cp in, then ddev exec — not heredocs/php -r. See references/container-file-editing.md.

Quick Start

ddev start && ddev install-all    # All versions (11/12/13/14)
ddev install-v14                  # v14.3 LTS (default / gold standard)
ddev install-v13                  # v13.4 LTS

Database Selection

MariaDB 10.11 (default) · SQLite · PostgreSQL 16 · MySQL 8.0. See references/advanced-options.md, references/0002-mariadb-default-with-database-alternatives.md.

PHP Management

php_version: "8.3" in config.yaml. Upgrade via .ddev/web-build/Dockerfile. Settings: .ddev/php/custom.ini. See references/0003-php-version-management.md.

TYPO3 Version Differences

v12v13v14.3 LTS
Setupinstall:setup --use-existing-databasesetupsetup
ActivationAutoextension:setupextension:setup
composer.jsonoptionaloptionalrequired (#108310)
Themebootstrap-packagebootstrap-packageCamino (#108539)
Fluid2.x4.x5.x strict (#108148)
CKEditor41–4241–4247

See references/typo3-12-cli-changes.md.

Post-Setup Verification

ddev status, ddev describe, ddev exec -d /var/www/html/v13 vendor/bin/typo3 extension:list --active. Check a consequence, not a status: /typo3/login must answer 200. See references/post-setup-verification.md.

Optional Services & Commands

  • Valkey 8 (default) or Redis 7: references/0001-valkey-default-with-redis-alternative.md
  • Ofelia: scheduler automation · ddev generate-makefile / generate-index / docs / xdebug on

Extension Naming

Hyphens for composer (nr-llm), underscores for TYPO3 key (nr_llm). Source: composer.json name.

Troubleshooting

IssueSolution
Port conflictrouter_http_port: "8080" / router_https_port: "8443"
Database existsddev mysql -e "DROP DATABASE v13; CREATE DATABASE v13;"
Extension not foundddev exec -d /var/www/html/v13 vendor/bin/typo3 cache:flush
Windows health check/phpstatus endpoint with php-fpm.sock
PHP settings ignored.ddev/php/custom.ini
Full cleanupddev delete --omit-snapshot --yes, remove volumes

References

TopicFile in references/
Without DDEVwithout-ddev.md
Prerequisites, quick start{prerequisites-validation,quickstart}.md
Advanced, post-setup, branding{advanced-options,post-setup-verification,index-page-generation}.md
ADRs · Windows{0001,0002,0003}-*.md · windows-{fixes,optimizations}.md
Docs rendering, troubleshooting{documentation-rendering,troubleshooting}.md

Comments

Markdown supported