bnf / static-docroot
Composer plugin that ensures DOCUMENT_ROOT is static and stable during one request, intended for symlink based deployments.
Installs: 2 616
Dependents: 0
Suggesters: 0
Security: 0
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 0
Type:composer-plugin
Requires
- php: >=5.5.0
- composer-plugin-api: ^1.1
Requires (Dev)
- composer/composer: ^1.0
This package is auto-updated.
Last update: 2024-11-06 09:55:42 UTC
README
This package acts as composer plugin in order to automatically patch
$_SERVER['DOCUMENT_ROOT']
and $_SERVER['SCRIPT_FILENAME']
to their realpath
so that they do not contain symlinks.
That is to ensure that they are static and stable. That means we want their
destination to not change during one request. That would happen when they
contain symlinks which may change during one request due to a deployment.
composer require bnf/static-docroot
The behavior of this plugin can be influenced by configuration in the extra
section of the root composer.json
"extra": {
"bnf/static-docroot": {
"web-dir": "public"
}
}
web-dir
You can specify a relative path from the base directory, where the public document root should be located.
The default value is derived from extra|typo3/cms|web-dir
or if that is
unset, "web"
as last resort.
That means if you have already configured the typo3/cms
web-dir
,
you do not need to add the bnf/static-docroot
section.
"extra": {
"typo3/cms": {
"web-dir": "web"
}
}
Note for TYPO3 8.7: This package is not needed as of TYPO3 8.7 LTS.
https://review.typo3.org/#/c/52295/ fixed TYPO3 to base
path calculations on __DIR__
and thus does effectively the
same as this package.
You might still need this package if you have a (bad) extension
that uses $_SERVER['DOCUMENT_ROOT']
instead of
GeneralUtility::getIndpEnv()
.