devilbox/docs/examples/setup-typo3.rst

Setup TYPO3

This example will use composer to install TYPO3 from within the Devilbox PHP container.

Important

Using composer requires the underlying file system to support symlinks. If you use Docker Toolbox you need to explicitly allow/enable this. See below for instructions:

• Docker Toolbox and howto_docker_toolbox_and_the_devilbox_windows_symlinks

After completing the below listed steps, you will have a working TYPO3 setup ready to be served via http and https.

Table of Contents

local

Overview

The following configuration will be used:

Project name	VirtualHost directory	Database	TLD_SUFFIX	Project URL
my-typo	/shared/httpd/my-typo	my_typo	loc	http://my-typo.loc https://my-typo.loc

Note

* Inside the Devilbox PHP container, projects are always in /shared/httpd/. * On your host operating system, projects are by default in ./data/www/ inside the Devilbox git directory. This path can be changed via env_httpd_datadir.

Walk through

It will be ready in eight simple steps:

1. Enter the PHP container
2. Create a new VirtualHost directory
3. Install TYPO3 via composer
4. Symlink webroot directory
5. Setup DNS record
6. Create FIRST_INSTALL file
7. Open your browser
8. Step through guided web installation

1. Enter the PHP container

All work will be done inside the PHP container as it provides you with all required command line tools.

Navigate to the Devilbox git directory and execute shell.sh (or shell.bat on Windows) to enter the running PHP container.

host> ./shell.sh

* enter_the_php_container * work_inside_the_php_container * available_tools

2. Create new vhost directory

The vhost directory defines the name under which your project will be available. ( <vhost dir>.TLD_SUFFIX will be the final URL ).

devilbox@php-7.0.20 in /shared/httpd $ mkdir my-typo

env_tld_suffix

3. Install TYPO3

Navigate into your newly created vhost directory and install TYPO3 with composer.

devilbox@php-7.0.20 in /shared/httpd $ cd my-typo
devilbox@php-7.0.20 in /shared/httpd/my-typo $ composer create-project typo3/cms-base-distribution typo3

How does the directory structure look after installation:

devilbox@php-7.0.20 in /shared/httpd/my-typo $ tree -L 1
.
└── typo3

1 directory, 0 files

4. Symlink webroot

Symlinking the actual webroot directory to htdocs is important. The web server expects every project's document root to be in <vhost dir>/htdocs/. This is the path where it will serve the files. This is also the path where your frameworks entrypoint (usually index.php) should be found.

Some frameworks however provide its actual content in nested directories of unknown levels. This would be impossible to figure out by the web server, so you manually have to symlink it back to its expected path.

devilbox@php-7.0.20 in /shared/httpd/my-typo $ ln -s typo3/public htdocs

How does the directory structure look after symlinking:

devilbox@php-7.0.20 in /shared/httpd/my-typo $ tree -L 1
.
├── typo3
└── htdocs -> typo3/public

2 directories, 0 files

As you can see from the above directory structure, htdocs is available in its expected path and points to the frameworks entrypoint.

Important

When using Docker Toolbox, you need to explicitly allow the usage of symlinks. See below for instructions:

• Docker Toolbox and howto_docker_toolbox_and_the_devilbox_windows_symlinks

5. DNS record

If you have Auto DNS configured already, you can skip this section, because DNS entries will be available automatically by the bundled DNS server.

If you don't have Auto DNS configured, you will need to add the following line to your host operating systems /etc/hosts file (or C:\Windows\System32\drivers\etc on Windows):

127.0.0.1 my-typo.loc

• howto_add_project_hosts_entry_on_mac
• howto_add_project_hosts_entry_on_win
• setup_auto_dns

6. Create FIRST_INSTALL file

To continue installing via the guided web install, you need to create a file called FIRST_INSTALL in the document root.

devilbox@php-7.0.20 in /shared/httpd/my-typo $ touch htdocs/FIRST_INSTALL

7. Open your browser

Open your browser at http://my-typo.loc or https://my-typo.loc.

8. Step through guided web installation

1. Select database
   • Connection: Manually configured MySWQL TCP/IP connection
   • Username: root
   • Password
   • Host: mysql
   • Port: 3306
2. Select database
   • Create a new database: typo3
3. Create Administrative User / Specify Site Name
   • Username: admin
   • Password: choose a secure password
   • Site name: My Typo
4. Installation complete
   • Create empty starting page

Next steps