README

A module for providing maintenance mode redirection for Yii2 web applications

Installation

Install Using Composer

The preferred way to install this extension is through composer.

Either run

$ php composer.phar require humanized/yii2-maintenance "dev-master"

or add

"humanized/yii2-maintenance": "dev-master"

to the require section of your composer.json file.

Configuration

Prerequisites

By default, redirection is disabled for routes set through Yii::$app->errorHandler->errorAction and Yii::$app->user->loginUrl[0]

Ensure that appropriate values are set through respective component configuration parameters.

This can be enabled by setting the whitelistLoginUrl and whitelistErrorAction to false

Step 1

The module works by creating/dropping a file somewhere on the filesystem. To specify it's path, add an alias "@maintenance" to the the config/bootstrap file:

Yii::setAlias('@common', dirname(__DIR__));
Yii::setAlias('@backend', dirname(dirname(__DIR__)) . '/backend');
Yii::setAlias('@frontend', dirname(dirname(__DIR__)) . '/frontend');
Yii::setAlias('@maintenance', dirname(dirname(__DIR__)) . '/frontent/runtime/maintenance');

Add specific aliases to different application config/bootstap files to allow maintenance-mode on different applications within the same yii project.

Step 2

The module comes with a redirecton behavior, which is triggered before a controller-action event. When attached to a controller, a 503 - Service Unavailable - HTTP exception is thrown when maintenance mode is enabled.

To call the behavior before each request of the application to be placed under maintenance, add following lines to the configuration file:

return [
    'id' => 'application-name',
    ...
    'as beforeAction'=>[ 
      'class'=>'humanized\maintenance\components\behaviors\RedirectionBehavior',
    ]
    ...
],

For full instructions on how to configure the behavior, check the CONFIG-file.

Step 3 (Optional)

Command Line Interface

Add following lines to the console configuration file to enable the CLI:

'modules' => [
    'maintenance' => [
        'class' => 'humanized\maintenance\Module',
    ],
],

Adding these lines allows access to the CLI provided by the module. Here, the chosen module-name is maintenance, as such the various routes will be available at maintenance/controller-id/action-id, though any module-name can be chosen.

For full instructions on how to use the command-line interface portion of this module, check the CLI-file.

Graphical User Interface

This package provides several components for building custom GUI solutions:

First, the various controller actions for toggling maintenance mode are available in humanized\maintenance\actions.
These external actions can then be attached to the

Add following lines to the web-application configuration file to enable the sample controller :

'modules' => [
    'maintenance' => [
        'class' => 'humanized\maintenance\Module',
    ],
],