PHPackages                             saicosys/cakephp-maintenance - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility &amp; Helpers](/categories/utility)
4. /
5. saicosys/cakephp-maintenance

ActiveCakephp-plugin[Utility &amp; Helpers](/categories/utility)

saicosys/cakephp-maintenance
============================

Saicosys Maintenance plugin for CakePHP 5

v1.0.3(10mo ago)17MITPHPPHP &gt;=8.1

Since Jul 15Pushed 10mo ago1 watchersCompare

[ Source](https://github.com/saicosys/cakephp-maintenance-mode-plugin)[ Packagist](https://packagist.org/packages/saicosys/cakephp-maintenance)[ RSS](/packages/saicosys-cakephp-maintenance/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (4)Dependencies (4)Versions (5)Used By (0)

Saicosys Maintenance Plugin
===========================

[](#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
--------

[](#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
---------

[](#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
------------

[](#installation)

1. **Require the plugin via Composer:**

    ```
    composer require saicosys/cakephp-maintenance
    ```
2. **Load the plugin in your `Application.php`:**

    ```
    bin/cake plugin load Saicosys/Maintenance
    ```

Configuration
-------------

[](#configuration)

### 1. Using the Configuration File

[](#1-using-the-configuration-file)

Copy the example config to your app's config directory:

```
cp vendor/Saicosys/Maintenance/config/maintenance.example.php config/maintenance.php
```

Edit `config/maintenance.php` as needed:

```
return [
    'maintenance' => [
        'enabled' => true, // Enable or disable maintenance mode
        'view' => [
            'layout' => 'default.php',
            'template' => null,
        ],
        'variables' => [
            'logo' => 'logo.png',
            'alt' => 'Company',
            'title' => 'System Maintenance',
            'message' => 'We are upgrading our systems. Please try again later.'
        ],
        'allowedIPs' => ['127.0.0.1', '::1'],
        'statusCode' => 503,
        'retryAfter' => 3600
    ],
];
```

Set `'enabled' => true` to activate maintenance mode, or `false` to deactivate.

### 2. Using the CLI (Flag File)

[](#2-using-the-cli-flag-file)

You can also enable maintenance mode by creating a flag file:

```
bin/cake maintenance enable
```

To disable maintenance mode:

```
bin/cake maintenance disable
```

If either the config `'enabled' => true` **or** the flag file exists, maintenance mode will be active.

Example: Maintenance Page Output
--------------------------------

[](#example-maintenance-page-output)

When maintenance mode is active, users will see a page like:

```
+--------------------------+
|   [Your Logo Here]       |
|   System Maintenance     |
|   We are upgrading...    |
+--------------------------+

```

You can fully customize the logo, title, and message in the config file.

Maintainer
----------

[](#maintainer)

**Saicosys Technologies Private Limited**

Contact:

Contributions
-------------

[](#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
-------

[](#license)

This project is licensed under the [MIT License](https://opensource.org/licenses/mit-license.php).

Copyright (c) 2017-2025, Saicosys Technologies Private Limited

###  Health Score

32

—

LowBetter than 72% of packages

Maintenance55

Moderate activity, may be stable

Popularity7

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity48

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 85.7% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~0 days

Total

4

Last Release

300d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/a4a909ae244db4021f4e9cfc19fab7b19af94171a62a495b980c98d4c0bbff50?d=identicon)[sandeep-kadyan](/maintainers/sandeep-kadyan)

---

Top Contributors

[![sandeep-kadyan](https://avatars.githubusercontent.com/u/63108804?v=4)](https://github.com/sandeep-kadyan "sandeep-kadyan (6 commits)")[![saicosys](https://avatars.githubusercontent.com/u/10906005?v=4)](https://github.com/saicosys "saicosys (1 commits)")

---

Tags

 maintenance modecakephp 5maintenance mode plugin

###  Code Quality

TestsPHPUnit

Static AnalysisPHPStan

Type Coverage Yes

### Embed Badge

![Health badge](/badges/saicosys-cakephp-maintenance/health.svg)

```
[![Health](https://phpackages.com/badges/saicosys-cakephp-maintenance/health.svg)](https://phpackages.com/packages/saicosys-cakephp-maintenance)
```

###  Alternatives

[markstory/asset_compress

An asset compression plugin for CakePHP. Provides file concatenation and a flexible filter system for preprocessing and minification.

3761.0M11](/packages/markstory-asset-compress)[cakedc/cakephp-phpstan

CakePHP plugin extension for PHPStan.

40676.6k31](/packages/cakedc-cakephp-phpstan)[dereuromark/cakephp-dto

A CakePHP plugin for generating immutable Data Transfer Objects with full type safety

2988.9k3](/packages/dereuromark-cakephp-dto)[cakedc/enum

Enumeration list Plugin for CakePHP 5

30222.5k2](/packages/cakedc-enum)[thisisbd/silverstripe-maintenance-mode

SilverStripe Maintenance Mode Module. Allows an administrator to put site in offline mode with 503 status to display a 'Coming Soon', 'Under Construction' or 'Down for Maintenance' Page to regular visitors, whilst allowing a logged in admin user to browse and make changes to the site.

2311.6k](/packages/thisisbd-silverstripe-maintenance-mode)[havokinspiration/wrench

Maintenance mode plugin for CakePHP 3.X

2661.2k](/packages/havokinspiration-wrench)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
