Download the PHP package saicosys/cakephp-maintenance without Composer
On this page you can find all versions of the php package saicosys/cakephp-maintenance. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download saicosys/cakephp-maintenance
More information about saicosys/cakephp-maintenance
Files in saicosys/cakephp-maintenance
Package cakephp-maintenance
Short Description Saicosys Maintenance plugin for CakePHP 5
License MIT
Informations about the package cakephp-maintenance
Saicosys Maintenance Plugin
The Saicosys CakePHP Maintenance Plugin for CakePHP allows you to easily enable and manage maintenance mode for your application. Display a customizable maintenance page to users while allowing specific IPs to bypass restrictions. Maintenance mode can be toggled via configuration or CLI, making it suitable for both automated and manual workflows.
Features
- Enable/disable maintenance mode via config file or CLI
- Customizable maintenance page (logo, title, message, etc.)
- Allowlist for specific IP addresses
- Custom HTTP status code and Retry-After header
- Easy integration with CakePHP middleware
- No-downtime activation/deactivation
- Custom template configuration
Use Cases
- Scheduled system upgrades or deployments
- Emergency downtime for bug fixes
- Restricting access to all but admin IPs during sensitive operations
- Displaying a branded message to users during outages
Installation
-
Require the plugin via Composer:
- Load the plugin in your
Application.php
:
Configuration
1. Using the Configuration File
Copy the example config to your app's config directory:
Edit config/maintenance.php
as needed:
Set 'enabled' => true
to activate maintenance mode, or false
to deactivate.
2. Using the CLI (Flag File)
You can also enable maintenance mode by creating a flag file:
To disable maintenance mode:
If either the config 'enabled' => true
or the flag file exists, maintenance mode will be active.
Example: Maintenance Page Output
When maintenance mode is active, users will see a page like:
You can fully customize the logo, title, and message in the config file.
Maintainer
Saicosys Technologies Private Limited
https://www.saicosys.com
Contact: [email protected]
Contributions
Contributions are welcome! Please fork the repository and submit a pull request. For major changes, open an issue first to discuss what you would like to change.
License
This project is licensed under the MIT License.
Copyright (c) 2017-2025, Saicosys Technologies Private Limited