itzbund/gsb-nginx-proxy

GSB nginx-proxy. This is Part of the Goverment Site Build (GSB) 11. Der GSB 11 ist eine Maßnahme der Dienstekonsolidierung Bund (DKB) des Bundesministeriums des Innern und für Heimat (BMI) und wird im Auftrag des Informationstechnikzentrums Bund (ITZBund) durchgeführt.

v1.2.18 2025-04-08 11:10 UTC

Requires

• php: ^8.1
• 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.3.0
• itzbund/captainhook-hooks: ^1.0
• michielroos/typo3scan: ^1.7
• mockery/mockery: ^1.6
• 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/phpunit: ^10.0
• ramsey/conventional-commits: ^1.5
• 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.7 || ^0.8
• typo3/testing-framework: ^8.1

GPL-2.0-or-later

• Patrick Schriner

README

GSB 11 Extension gsb_nginx_proxy

About

An extension to help with cache clears for nginx based caching proxies; inspired by EXT:varnish and others.

This extension will send PURGE or CACHEBYPASS requests to the nginx caching proxy.

Note: this will only work, if nginx is configured as expected Example Configuration

Learn more about the GSB 11.

Limitations

As nginx doesn't have the concepts of cache tags nothing was build to be able to flush arbitary tags.

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_nginx_proxy via composer:

composer config -g gitlab-domains gitlab.opencode.de && \
composer config -g repositories.gsb-nginx-proxy vcs https://gitlab.opencode.de/bmi/government-site-builder-11/extensions/gsb_nginx_proxy

composer require itzbund/gsb-nginx-proxy

Configuration

The nginx proxy has to be configured properly in the extension settings. Watch your TYPO3 logs for errors.

If one caching proxy is used, it can be addressed directly, e.g.:

$GLOBALS['TYPO3_CONF_VARS']['EXTENSIONS']['gsb_nginx_proxy']['proxy_names'] =
    'proxycache:80';

If more than one caching proxy is used, you have to use the service-broadcaster or an equivalent system to distribute the cache flushs.

Note: The service-broadcaster is a service that accepts a request and sends it to targeteted services. Idealy the target service and port can be passed in the url.

$GLOBALS['TYPO3_CONF_VARS']['EXTENSIONS']['gsb_nginx_proxy']['proxy_names'] =
    'http://service-broadcaster:8080/broadcast/proxycache/80';

Usage

Nothing to do.

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.