Skip to content

Commit 7d1fb5c

Browse files
[FEATURE] Set up TYPO3 with DDEV
1 parent c95eb98 commit 7d1fb5c

File tree

1 file changed

+124
-0
lines changed

1 file changed

+124
-0
lines changed
Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
# Set Up TYPO3 with DDEV
2+
3+
<!-- #TYPO3v13 #Beginner #Installation @philippefekete -->
4+
5+
DDEV enables you to quickly spin up a complete TYPO3 development environment without complex manual setup, providing a ready-to-use, containerized setup that mirrors a real server. Setting up TYPO3 with DDEV helps you start projects faster, ensure consistency across different machines, and streamline your development workflow by automating the configuration of PHP, the web server, and the database — all with just a few simple commands.
6+
7+
## Learning objective
8+
9+
In this step-by-step guide, you will learn to install and configure DDEV, create and run a TYPO3 project locally with Composer, and manage your development environment using essential DDEV commands.
10+
11+
## Prerequisites
12+
13+
### Tools and technology
14+
15+
* A computer with a command-line interface
16+
* Docker installed on your machine as [explained in the Docker documentation](https://docs.docker.com/get-started/get-docker/).
17+
* DDEV installed on your machine as [explained in the DDEV documentation](https://ddev.readthedocs.io/en/stable/users/install/ddev-installation/).
18+
19+
### Knowledge and skills
20+
21+
* How to use a command-line interface
22+
23+
## Watch the video
24+
25+
[Watch this video](https://www.youtube.com/watch?v=HW7J3G1SqZw) to follow along with the steps below.
26+
27+
## Create the installation directory
28+
29+
Create an empty directory for your TYPO3 project and change into it:
30+
31+
```
32+
mkdir my_project
33+
cd my_project
34+
```
35+
36+
> [!Note]
37+
> The directory where you run the following commands must be empty.
38+
>
39+
> Do not initialize Git or open the folder in an IDE before running the commands, as these may create files in the directory (for example hidden files).
40+
41+
42+
## Create a New DDEV Project
43+
44+
1. Initialize a new DDEV project. The `ddev config` command will prompt you for details of your setup. TYPO3 is included in the list of preconfigured project types.
45+
46+
```
47+
ddev config --php-version 8.4 --docroot public --project-type typo3
48+
```
49+
50+
* **Docroot Location** — The docroot is the folder containing the files accessible to the webserver, including the entry point `index.php`. It is commonly named public. Do not change the docroot during this installation process. You can change it later if necessary, however most guides assume your docroot is called `public`.
51+
* **Project Type** — Always set the project type to `typo3`.
52+
53+
54+
## Start the DDEV
55+
56+
1. Start the DDEV project:
57+
58+
`ddev start`
59+
60+
The webserver environment is now running, but TYPO3 is not yet installed.
61+
62+
## Install TYPO3
63+
64+
1. Install TYPO3 using Composer:
65+
66+
`ddev composer create "typo3/cms-base-distribution:^13"`
67+
68+
You now have a **Composer-based TYPO3 installation**.
69+
70+
## Directory structure after composer installation
71+
72+
At this point, your project folder should contain the following files and directories:
73+
74+
```
75+
config/
76+
packages/
77+
public/
78+
vendor/
79+
LICENSE
80+
.ddev
81+
.gitignore
82+
composer.json
83+
composer.lock
84+
README.md
85+
```
86+
87+
Additional folders like `var` and subfolders like `config/sites` will be created during the setup process.
88+
89+
## Set up TYPO3 using the console
90+
91+
At this point, important files and folders are still missing, and your database does not yet contain any tables.
92+
93+
All of these will be created during the setup process.
94+
95+
1. To perform an interactive guided setup, run:
96+
97+
`ddev typo3 setup --server-type=other --driver=mysqli --host=db --port=3306 --dbname=db --username=db --password=db`
98+
99+
2. When prompted, provide the following answers to match the default DDEV configuration:
100+
101+
```
102+
Admin username (user will be "system maintainer") ? j.doe
103+
Admin user and installer password ?
104+
Admin user email ? [email protected]
105+
Give your project a name [default: New TYPO3 Project] ? My Project
106+
Create a basic site? Please enter a URL [default: no] https://my-project.ddev.site
107+
✓ Congratulations - TYPO3 Setup is done.
108+
```
109+
110+
## Summary
111+
112+
Congratulations! You now have a fully functional TYPO3 project running in a local DDEV environment, complete with a Composer-based installation, configured database, and ready-to-use development setup that mirrors a real-world server.
113+
114+
## Next steps
115+
116+
Now that you have a working TYPO3 project running locally with DDEV, you might like to:
117+
118+
* [Backend Basics](https://docs.typo3.org/m/typo3/guide-step-by-step/main/en-us/10GettingStarted/20BasicConfiguration/10BackendBasics/Index.html#backend-basics)
119+
120+
## Resources
121+
122+
* [Docker: Installation Guide](https://docs.docker.com/get-started/get-docker/)
123+
* [DDEV: Get Started](https://ddev.com/get-started/)
124+
* [DDEV: Installation](https://ddev.readthedocs.io/en/stable/users/install/ddev-installation/)

0 commit comments

Comments
 (0)