TYPO3 Docker Boilerplate

Introduction

Our TYPO3 Docker Boilerplate is a fork from our PHP Docker Boilerplate, which is pre-configured to allow a simple Setup for any TYPO3 related Project. This Boilerplate will enable you to kickstart a TYPO3 Project within minutes and additionaly provides optional Services commonly used in the TYPO3 world, such as Solr and more.

Docker images for Debian, Ubuntu, Centos and Alpine are available for PHP 5.3 to PHP 7.0 with Xdebug and Blackfire als PHP debugger.
The Boierlplate also provides MySQL from 5.5 to 5.7 and Solr for TYPO3.

All details and a full list of features can be found inside the TYPO3 Docker Boilerplate project on Github.

Requirements

If you are using out Vagrant Development VM, you will have Docker and all requirements already preinstalled.

To run our TYPO3 Docker Boilerplate, you will need to meet the following requirements:

Operating System

To be able to run Docker, you will require a Linux Operating System with a Kernel Version of 3.10 or higher.

However the Docker Website states, you can run Docker with Windows and MAC OS with Docker Machine, which basicly is a virtualized Linux environment.

Docker

As this Boilerplate makes use of Docker, you will have to Install it first.

A full list of Installation Guides, can be found in the Docker Documentation here.

Make

Make is a common Build-Management tool, which is used by our TYPO3 Docker Boilerplate.

It should come preinstalled with the most Linux distributions, however if its not, you will have to install it.

You can check, if you have make installed by simply entering t he following command:

Docker Compose

Our TYPO3 Docker Boilerplate consists of multiple Docker containers, which work together with Docker Compose.

This is a seperate product from Docker,  but you can find the Docker Compose Installation Instructions here.

GIT

It is recommendet that you install git, to be able to clone and update the Boilerplates.

Quick Start

Assuming you meet the Requirements, you can dive right into the Boilerplate by this Quick Start guide:

Vagrant Development VM

Connect to your Vagrant VM and navigate to the projects directory:

Clone our TYPO3 Docker Boilerplate from GitHub and navigate to your Project:

Enabling the development version of the configuration file:

You may want to edit docker-compose.yml now, if you want to enable features like Solr. To archive this, simply uncommend the service in the top list of services and the corresponding configuration bellow. Further Informations can be found in our Documentation.
You also may change the target ports in the docker-compose.yml. But you should be aware to avoid port conflicts on your host system. A conflict will result in the container throwing an error and shutting down.

Navigate to the typo3demo/etc directory and adjust environment.yml according to your Project needs:

Now we can add our TYPO3 files:

For this Guide we will use a TYPO3 installation method, close to the one recommendet by the TYPO3 association. However you can use any structure you want, as long as you tell the correct document root and index.php in the environment.yml.

Now we can navigate back to the Project directory (where the docker-compose.yml is present) and start our Docker Boilerplate:

You should now see a lot of output, because the Boilerplate is downloading images and provisioning your Project. Downloading the Images will only happen, if the required Docker Image is not present on your system. When the containers are fully loaded, you should see some messages like this:

The Vagrant Development VM uses a reverse Proxy to automaticly mapp the Project for you. Every Docker VM will be mapped to a arbitary .vm domain. You can edit the hosts file on your Host Operating system and add something like this:

General

Open up your Linux Terminal and navigate to your desired Project location like this:

Clone our TYPO3 Docker Boilerplate from GitHub and navigate to your Project:

Enabling the development version of the configuration file:

You may want to edit docker-compose.yml now, if you want to enable features like Solr. To archive this, simply uncommend the service in the top list of services and the corresponding configuration bellow. Further Informations can be found in our Documentation.
You also may change the target ports in the docker-compose.yml. But you should be aware to avoid port conflicts on your host system. A conflict will result in the container throwing an error and shutting down.

Navigate to the typo3demo/etc directory and adjust environment.yml according to your Project needs:

Now we can add our TYPO3 files:

For this Guide we will use a TYPO3 installation method, close to the one recommendet by the TYPO3 association. However you can use any structure you want, as long as you tell the correct document root and index.php in the environment.yml.

Now we can navigate back to the Project directory (where the docker-compose.yml is present) and start our Docker Boilerplate:

You should now see a lot of output, because the Boilerplate is downloading images and provisioning your Project. Downloading the Images will only happen, if the required Docker Image is not present on your system. When the containers are fully loaded, you should see some messages like this:

Because the default Port for an give TYPO3 Docker Boilerplate should be 8000, you should be able to access your Installation with the following URL: 127.0.0.1:8000