diff --git a/docs/recipe/README.md b/docs/recipe/README.md index 05a922165..f2b99644a 100644 --- a/docs/recipe/README.md +++ b/docs/recipe/README.md @@ -22,7 +22,8 @@ * [Statamic Recipe](/docs/recipe/statamic.md) * [Sulu Recipe](/docs/recipe/sulu.md) * [Symfony Recipe](/docs/recipe/symfony.md) -* [TYPO3 Recipe](/docs/recipe/typo3.md) +* [TYPO3 11 Recipe](/docs/recipe/typo3-11.md) +* [TYPO3 12 Recipe](/docs/recipe/typo3-12.md) * [WordPress Recipe](/docs/recipe/wordpress.md) * [Yii2 Recipe](/docs/recipe/yii.md) * [Zend Framework Recipe](/docs/recipe/zend_framework.md) \ No newline at end of file diff --git a/docs/recipe/typo3.md b/docs/recipe/typo3-11.md similarity index 87% rename from docs/recipe/typo3.md rename to docs/recipe/typo3-11.md index ad84e4a4e..d8aa0fddb 100644 --- a/docs/recipe/typo3.md +++ b/docs/recipe/typo3-11.md @@ -1,18 +1,18 @@ - + -# How to Deploy a TYPO3 Project +# How to Deploy a TYPO3 11.5 Project ```php -require 'recipe/typo3.php'; +require 'recipe/typo3-11.php'; ``` -[Source](/recipe/typo3.php) +[Source](/recipe/typo3-11.php) -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. +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. @@ -41,24 +41,24 @@ The [deploy](#deploy) task of **TYPO3** consists of: * [deploy:symlink](/docs/recipe/deploy/symlink.md#deploysymlink) – Creates symlink to release * [deploy:unlock](/docs/recipe/deploy/lock.md#deployunlock) – Unlocks deploy * [deploy:cleanup](/docs/recipe/deploy/cleanup.md#deploycleanup) – Cleanup old releases - * [deploy:success](/docs/recipe/common.md#deploysuccess) – + * [deploy:success](/docs/recipe/common.md#deploysuccess) – The typo3 recipe is based on the [common](/docs/recipe/common.md) recipe. ## Configuration ### typo3_webroot -[Source](https://github.com/deployphp/deployer/blob/master/recipe/typo3.php#L11) +[Source](https://github.com/deployphp/deployer/blob/master/recipe/typo3-11.php#L11) DocumentRoot / WebRoot for the TYPO3 installation ```php title="Default value" -'Web' +'public' ``` ### shared_dirs -[Source](https://github.com/deployphp/deployer/blob/master/recipe/typo3.php#L26) +[Source](https://github.com/deployphp/deployer/blob/master/recipe/typo3-11.php#L26) Overrides [shared_dirs](/docs/recipe/deploy/shared.md#shared_dirs) from `recipe/deploy/shared.php`. @@ -67,14 +67,13 @@ Shared directories ```php title="Default value" [ '{{typo3_webroot}}/fileadmin', - '{{typo3_webroot}}/typo3temp', - '{{typo3_webroot}}/uploads' + '{{typo3_webroot}}/typo3temp' ] ``` ### shared_files -[Source](https://github.com/deployphp/deployer/blob/master/recipe/typo3.php#L35) +[Source](https://github.com/deployphp/deployer/blob/master/recipe/typo3-11.php#L34) Overrides [shared_files](/docs/recipe/deploy/shared.md#shared_files) from `recipe/deploy/shared.php`. @@ -88,7 +87,7 @@ Shared files ### writable_dirs -[Source](https://github.com/deployphp/deployer/blob/master/recipe/typo3.php#L42) +[Source](https://github.com/deployphp/deployer/blob/master/recipe/typo3-11.php#L41) Overrides [writable_dirs](/docs/recipe/deploy/writable.md#writable_dirs) from `recipe/deploy/writable.php`. @@ -98,8 +97,7 @@ Writeable directories [ '{{typo3_webroot}}/fileadmin', '{{typo3_webroot}}/typo3temp', - '{{typo3_webroot}}/typo3conf', - '{{typo3_webroot}}/uploads' + '{{typo3_webroot}}/typo3conf' ] ``` @@ -108,7 +106,7 @@ Writeable directories ## Tasks ### deploy -[Source](https://github.com/deployphp/deployer/blob/master/recipe/typo3.php#L17) +[Source](https://github.com/deployphp/deployer/blob/master/recipe/typo3-11.php#L17) Deploys your project. diff --git a/docs/recipe/typo3-12.md b/docs/recipe/typo3-12.md new file mode 100644 index 000000000..c86b13bc7 --- /dev/null +++ b/docs/recipe/typo3-12.md @@ -0,0 +1,121 @@ + + + + +# How to Deploy a TYPO3 12.4 Project + +```php +require 'recipe/typo3-12.php'; +``` + +[Source](/recipe/typo3-12.php) + +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](/docs/getting-started.md). + +The [deploy](#deploy) task of **TYPO3** consists of: +* [deploy:prepare](/docs/recipe/common.md#deployprepare) – Prepares a new release + * [deploy:info](/docs/recipe/deploy/info.md#deployinfo) – Displays info about deployment + * [deploy:setup](/docs/recipe/deploy/setup.md#deploysetup) – Prepares host for deploy + * [deploy:lock](/docs/recipe/deploy/lock.md#deploylock) – Locks deploy + * [deploy:release](/docs/recipe/deploy/release.md#deployrelease) – Prepares release + * [deploy:update_code](/docs/recipe/deploy/update_code.md#deployupdate_code) – Updates code + * [deploy:shared](/docs/recipe/deploy/shared.md#deployshared) – Creates symlinks for shared files and dirs + * [deploy:writable](/docs/recipe/deploy/writable.md#deploywritable) – Makes writable dirs +* [deploy:vendors](/docs/recipe/deploy/vendors.md#deployvendors) – Installs vendors +* [deploy:publish](/docs/recipe/common.md#deploypublish) – Publishes the release + * [deploy:symlink](/docs/recipe/deploy/symlink.md#deploysymlink) – Creates symlink to release + * [deploy:unlock](/docs/recipe/deploy/lock.md#deployunlock) – Unlocks deploy + * [deploy:cleanup](/docs/recipe/deploy/cleanup.md#deploycleanup) – Cleanup old releases + * [deploy:success](/docs/recipe/common.md#deploysuccess) – + + +The typo3 recipe is based on the [common](/docs/recipe/common.md) recipe. + +## Configuration +### typo3_webroot +[Source](https://github.com/deployphp/deployer/blob/master/recipe/typo3-12.php#L11) + +DocumentRoot / WebRoot for the TYPO3 installation + +```php title="Default value" +'public' +``` + + +### shared_dirs +[Source](https://github.com/deployphp/deployer/blob/master/recipe/typo3-12.php#L26) + +Overrides [shared_dirs](/docs/recipe/deploy/shared.md#shared_dirs) from `recipe/deploy/shared.php`. + +Shared directories + +```php title="Default value" +[ + '{{typo3_webroot}}/fileadmin', + '{{typo3_webroot}}/typo3temp' +] +``` + + +### shared_files +[Source](https://github.com/deployphp/deployer/blob/master/recipe/typo3-12.php#L34) + +Overrides [shared_files](/docs/recipe/deploy/shared.md#shared_files) from `recipe/deploy/shared.php`. + +Shared files + +```php title="Default value" +[ + '{{typo3_webroot}}/.htaccess' +] +``` + + +### writable_dirs +[Source](https://github.com/deployphp/deployer/blob/master/recipe/typo3-12.php#L41) + +Overrides [writable_dirs](/docs/recipe/deploy/writable.md#writable_dirs) from `recipe/deploy/writable.php`. + +Writeable directories + +```php title="Default value" +[ + '{{typo3_webroot}}/_assets', + '{{typo3_webroot}}/fileadmin', + '{{typo3_webroot}}/typo3temp' +] +``` + + + +## Tasks + +### deploy +[Source](https://github.com/deployphp/deployer/blob/master/recipe/typo3-12.php#L17) + +Deploys your project. + +Main TYPO3 task + + +This task is group task which contains next tasks: +* [deploy:prepare](/docs/recipe/common.md#deployprepare) +* [deploy:vendors](/docs/recipe/deploy/vendors.md#deployvendors) +* [deploy:publish](/docs/recipe/common.md#deploypublish) + + diff --git a/recipe/typo3.php b/recipe/typo3-11.php similarity index 75% rename from recipe/typo3.php rename to recipe/typo3-11.php index e01476e46..83619ca7c 100644 --- a/recipe/typo3.php +++ b/recipe/typo3-11.php @@ -3,12 +3,12 @@ require_once __DIR__ . '/common.php'; -add('recipes', ['typo3']); +add('recipes', ['typo3-11']); /** * DocumentRoot / WebRoot for the TYPO3 installation */ -set('typo3_webroot', 'Web'); +set('typo3_webroot', 'public'); /** * Main TYPO3 task @@ -25,8 +25,7 @@ */ set('shared_dirs', [ '{{typo3_webroot}}/fileadmin', - '{{typo3_webroot}}/typo3temp', - '{{typo3_webroot}}/uploads' + '{{typo3_webroot}}/typo3temp' ]); /** @@ -42,6 +41,5 @@ set('writable_dirs', [ '{{typo3_webroot}}/fileadmin', '{{typo3_webroot}}/typo3temp', - '{{typo3_webroot}}/typo3conf', - '{{typo3_webroot}}/uploads' + '{{typo3_webroot}}/typo3conf' ]); diff --git a/recipe/typo3-12.php b/recipe/typo3-12.php new file mode 100644 index 000000000..1d4348411 --- /dev/null +++ b/recipe/typo3-12.php @@ -0,0 +1,45 @@ +