How to Automise Your TYPO3 Deployment (with PHP Deployer)

// Just run to deploy your TYPO3 website to the server 
dep deploy

curl -LO https://deployer.org/deployer.phar
mv deployer.phar /usr/local/bin/dep
chmod +x /usr/local/bin/dep

// To install Deployer source version with Composer, run the command:
composer require deployer/deployer --dev

// You can also install it globally:
composer global require deployer/deployer

composer require deployer/dist --dev

// Let’s have quick test-drive
dep --version

// .hosts.yaml

// Configure your TYPO3 staging site
staging.typo3site.com:
  host: staging.typo3site.com
  stage: staging
  branch: staging
  user: username
  identityFile: ~
  deploy_path: /var/www/yourpath

// Configure your TYPO3 production site
typo3site.com:
  host: typo3site.com
  stage: production
  branch: master
  user: username
  identityFile: ~
  deploy_path: /var/www/yourpath

<?php

namespace Deployer;

# Call default recipe
require 'recipe/common.php';

# Project name
set('application', 'your-typo3-site');

# Define Git-Repository
set('repository', 'git@gitlab.com:yourcompany/yourtypo3project.git');

# [Optional] Allocate tty for git clone. The default value is false.
set('git_tty', true);

# Set maximum releases backup
set('keep_releases', 5);

# To solve this issue: Can't detect http user name. Please set up the `http_user` config parameter.
# set('http_user', 'www-data');
# set('writable_mode', 'chmod');
# set('use_relative_symlink', '0');

# Set Server
inventory('.hosts.yaml');

# DocumentRoot / WebRoot for the TYPO3 installation
set('typo3_webroot', 'public');

# Shared directories
set('shared_dirs', [
   '{{typo3_webroot}}/fileadmin',
   '{{typo3_webroot}}/typo3temp',
   '{{typo3_webroot}}/uploads',
]);

# Shared files
set('shared_files', [
   '{{typo3_webroot}}/.htaccess'
]);

# Writeable directories
set('writable_dirs', [
   'config',
   'var',
   '{{typo3_webroot}}/fileadmin',
   '{{typo3_webroot}}/typo3temp',
   '{{typo3_webroot}}/typo3conf',
   '{{typo3_webroot}}/uploads'
]);

# Main TYPO3 task
task('deploy', [
   'deploy:info',
   'deploy:prepare',
   'deploy:lock',
   'deploy:release',
   'deploy:update_code',
   'deploy:shared',
   'deploy:vendors',
   'deploy:writable',
   'deploy:symlink',
   'deploy:unlock',
   'cleanup',
])->desc('Deploy your project');
after('deploy', 'success');

# [Optional] If the deployment fails automatically unlock.
after('deploy:failed', 'deploy:unlock');

// Run this command as test-drive deployment to your TYPO3 staging site
dep deploy staging

ssh-keygen

ssh-copy-id -i ~/.ssh/id_rsa.pub username@yoursite.com

// Install TYPO3 deployer toolkit
composer req --dev oliver-hader/typo3-deployer

// Configure deploy.php & .host.yml

// Deploy your TYPO3 project
vendor/bin/dep deploy production

// Install EXT:deployer_information
composer req spooner/deployer-information

// How to configure your deployment
// You don't need to do anything. The extension looks for the default folder and files of a release.

// Installation deployer-extended-typo3
composer require sourcebroker/deployer-extended-typo3

// Put below code at beginning of your deploy.php
require_once(__DIR__ . '/vendor/sourcebroker/deployer-loader/autoload.php');
new \SourceBroker\DeployerExtendedTypo3\Loader();
// Run deploy
dep deploy beta

<?php

namespace Deployer;

require_once(__DIR__ . '/vendor/sourcebroker/deployer-loader/autoload.php');
new \SourceBroker\DeployerExtendedTypo3\Loader();

set('repository', 'git@github.com:sourcebrokergit/t3base10.git');
set('bin/php', '/home/www/t3base10-public/.bin/php');
set('web_path', 'public/');

host('live')
    ->hostname('vm-dev.example.com')
    ->user('deploy')
    ->set('branch', 'master')
    ->set('public_urls', ['https://live-t3base10.example.com'])
    ->set('deploy_path', '/home/www/t3base10-public/live');

host('beta')
    ->hostname('vm-dev.example.com')
    ->user('deploy')
    ->set('branch', 'master')
    ->set('public_urls', ['https://beta-t3base10.example.com'])
    ->set('deploy_path', '/home/www/t3base10-public/beta');

host('local')
    ->hostname('local')
    ->set('deploy_path', getcwd())
    ->set('vhost_nocurrent', true)
    ->set('public_urls', ['https://t3base10.local.site']);

// provides default installation view with the least information 
dep deploy -v

// provides some more details as compared with the default mode 
dep deploy -vv

// provides a detailed view of the installation output
dep deploy -vvv

// To deploy to the TYPO3 staging server

dep deploy stage

// To deploy to the TYPO3 production server

dep deploy production

// Rollback your last run TYPO3 deploy
dep rollback

// Keep maxim five release and other will old-releases keep deleted
set('keep_releases', 5);

// To clean-up all old releases
dep cleanup

// Install all Deployer Recipes

composer require deployer/recipes --dev

// Include particular recipes in your Deploy.php

require 'recipe/typo3.php';

// To update the minor version of the Deployer run,
dep self-update

// To update the Deployer to major release version run,
dep self-update --upgrade