sourcebroker/deployer-typo3-database

Database sync for TYPO3 with deployer-extended-database.

0.0.4 2025-03-03 19:35 UTC

Requires

• ext-json: *
• deployer/deployer: ~7.0 || dev-master
• helhum/dotenv-connector: ^3 || dev-master
• sourcebroker/deployer-extended-database: ^18 || dev-master

MIT

• Krystian Szymukowicz

• typo3
• deployer

README

• Notice (!!!)
• What does it do?
• Installation
• Synchronizing database
• Example of working configuration
• Changelog

Notice (!!!)

This is experimental package for now. Do not use it yet.

What does it do?

This package provides settings to use package sourcebroker/deployer-extended-database with TYPO3 CMS. It allows to sync database between instances.

Installation

1. Install package with composer:

   composer require sourcebroker/deployer-typo3-database
   

2. Put following lines on the beginning of your deploy.php:

   require_once(__DIR__ . '/vendor/autoload.php');
   new \SourceBroker\DeployerLoader\Loader([
     ['get' => 'sourcebroker/deployer-typo3-database'],
   ]);
   

3. On each instance create .env file which should be out of git and have at least INSTANCE with the same name as defined for host() in deploy.php file. You can use this file also to store database credentials and all other settings that are different per instance. Example for .env file:

   TYPO3_CONTEXT='Production'
   INSTANCE='production'
   
   TYPO3__DB__Connections__Default__dbname='t3base13_production'
   TYPO3__DB__Connections__Default__host='127.0.0.1'
   TYPO3__DB__Connections__Default__password='password'
   TYPO3__DB__Connections__Default__port='3306'
   TYPO3__DB__Connections__Default__user='t3base13_production'
   

   If you want that Deployer get database data from TYPO3 directly instead of reading from .env file then set:

   set('driver_typo3cms', true);
   

Synchronizing database

The command for synchronizing database from production database to local instance is:

dep db:pull production

The command for synchronizing database from production to staging is:

dep db:copy production --options=target:staging

Example of working configuration

This is example of working configuration for TYPO3 13.

<?php

namespace Deployer;

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

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

host('production')
    ->setHostname('vm-dev.example.com')
    ->setRemoteUser('deploy')
    ->set('bin/php', '/home/www/t3base13-public/production/.bin/php');
    ->set('deploy_path', '~/t3base13/production');

host('staging')
    ->setHostname('vm-dev.example.com')
    ->setRemoteUser('deploy')
    ->set('bin/php', '/home/www/t3base13-public/staging/.bin/php');
    ->set('deploy_path', '~/t3base13/staging');

localhost('local')
    ->set('bin/php', 'php')
    ->set('deploy_path', getcwd());

Changelog

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