https://github.com/sourcebroker/deployer-typo3-media
TYPO3 CMS config for sourcebroker/deployer-extended-media.
https://github.com/sourcebroker/deployer-typo3-media
deployer deployment typo3
Last synced: 4 months ago
JSON representation
TYPO3 CMS config for sourcebroker/deployer-extended-media.
- Host: GitHub
- URL: https://github.com/sourcebroker/deployer-typo3-media
- Owner: sourcebroker
- License: mit
- Created: 2025-02-23T21:09:25.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-07-05T16:22:24.000Z (12 months ago)
- Last Synced: 2025-11-27T16:32:20.317Z (7 months ago)
- Topics: deployer, deployment, typo3
- Language: PHP
- Homepage:
- Size: 21.5 KB
- Stars: 0
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.rst
- License: LICENSE.txt
Awesome Lists containing this project
README
deployer-typo3-media
====================
[](https://packagist.org/packages/sourcebroker/deployer-typo3-media)
[](https://packagist.org/packages/sourcebroker/deployer-typo3-media)
## What does it do?
This package allows to sync media between instances using host data stored in [deployer](https://deployer.org) configuration.
It allows to copy files to your local instance, copy files between instances, but also symlink files instead of copy to save disk space (if the staging instance is at the same server as production).
This package only extends [sourcebroker/deployer-extended-media](https://github.com/sourcebroker/deployer-extended-media) with settings specific for TYPO3 CMS.
## Installation
1. Install package with composer:
```
composer require sourcebroker/deployer-typo3-media
```
2. Put the following lines at the beginning of your `deploy.php`:
```php
require_once(__DIR__ . '/vendor/autoload.php');
new \SourceBroker\DeployerLoader\Loader([
['get' => 'sourcebroker/deployer-typo3-media'],
]);
```
3. Create a `.env` file (or `.env.local`) in your project root. The `.env` (or `.env.local`) file should be out of git
because you need to store there information about instance name in var `INSTANCE`. The `INSTANCE` value must correspond to
`host()` name.
For the following real, example configuration:
```php
'sourcebroker/deployer-typo3-media'],
]);
host('production')
->setHostname('vm-dev.example.com')
->setRemoteUser('deploy')
->set('bin/php', '/usr/bin/php8.4')
->set('deploy_path', '~/t3base13/production');
host('staging')
->setHostname('vm-dev.example.com')
->setRemoteUser('deploy')
->set('bin/php', '/usr/bin/php8.4')
->set('deploy_path', '~/t3base13/staging');
```
you would need to create file `.env` (or `.env.local`) with the following content:
- `INSTANCE=production` at host defined by `host('production')`
- `INSTANCE=staging` at host defined by `host('staging')`
- `INSTANCE=local` at your local environment (laptop)
As an alternative you can also not create any env file but make sure that the env variable INSTANCE exists in the system at hosts defined in deployer (and also at your local host).
## TYPO3 sync media
TYPO3 sync folder is `fileadmin` with exclusion of `_processed_` folder.
```php
set('media', function () {
return [
'filter' => [
'+ /' . get('web_path'),
'+ /' . get('web_path') . 'fileadmin/',
'- /' . get('web_path') . 'fileadmin/_processed_/*',
'+ /' . get('web_path') . 'fileadmin/**',
'- *'
]
];
});
```
## Synchronizing media
The commands for synchronizing media for the example configuration above would be:
- For syncing media from production to local instance (usually your laptop):
```
dep media:pull production
```
- For syncing media from production to staging instance:
```
dep media:copy production --options=target:staging
```
- For syncing media from production to staging, creating symlinks to each file in the shared folder
if both instances are at the same server (saves disk space):
```
dep media:link production --options=target:staging
```
- For syncing media from local to staging (use with care - generally not recommended):
```
dep media:push staging
```
- For syncing media from local to production (use with care! - generally strongly not recommended):
```
dep media:push production
```
For more options and ways to extend the sync process, visit [sourcebroker/deployer-extended-media](https://github.com/sourcebroker/deployer-extended-media).
## Changelog
See [CHANGELOG.rst](https://github.com/sourcebroker/deployer-typo3-media/blob/master/CHANGELOG.rst)