How shyam-k/ddev-typo3-src works
Project type + purpose (what you are diagramming)
This repo is not an application codebase in the classic sense (no src/, no custom backend/frontend). It’s an infrastructure + bootstrap template to spin up a TYPO3 “legacy / without-composer” installation locally using DDEV (Docker-based) and to install TYPO3 from get.typo3.org on first ddev start, using symlinks per TYPO3’s official “get and unpack” approach.
• Local developer machine → DDEV orchestration → Docker containers
• Post-start hooks that run the install script
• TYPO3 runtime inside the web container (PHP + webserver)
• Database container (MariaDB/MySQL configured in .ddev/config.yaml)
• File layout + symlinked TYPO3 source in/under htdocs
• External dependency: get.typo3.org (download source tarball/zip)
• Optional: local extensions folder (packages by default) mapped into the container
File structure analysis (what maps to components)
From the tree:
• .ddev/config.yaml
• The *control plane* of the project.
• Defines webroot (htdocs), PHP version, DB type/version.
• Contains post-start hooks (“doing the whole magic”) that trigger installation if TYPO3 isn’t already set up.
• Carries environment variables like TYPO3_MAJOR_VERSION, optionally TYPO3_SRC_VERSION, and TYPO3_LOCAL_EXTENSIONS.
• bin/install-typo3
• The bootstrapper / installer script invoked by DDEV hooks.
• Downloads TYPO3 source for the configured version and sets up symlinks and initial structure under htdocs.
• htdocs/
• Document root for the web container.
• Initially mostly empty (.gitkeep), later populated by the installer (including symlinks to the TYPO3 source distribution and generated runtime dirs).
No app code, no tests. The “logic” is in DDEV hooks + the installer script.
README-derived runtime behavior (key flows to show)
Critical behaviors mentioned explicitly:
• On ddev start, if TYPO3 is not already setup, the hooks run and install TYPO3.
• TYPO3 version selection:
• TYPO3_MAJOR_VERSION (default behavior per branch)
• or TYPO3_SRC_VERSION (pin exact release; overrides major)
• Default docroot is htdocs (can be changed in .ddev/config.yaml)
• Windows symlink constraints (developer mode/admin shell) — not a component, but note it as an annotation.
• Upgrade procedure relies on the same mechanism (change versions in config, restart, run TYPO3 upgrade wizard), and stresses DB export/import.
Optional feature:
• Local extensions via a host folder (default packages) mounted/available to TYPO3; configurable via TYPO3_LOCAL_EXTENSIONS.
Developer Workstation (Host OS)
• Repo working copy (.ddev/, bin/, htdocs/, optional packages/)
• DDEV CLI
DDEV / Docker Runtime (Orchestrator layer)
• DDEV project config (.ddev/config.yaml)
• Responsible for container lifecycle and hook execution
Web Container
• Webserver + PHP (version per config)
• TYPO3 runtime
• Mounted docroot: htdocs/
Database Container
• MariaDB or MySQL (version per config)
• Used by TYPO3 install tool and runtime
External TYPO3 Distribution Source
• https://get.typo3.org
• Download target for TYPO3 tarball/zip based on TYPO3_MAJOR_VERSION/TYPO3_SRC_VERSION
Browser (User Agent)
• Accesses the TYPO3 Install Tool and later the TYPO3 backend/frontend via DDEV routing
(Optional) Local Extensions Folder
• packages/ on host (or custom folder)
• Consumed by TYPO3 as local extensions (composer-like)
Lifecycle / orchestration
• Developer → ddev start → DDEV orchestrates Docker containers
• DDEV → Web container: executes post-start hooks
• Post-start hook → bin/install-typo3 (inside container context)
Install-time download + filesystem wiring
• bin/install-typo3 → get.typo3.org (HTTP download)
• bin/install-typo3 → htdocs/ (extracts TYPO3 source + creates symlinks)
• Web container ↔ htdocs/ (docroot mount; TYPO3 reads/writes runtime dirs)
Runtime
• Browser → Web container (HTTP)
• Web container ↔ DB container (SQL)
• TYPO3 runtime ↔ optional local extensions directory (reads extensions)
• Developer → ddev export/ddev import → DB container (backup/restore)
• Developer edits .ddev/config.yaml → changes PHP/DB/TYPO3 version → ddev start reruns hooks → TYPO3 upgrade wizard in browser
Architectural patterns/design principles used
For this repo, the notable patterns are:
• Infrastructure-as-configuration: .ddev/config.yaml is the single source of truth for runtime versions and hooks.
• Idempotent bootstrap: “install on first start if not already setup” (show a decision diamond: “TYPO3 already set up?”).
• Separation of concerns: web runtime vs database container; installer script separate from config.
• Source-as-symlink pattern (TYPO3 legacy style): application entry points under docroot link to a shared TYPO3 source directory.
Relevant technologies (label them explicitly)
• DDEV Local
• Docker
• DB: MariaDB/MySQL
• TYPO3 CMS (legacy “without composer”)
• External: get.typo3.org
• Host OS symlinks note (especially Windows)