sourcebroker/deployer-extended-typo3

Customisation for `sourcebroker/deployer-typo3-*` stack

24.0.0 2025-04-07 17:10 UTC

Requires

• sourcebroker/deployer-extended: ^24.0.0 || dev-master
• sourcebroker/deployer-typo3-database: ^1.0.0 || dev-main
• sourcebroker/deployer-typo3-deploy: ^1.0.0 || dev-main
• sourcebroker/deployer-typo3-deploy-ci: ^1.0.0 || dev-main
• sourcebroker/deployer-typo3-media: ^1.0.0 || dev-main

MIT

• Krystian Szymukowicz

• typo3
• deployer

README

• What does it do?
• Installation
• Example of working configuration
• Changelog

What does it do?

This package is customisation for stack of packages sourcebroker/deployer-typo3-*.

1. package sourcebroker/deployer-typo3-deploy - TYPO3 deploy process at local level
2. package sourcebroker/deployer-typo3-deploy-ci TYPO3 deploy process at CI level (gitlab for now only)
3. package sourcebroker/deployer-typo3-database TYPO3 preconfigured synchronisation of databases between multiple instances
4. package sourcebroker/deployer-typo3-media TYPO3 preconfigured synchronisation of media between multiple instances

You should treat this package more like example and fork it to make your own customisation.

But if you accept flow proposed by this project then of course you can make it a base for your projects.

Installation

1. Install package with composer:

   composer require sourcebroker/deployer-extended-typo3
   

2. Put following lines on the beginning of your deploy.php. You can decide what packages/functionality you want to use. For example - remove line ['get' => 'sourcebroker/deployer-typo3-database'], and there will be no task for database sync. If you choose deploy using CI then use sourcebroker/deployer-typo3-deploy-ci instead of sourcebroker/deployer-typo3-deploy. Each package is completely independent and you can use only those you need.

   <?php
   
       require_once('./vendor/autoload.php');
   
       new \SourceBroker\DeployerLoader\Load([
           ['get' => 'sourcebroker/deployer-typo3-media'],
           ['get' => 'sourcebroker/deployer-typo3-database'],
           ['get' => 'sourcebroker/deployer-typo3-deploy'],
           ['get' => 'sourcebroker/deployer-extended-typo3'],
       ]);
   

3. If you use sourcebroker/deployer-typo3-deploy then remove task deploy from your deploy.php.

4. If you want to use database synchronisation then please read documentation at sourcebroker/deployer-typo3-database

5. If you want to use media synchronisation then please read documentation at sourcebroker/deployer-typo3-media

Example of working configuration

This is example of working configuration for TYPO3 13. The aim of sourcebroker/deployer-extended-typo3 is to have very slim deploy.php file in order to have nice possibility to upgrade to future versions of sourcebroker/deployer-extended-typo3.

This is config for deploy from local cli level.

<?php

namespace Deployer;

require_once('./vendor/autoload.php');

new \SourceBroker\DeployerLoader\Load([
    ['get' => 'sourcebroker/deployer-typo3-media'],
    ['get' => 'sourcebroker/deployer-typo3-database'],
    ['get' => 'sourcebroker/deployer-typo3-deploy'],
    ['get' => 'sourcebroker/deployer-extended-typo3'],
]);

set('repository', '[e-mail]:sourcebrokergit/t3base13.git');

host('production')
  ->setHostname('vm-dev.example.com')
  ->setRemoteUser('deploy')
  ->set('branch', 'main')
  ->set('public_urls', ['https://t3base13.example.com'])
  ->set('deploy_path', '~/t3base13/production');

host('staging')
  ->setHostname('vm-dev.example.com')
  ->setRemoteUser('deploy')
  ->set('branch', 'develop')
  ->set('public_urls', ['https://staging-t3base13.example.com'])
  ->set('deploy_path', '~/t3base13/staging');

and here example for deploy from gitlab ci. Deploy is from CI level but database and media synchro still needs ssh access (!)

<?php

namespace Deployer;

require_once('./vendor/autoload.php');

new \SourceBroker\DeployerLoader\Load([
    ['get' => 'sourcebroker/deployer-typo3-media'],
    ['get' => 'sourcebroker/deployer-typo3-database'],
    ['get' => 'sourcebroker/deployer-typo3-deploy-ci'],
    ['get' => 'sourcebroker/deployer-extended-typo3'],
]);

host('production')
  ->setHostname('vm-dev.example.com')
  ->setRemoteUser('deploy')
  ->set('public_urls', ['https://t3base13.example.com'])
  ->set('deploy_path', '~/t3base13/production');

host('staging')
  ->setHostname('vm-dev.example.com')
  ->setRemoteUser('deploy')
  ->set('public_urls', ['https://staging-t3base13.example.com'])
  ->set('deploy_path', '~/t3base13/staging');

Changelog

See https://github.com/sourcebroker/deployer-extended-typo3/blob/master/CHANGELOG.rst