How to Deploy a TYPO3 Project

require 'recipe/typo3.php';

Source

Deployer is a free and open source deployment tool written in PHP. It helps you to deploy your TYPO3 application to a server. It is very easy to use and has a lot of features.

Three main features of Deployer are:

• Provisioning - provision your server for you.
• Zero downtime deployment - deploy your application without a downtime.
• Rollbacks - rollback your application to a previous version, if something goes wrong.

Additionally, Deployer has a lot of other features, like:

• Easy to use - Deployer is very easy to use. It has a simple and intuitive syntax.
• Fast - Deployer is very fast. It uses parallel connections to deploy your application.
• Secure - Deployer uses SSH to connect to your server.
• Supports all major PHP frameworks - Deployer supports all major PHP frameworks.

You can read more about Deployer in Getting Started.

The deploy task of TYPO3 consists of:

• deploy:prepare – Prepares a new release
  • deploy:info – Displays info about deployment
  • deploy:setup – Prepares host for deploy
  • deploy:lock – Locks deploy
  • deploy:release – Prepares release
  • deploy:update_code – Updates code
  • deploy:env – Configure .env file
  • deploy:shared – Creates symlinks for shared files and dirs
  • deploy:writable – Makes writable dirs
• deploy:vendors – Installs vendors
• deploy:publish – Publishes the release
  • deploy:symlink – Creates symlink to release
  • deploy:unlock – Unlocks deploy
  • deploy:cleanup – Cleanup old releases
  • deploy:success – Deploys your project

The typo3 recipe is based on the common recipe.

Configuration

typo3_webroot

Source

DocumentRoot / WebRoot for the TYPO3 installation

Default value

'Web'

shared_dirs

Source

Overrides shared_dirs from recipe/deploy/shared.php.

Shared directories

Default value

[
    '{{typo3_webroot}}/fileadmin',
    '{{typo3_webroot}}/typo3temp',
    '{{typo3_webroot}}/uploads',
]

shared_files

Source

Overrides shared_files from recipe/deploy/shared.php.

Shared files

Default value

[
    '{{typo3_webroot}}/.htaccess',
]

writable_dirs

Source

Overrides writable_dirs from recipe/deploy/writable.php.

Writeable directories

Default value

[
    '{{typo3_webroot}}/fileadmin',
    '{{typo3_webroot}}/typo3temp',
    '{{typo3_webroot}}/typo3conf',
    '{{typo3_webroot}}/uploads',
]

Tasks

deploy

Source

Deploys your project.

Main TYPO3 task

This task is group task which contains next tasks:

• deploy:prepare
• deploy:vendors
• deploy:publish