spiral-packages / maintenance
Disable your application while it is updating or when you are performing maintenance.
Requires
- php: ^8.1
- spiral/boot: ^3.0
- spiral/cache: ^3.0
- spiral/console: ^3.0
- spiral/core: ^3.0
- spiral/serializer: ^3.0
Requires (Dev)
- phpunit/phpunit: ^9.5
- spiral/testing: ^2.0
- vimeo/psalm: ^4.9
This package is auto-updated.
Last update: 2024-10-16 16:11:38 UTC
README
This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.
Requirements
Make sure that your server is configured with following PHP version and extensions:
- PHP 8.1+
- Spiral framework 3.0+
Installation
You can install the package via composer:
composer require spiral-packages/maintenance
After package install you need to register bootloader from the package.
protected const LOAD = [ // ... \Spiral\Maintenance\Bootloader\MaintenanceBootloader::class, ];
Note: if you are using
spiral-packages/discoverer
, you don't need to register bootloader by yourself.
Configuration
By default, the package uses file
driver for storing information about maintenance mode. If you have multiple
instances of your application you need to use cache
driver with storage that will be accessed from all instances.
MAINTENANCE_DRIVER=cache MAINTENANCE_CACHE_STORAGE=null MAINTENANCE_CACHE_KEY=maintenance
Usage
Include Spiral\Maintenance\Middleware\PreventRequestInMaintenanceModeMiddleware
in your application for routes that
should not have access during maintenance mode.
final class RoutesBootloader extends BaseRoutesBootloader { protected function globalMiddleware(): array { return [ \Spiral\Maintenance\Middleware\PreventRequestInMaintenanceModeMiddleware::class, // ... ]; } }
To enable maintenance mode, execute the down command:
php app.php down
By default, response code for maintenance mode is 503
, but you may set custom response code
php app.php down --status=504
To disable maintenance mode, use the up command:
php app.php up
When your application is in maintenance mode the middleware
throws Spiral\Maintenance\Exception\MaintenanceModeHttpException
with defined status code.
Spiral Framework allows you to pre-render a maintenance mode view that will be returned to the very beginning of the
request cycle. You may pre-render a template of your choice using App\ErrorHandler\ViewRenderer
. By default, it looks
for a template in a folder app/views/exception/{statusCode}.dark.php
You can create a new view file app/views/exception/503.dark.php
:
<extends:layout.base title="[[Maintenance mode]]"/> <use:element path="embed/links" as="homepage:links"/> <stack:push name="styles"> <link rel="stylesheet" href="/styles/welcome.css"/> </stack:push> <define:body> <div class="wrapper"> <img src="/images/503.svg" alt="Error 503" width="300px"/> <h2>{{ $exception->getMessage() ?? 'Maintenance mode' }}</h2> </div> </define:body>
Testing
composer test
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
License
The MIT License (MIT). Please see License File for more information.