Download the PHP package spiral-packages/maintenance without Composer
On this page you can find all versions of the php package spiral-packages/maintenance. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download spiral-packages/maintenance
More information about spiral-packages/maintenance
Files in spiral-packages/maintenance
Package maintenance
Short Description Disable your application while it is updating or when you are performing maintenance.
License MIT
Homepage https://github.com/spiralpackages/maintenance
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package maintenance
This is my package maintenance
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:
After package install you need to register bootloader from the package.
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.
Usage
Include Spiral\Maintenance\Middleware\PreventRequestInMaintenanceModeMiddleware in your application for routes that
should not have access during maintenance mode.
To enable maintenance mode, execute the down command:
By default, response code for maintenance mode is 503, but you may set custom response code
To disable maintenance mode, use the up command:
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:
Testing
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
- butschster
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
All versions of maintenance with dependencies
spiral/serializer Version ^3.0
spiral/core Version ^3.0
spiral/cache Version ^3.0
spiral/boot Version ^3.0
spiral/console Version ^3.0