README

Install

To install via Composer, use the command below, it will automatically detect the latest version and bind it with ^.

composer require wyrihaximus/react-http-middleware-webroot-preload

Usage

The middleware accepts two parameters, first the webroot directory, and secondly an optional PSR-3 logger. It is important to note that ALL files in the webroot will be served regardless of file type. So no PHP or files containing passwords etc etc should be in there.

$webroot = '/var/www/';
$logger = new Psr3Logger(); // Require, PSR-3 logger for bootstrap logging
$cache = new ArrayCache();  // Required, custom cache configuration
$server = new Server([
    /** Other middleware */
    new WebrootPreloadMiddleware($webroot, $logger, $cache),
    /** Other middleware */
]);

Out of process caching

Internally this package uses a readonly DTO to store the preloaded files in cache. This means that if you want to store it in say Redis, you will have to serialize the DTO yourself using a decorator around the Redis cache.

License

The MIT License (MIT)

Copyright (c) 2026 Cees-Jan Kiewiet

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.