One-command bash script that spins up disposable TYPO3 instances on DDEV. Pick a version (or let it grab the latest), and it configures DDEV, installs TYPO3 via Composer, sets up the database and an admin user, drops the credentials into a local file, and opens the backend in your browser.
Built because roughly half of all TYPO3 sites out there are still running on old major versions — this makes it trivial to spin up several versions side by side and see what actually changed.
Got an idea for a feature, or found a bug? Open an issue - feature requests are welcome, not just bug reports.
Support the development and keep the updates coming. Even 1€ helps :)
Tip
New in 0.5.0: you can install typo3quickstarter system-wide now and run it from any directory — the instance is created wherever you happen to be. Keep it current with typo3quickstarter update. See Installation.
The script checks for both and bails out early with a clear error if either is missing or Docker isn't running.
curl -fsSL https://raw.githubusercontent.com/pagea-dev/typo3quickstarter/main/install.sh | bashThat installs typo3quickstarter — plus t3quickstarter as a short alias — into ~/.local/bin. From then on you create instances wherever you happen to be:
cd ~/projects/project-x
typo3quickstarter --release=13Updating is the same command again; removing it is typo3quickstarter-uninstall. See docs/installation.md for the install location and everything around it.
Other ways to install — from a checkout, or the single file with no install at all
From a checkout, which also gets you docs/, CHANGELOG.md and everything else:
git clone https://github.com/pagea-dev/typo3quickstarter.git
cd typo3quickstarter
./install.shWithout installing anything, as a single file you run from where it lies — no other dependencies beyond bash, docker and ddev:
curl -LO https://github.com/pagea-dev/typo3quickstarter/releases/latest/download/typo3-ddev-setup.sh && chmod +x typo3-ddev-setup.sh
./typo3-ddev-setup.sh --release=13Every flag works the same either way. Run this way, the script prints ./typo3-ddev-setup.sh back at you instead of typo3quickstarter wherever it suggests a follow-up command.
typo3quickstarter --release=13No --release? It defaults to the newest supported major version:
typo3quickstarterThat's it. The script will:
- Create a project folder named e.g.
typo3-v13-101(or use--nameif you gave one) - Run
ddev configwith the right PHP version for that TYPO3 release - Install TYPO3 with Composer inside the container, pinned to the release you asked for
- Run the non-interactive TYPO3 setup (database, admin user, default site)
- Write the login details to
typo3-credentials.txtin the project folder - Open
/typo3(the backend) in your browser viaddev launch
At the end you'll see something like:
==> Done.
URL: https://typo3-v13-101.ddev.site
Backend: https://typo3-v13-101.ddev.site/typo3
Admin: admin
Password: q7-Xf#2vRt%Ls9BkPz4m
Credentials: /home/you/projects/typo3-v13-101/typo3-credentials.txt
For ports, database and Mailpit details: 'ddev describe' inside /home/you/projects/typo3-v13-101
To clean up this instance: typo3quickstarter --c 101
The very first time DDEV adds a new
*.ddev.sitehostname to your system, it needssudoto update/etc/hosts— you'll get a normal password prompt for that. It only happens once per hostname.
| Command | Description |
|---|---|
typo3quickstarter update |
Check GitHub for a newer release and install it after asking |
typo3quickstarter uninstall |
Remove the installed command, its alias and the uninstaller |
Both only apply to a copy installed with install.sh — see docs/installation.md. Every normal run also checks for a newer release and prints a one-line notice under the banner if there is one; it never asks or installs anything, and TYPO3QUICKSTARTER_NO_UPDATE_CHECK=1 turns it off.
| Flag | Description | Default |
|---|---|---|
-r=N, --release=N |
TYPO3 version to install — see docs/versions.md | highest supported |
--php-version=X.Y |
PHP version for the web container — see docs/versions.md | per release line |
--database=TYPE:VER |
Database server, mariadb:<version> or mysql:<version> — see docs/versions.md |
DDEV's default |
--name=NAME |
DDEV project name | auto-generated, e.g. typo3-v13-101 |
--path=DIR |
Where the project folder is created (also used by --cleanup) |
current directory |
--admin-user, --admin-password, --admin-email |
Admin backend user — see docs/backend-users.md | admin / random / admin@<project>.ddev.site |
--require=PKG |
Install extra Composer packages after setup — see docs/composer-packages.md | — |
--require-dev=PKG |
Install extra Composer packages after setup as development dependencies — see docs/composer-packages.md | — |
--extension=PATH |
Mount and require a local extension for development — see docs/composer-packages.md | — |
--env=KEY=VALUE |
Set environment variables in the web container — see docs/environment-variables.md | — |
--xdebug |
Enable Xdebug for PHP step debugging from the first start — see docs/xdebug.md | off |
--no-pma |
Skip phpMyAdmin, which is installed by default — see docs/phpmyadmin.md | off |
--list |
List all instances this script created — see docs/instances.md | — |
--cleanup, --clear, --c [TARGET...] |
Interactively remove previously created instances, optionally narrowed down to name/ID matches — see docs/instances.md | — |
-v, --verbose |
Also write the full console output to verbose.log — see docs/verbose-logging.md |
— |
--with-git |
After setup, ask whether to git init the whole project or scaffold and version a new extension — see docs/with-git.md |
— |
--create-extension |
After setup, run the extension kickstarter and install the new extension from packages/ — see docs/create-extension.md |
— |
-h, --help |
Show usage | — |
--version |
Show the script's own version — see docs/information.md | — |
The examples below use the installed command. Every one of them works just as well with ./typo3-ddev-setup.sh if you'd rather keep the single file around as a portable copy — on a USB stick, in a project folder, or on a machine you don't want to install anything on. Nothing is stored outside the instance folder either way.
Latest TYPO3 14 with a couple of extensions and a personal admin login, in one command:
typo3quickstarter --release=14 --require=b13/container georgringer/news --admin-user=lukas --admin-password='Correct-Horse-1' --admin-email=lukas@example.comAn exact TYPO3 12 patch release, plus a specific version of an extension (--require takes any Composer constraint, same as composer require vendor/package:constraint):
typo3quickstarter --release=12.4.20 --require=georgringer/news:^11.0Kickstart a brand-new extension against the newest TYPO3, then put just that extension under git once it's created:
typo3quickstarter --with-gitPick option 2 when asked, follow the kickstarter's prompts, and you'll have a working TYPO3 instance plus a freshly versioned extension - see docs/with-git.md.
- One command, zero clicking through the install wizard. No more re-typing DB credentials or admin passwords by hand.
- Test against multiple TYPO3 versions in parallel. Each instance gets its own name, its own DDEV project, its own URL.
- Disposable by design. Spin one up, break it, tear it down.
--cleanupgets rid of the mess for you. - Kickstart a brand-new extension and have it under git from the first commit.
--with-gitruns the official TYPO3 extension kickstarter, then initializes a repository right where it just created your extension - a working TYPO3 instance, a scaffolded extension, and its own git history, from a single command. See docs/with-git.md.
- docs/installation.md — the single-file install and the system-wide
typo3quickstarter/t3quickstartercommand viainstall.sh/uninstall.sh - docs/examples.md — practical recipes for common scenarios: pinning a patch release, custom admin logins, extensions, cleanup, and more
- docs/versions.md — selecting a version, pinning an exact patch release, the
--no-security-blockingsecurity note, what to expect from the EOL lines 9, 10 and 11 - docs/backend-users.md — the admin backend user
- docs/composer-packages.md — extra Composer packages via
--require,--require-devand local extension development via--extension - docs/xdebug.md —
--xdebug: PHP step debugging, toggling Xdebug afterwards, PhpStorm/VS Code setup - docs/phpmyadmin.md — the phpMyAdmin every instance gets, and
--no-pmato leave it out - docs/environment-variables.md —
--env: custom environment variables in the web container - docs/development-settings.md — the always-on extras every instance gets: Scheduler/Extensions core extensions,
TYPO3_CONTEXT=Development, debug settings - docs/with-git.md —
--with-git: version the whole project or scaffold and version a new extension - docs/create-extension.md —
--create-extension: scaffold a new extension with the kickstarter, without git - docs/instances.md — listing (
--list) and removing (--cleanup) instances - docs/verbose-logging.md —
--verbose/verbose.log - docs/information.md — the script's own
--versionand the release process - docs/CONTRIBUTING.md — guidelines for PRs
- CHANGELOG.md — what changed in each version
Sending a PR? Please read docs/CONTRIBUTING.md first - in short: branch from the current version branch, not main (PRs against main are ignored), test the script for real before opening the PR, and keep the executable bit intact.
Actively tested on Ubuntu-based Linux (e.g. Zorin OS) and Windows via WSL. Should work anywhere bash, docker, and ddev do, but hasn't been verified elsewhere.
macOS isn't tested or supported yet - happy to take a PR from someone who wants to develop and test it there (see docs/CONTRIBUTING.md).
typo3-credentials.txtis written outside thepublic/docroot, so it's never reachable over HTTP, and it getschmod 600plus an entry in.gitignoreautomatically.verbose.log(with--verbose) gets the same treatment.
This project stands entirely on the shoulders of others' work:
- DDEV — the local dev environment this whole script is built around.
- Docker — the container runtime underneath DDEV.
- TYPO3 — the CMS this exists to spin up.
- TYPO3 Extension Kickstarter — the interactive extension scaffolding used by
--with-git(see docs/with-git.md).
Thanks to everyone building and maintaining these projects.
MIT — see LICENSE.
