PHPackages                             awebdeveloper/cakephp-maintenance-mode - 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. awebdeveloper/cakephp-maintenance-mode

ActiveCakephp-plugin

awebdeveloper/cakephp-maintenance-mode
======================================

CakePHP Maintenance Mode

238.1k↓100%4PHP

Since Dec 28Pushed 9y ago3 watchersCompare

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

READMEChangelogDependenciesVersions (1)Used By (0)

Cakephp Maintenance Mode
========================

[](#cakephp-maintenance-mode)

CakePHP Maintenance Mode is to put your website in maintenance mode while you do your upgrade. Most ppl would add a static file on the server and route all request to it during maintenance. The file is shown to everybody including you unless a rewrite rule or expressions is added to exclude yourself which would complicate the matter.

This filter file would tell CakePHP to put all requests to maintenance mode i.e show a msg but would allow requests from your IPs to be processed normally.

\##Requirement CakePHP 2.\*

Installation
------------

[](#installation)

*\[Using [Composer](http://getcomposer.org/)\]*

[View on Packagist](https://packagist.org/packages/awebdeveloper/cakephp-maintenance-mode), and copy the JSON snippet for the latest version into your project's `composer.json`. Eg, v. 1.2.0 would look like this:

```
{
	"require": {
		"awebdeveloper/cakephp-maintenance-mode": "1.2.0"
	}
}

```

Because this plugin has the type `cakephp-plugin` set in it's own `composer.json`, composer knows to install it inside your `/Plugin` directory, rather than in the usual vendor directory. It is recommended that you add `/Plugin/MaintenanceMode` to your .gitignore file. (Why? [Read this](http://getcomposer.org/doc/faqs/should-i-commit-the-dependencies-in-my-vendor-directory.md).)

*\[Manual\]*

- Download this:
- Unzip that download.
- Copy the resulting folder to `app/Plugin`
- Rename the folder you just copied to `MaintenanceMode`

*\[GIT Submodule\]*

In your app directory type:

```
git submodule add -b master git://github.com/awebdeveloper/cakephp-maintenance-mode.git Plugin/MaintenanceMode
git submodule init
git submodule update

```

*\[GIT Clone\]*

In your `Plugin` directory type:

```
git clone -b master git://github.com/awebdeveloper/cakephp-maintenance-mode.git MaintenanceMode

```

### Usage

[](#usage)

In your **Bootstrap.php** add

```
Configure::write('MaintenanceMode', array(
	'enabled' => true,
	'view' =>	array(
		'layout' => '',
		'template' => 'MaintenanceMode/index'
	),
	'ip_filters' => array('127.0.*.*')
));
```

Also in the same file find the below code and add this line

```
Configure::write('Dispatcher.filters', array(
    'AssetDispatcher',
    'CacheDispatcher',
    'MaintenanceMode.MaintenanceMode' ## this line
));
```

### Parameters

[](#parameters)

It supports Following Parameters

1. **enabled** set this to *true* to enable it
2. **view** this is a array that accepts the template and the layout. If layout key is absent it will use the default layout.

    ```
    	'view' =>	array(
    		'template' => 'Pages/index'
    	),

    ```

    or

    ```
    	'view' =>	array(
     		'layout' => 'main',
    		'template' => 'MaintenanceMode/index'
    	),

    ```
3. **ip\_filters** this is either a string containing a single IP or an array containing multiple IPs for which maintainance mode will NOT be applied.

    ```
    	'ip_filters' => array('127.0.*.*','201.201.201.1')

    ```

    or

    ```
    	'ip_filters' => '201.201.201.1'

    ```

For info read the docs on dispatch filter

###  Health Score

28

—

LowBetter than 54% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity30

Limited adoption so far

Community13

Small or concentrated contributor base

Maturity41

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 80% 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.

### Community

Maintainers

![](https://www.gravatar.com/avatar/9bed63330d5abdbd5d37c968b8fe48d92343ecfb851c2c06b325dfd7a8e923f9?d=identicon)[awebdeveloper](/maintainers/awebdeveloper)

---

Top Contributors

[![awebdeveloper](https://avatars.githubusercontent.com/u/1593429?v=4)](https://github.com/awebdeveloper "awebdeveloper (12 commits)")[![josegonzalez](https://avatars.githubusercontent.com/u/65675?v=4)](https://github.com/josegonzalez "josegonzalez (3 commits)")

### Embed Badge

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

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

PHPackages © 2026

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