README

Creates a filebased TYPO3 installation with Composers.

Usage

Project Creation

Create a new TYPO3 Project using Composer

$ composer create-project dmk/typo3-composer-webroot my-project-webroot 12.4.x-dev

This creates the required Folders for TYPO3, for example the fileadmin, typo3conf, etc.

The installation process should look like this:

Created project in my-project-webroot
Loading composer repositories with package information
Installing dependencies
  - Installing typo3/cms-composer-installers

  - Installing typo3/cms-core (v12.4.0)

Writing lock file
Generating autoload files
Generating class alias map files

Then you'll be asked if you want to remove the GIT history. This we should do!

Do you want to remove the existing VCS (.git, .svn..) history? [Y,n]? Y

Now let's enter the project directory

$ cd my-project-webroot

Then we should initialize a new repo

$ git init

After the customization is done (see below), we do the initial commit

$ git add --all
$ git commit -m "initial commit"

add the new project remote

$ git remote add origin [PATH_TO_PROJECT_REPOSITORY]

and push the project to the repo

$ git push --set-upstream origin main

Specific DocRoot

In a lot of cases it will be usefull to define a DocRoot for the projekt. So the public files will be stored there and all others, like vendor, are outside.

This feature is new in the CmsComposerInstaller since 1.2.2. and enabled by default.

Add Extensions

To install an extension from the TER, for example static_info_tables, you can simply perform the following command:

composer require sjbr/static-info-tables:^6.9

Pay attention to replace underscores "_" by a dash "-" in the extension key if you are using typo3-ter repository.

To append an extension from your own repository, you have to add the repository to the composer.json first. To add the powerful MKSEARCH extension, you have to perform the following command:

$ composer config repositories.mksearch vcs https://github.com/DMKEBUSINESSGMBH/typo3-mksearch.git

Be sure, that there is a composer.json in the repository like this one:

{
    "name" : "dmk/mksearch",
    "type" : "typo3-cms-extension",
    "keywords" : ["TYPO3 CMS", "search", "Lucene", "Zend Lucene", "Apache Solr", "Solr", "Elasticsearch"],
    "homepage" : "http://www.dmk-ebusiness.de/",
    "license" : "GPL-2.0+",
    "replace": {
        "typo3-ter/mksearch": "*"
    }
}

Now you can install the Extension with the require command:

composer require dmk/mksearch

Finally install the extension with the TYPO3 Extension Manager in the TYPO3 Backend, add the composer.json, composer.lock, config/system/settings.php. to the git and commit and push the changes.

Customization

Replace the warning_email_addr example@example.com in the BE Section in the settings.php.
- don't forget to create the adress
- best practise is to have a mailing list, where everyone, who is involved in the project, is added
Replace fromEmail noreply@domain.de in the extension configuration for rn_base.
Replace $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromAddress'] noreply@tld.de in the settings.php.
Replace $GLOBALS['TYPO3_CONF_VARS']['SYS']['devIPmask'] = 'XXX.XXX.XXX.XXX' in the settings.php.
Replace XXX.XXX.XXX.XXX in the .htaccess* files with the IP that can access the System in maintenance mode.
Use .htaccess_* as .htaccess file for your environments. If needed add authentication
Create config/system/credentials.php with all the security critical data like database credentials.
A example is given in Credentials.php.inst in the repo root.
Create an encryption key and insert the key in the Credentials.php (don't store security critical data in git).
Optionaly enable some improvements in the extension configuration of MKTOOLS.
install gridelements or a similar extension
install static_info_tables if needed. The current version 6.4.3 is buggy as the static import fails as soon as a extension is installed, that enhances the static_countries database table (@see https://forge.typo3.org/issues/82132) like mklib does. As a workaround uninstall mklib temporarily for inserting the static data of static_info_tables.
set up scheduler tasks for mklog DevLog WatchDog (recommended: check for errors and above every 5 minutes, check for notices and above two times a day)
set up scheduler tasks for maintenance like mklib tasks for detecting failed and frozen tasks, anonymize IPs in the database, garbage collection for tables and caching framework, deleting old files in typo3temp/rn_base/ and typo3temp/mktools/locks.
set up monitoring with caretaker_instance extension
adjust content of fehler.html (used as ErrorDocument for 5xx errors and in case of pageUnavailable handling of TYPO3)
provide the following pages in TYPO3: 404.html (used as ErrorDocument in htaccess and as 404 page for default page not found handling) and /fehler (used in htaccess as ErrorDocuments)
When Let's Encrypt is used, switch the deny RewriteRule for the well-known folder in .htaccess
copy .htaccess_typo3 to your typo3 folder to have access restriction for the install tool (you need to configure the IPs that are whitelisted, htpasswd etc. as you like inside the htaccess file)
Do not forget to set the application context for the CLI. This includes setting it for the scheduler cron command: TYPO3_CONTEXT="Production/Staging" ! test -e $pathToHtdocs/MAINTENACE_MODE && $pathToHtdocs/typo3/sysext/core/bin/typo3 scheduler:run. Addtionally you need to set it globally like descriped here. Both is required to have the correct context in any case.
- the context in the WEB is set through the .htaccess file of the environment
- default is Production. So you normally only have to set the context on CLI in Production/Staging environment. All other environments should be fine.
when the site is hosted on a Mittwald server it might be necessary to remove $GLOBALS['TYPO3_CONF_VARS']['BE']['fileCreateMask'] and $GLOBALS['TYPO3_CONF_VARS']['BE']['folderCreateMask'] from settings.php and use the default values.
think about using Redis as caching backend
the htaccess files come with CSP (Content-Security-Policy) header. There are separate header for BE and FE. There is also a separate policy for all asset folder which are usually the root folders of the file storages. Please put this file into the neccessary folders. The policy for the FE might need to be adjusted. You might want to switch to report-only mode first and keep track of policy violations.

dmk / typo3-composer-webroot

Maintainers