lemonphp/cakeplugin-maintenance-mode

A plugin to enable and disable maintenance mode for CakePHP

Introduction

, _(*1)

A plugin to enable and disable maintenance mode for CakePHP, _(*2)

Main features

• [x] Show a page to alert application in maintenance mode
• [x] Allow customize maintenance alert page template
• [x] Allow enable and disable maintenance mode by shell
• [ ] Allow enable and disable maintenance mode by post request
• [ ] Allow access from some IPs when enabled maintenance mode
• [ ] Allow access some URLs when enabled maintenance mode
• [ ] 100% code coverage
• [ ] Support both CakePHP 3.x and 2.x

Requirements

• php >=5.5.9
• cakephp 3.x

Installation

You can install this plugin into your CakePHP application using composer., _(*3)

The recommended way to install composer packages is:, _(*4)

composer require lemonphp/cakeplugin-maintenance-mode

Usage

Enable plugin

Add this line to config/bootstrap.php file, _(*5)

Plugin::load('Lemon/CakePlugin/MaintenanceMode', ['bootstrap' => true]);

Enable maintenance mode

$ bin/cake maintenance_mode enable

Using option --force to enable maintenance mode with default config:, _(*6)

• View class: \App\View\AppView
• Templatce: Pages/maintenance.ctp
• Layout: default
• Time: a hour from now

Disable maintenance mode

$ bin/cake maintenance_mode disable

Changelog

See all change logs in CHANGELOG.md, _(*7)

Contributing

All code contributions must go through a pull request and approved by a core developer before being merged. This is to ensure proper review of all the code., _(*8)

Fork the project, create a feature branch, and send a pull request., _(*9)

To ensure a consistent code base, you should make sure the code follows the PSR-2., _(*10)

If you would like to help take a look at the list of issues., _(*11)

License

This project is released under the MIT License. Copyright © 2015-2016 LemonPHP Team., _(*12)