itzbund / gsb-clustered-caching
GSB Clustered Caching
Requires
- typo3/cms-core: ^12.4
Requires (Dev)
- captainhook/captainhook-phar: ^5.21
- codeception/codeception: *
- codeception/module-asserts: *
- codeception/module-db: *
- doctrine/dbal: ^3.3
- ergebnis/composer-normalize: ^2.28
- friendsofphp/php-cs-fixer: ^3.14
- helmich/typo3-typoscript-lint: ^3.1
- itzbund/captainhook-hooks: ^1.0
- michielroos/typo3scan: ^1.7
- php-coveralls/php-coveralls: ^2.5
- phpmd/phpmd: ^2.13
- phpstan/extension-installer: ^1.2
- phpstan/phpstan: ^1.10
- phpstan/phpstan-phpunit: ^1.3
- phpstan/phpstan-strict-rules: ^1.5
- phpunit/php-code-coverage: ^10.0
- phpunit/phpunit: ^10.0
- ramsey/conventional-commits: ^1.5
- roave/security-advisories: dev-latest
- saschaegerer/phpstan-typo3: ^1.8
- sbuerk/typo3-cmscomposerinstallers-testingframework-bridge: ^0.1.2
- seld/jsonlint: ^1.9
- squizlabs/php_codesniffer: ^3.7
- ssch/typo3-rector: ^1.1
- symfony/yaml: ^6.1
- typo3/coding-standards: ^0.8
- typo3/testing-framework: ^8.1
This package is auto-updated.
Last update: 2024-12-10 11:11:30 UTC
README
GSB 11 Extension gsb_clustered_caching
This extension adds three features
- Clearing caches when asked for, by means of a middleware
- Asking for caches clears when caches are cleared
- A command to clear caches based on the current version
About
It is part of the Government Side Builder 11.
Installation
The best way to install this extension is to start with the GSB Sitepackage Kickstarter extension.
Quick installation without GSB Sitepackage Kickstarter
In a composer-based TYPO3 installation you can install the extension EXT:gsb_clustered_caching via composer:
composer config -g gitlab-domains git.gsb-itzbund.de && \
composer config -g repositories.gsb-clustered-caching vcs https://gitlab.opencode.de/bmi/government-site-builder-11/extensions/gsb_clustered_caching
composer require itzbund/gsb-clustered-caching
In TYPO3 installations above version 11.5 the extension will be automatically installed. You do not have to activate it manually.
Configuration
You have to configure $GLOBALS['TYPO3_CONF_VARS']['EXTENSIONS']['gsb_clustered_caching']['serviceBroadcaster']
to a proper value, e.g.
http://service-broadcaster:8080/broadcast/gsb11-frontend-headless/8080/gsb-clustered-caching/,http://service-broadcaster:8080/broadcast/gsb11-backend-headless/8080/gsb-clustered-caching/
This is a combination of this extension listening to the the /gsb-clustered-caching/
endpoint and the service-broadcaster
configuration.
Usage
This extension works without manual action. This is described here.
Command
This extension provides a command that will trigger a cache flush if a system state change has been identified. A state change can be identified by
- providing a
version
argument - the composer state
typo3 gsbclusteredcaching:flushCacheOnStateChange [version] [-g groups]
There is one argument (the version
) and an optional option (--groups
or -g
) that defines which cache groups should be flushed.
Contribute
As with TYPO3, we encourage you to join the project by submitting changes. Development of the GSB 11 happens mainly in the GSB 11 TYPO3 extension repositories.
To get started, have a look at our detailed contribution walkthrough.