j3rrey/lumen-5-maintenance-mode

Define application maintenance mode.

1.3.0 2019-06-07 10:03 UTC

This package is auto-updated.

Last update: 2024-11-14 20:23:16 UTC


README

Build Status

php 7.2 Lumen 5.8

How to install

composer require j3rrey/lumen-5-maintenance-mode

How to configure

Add this to your AppServiceProvider or in bootstrap/app.php

$app->register(
    j3rrey\MaintenanceMode\Providers\MaintenanceModeServiceProvider::class
);

Add the up and down commands in app/console/Kernel.php

    protected $commands = [
        \j3rrey\MaintenanceMode\Console\Commands\DownCommand::class,
        \j3rrey\MaintenanceMode\Console\Commands\UpCommand::class
    ];

Customize View

In case there is no 503 view file you will be asked if it should be created for you when putting your application in maintenance mode.

Example views at the bottom

resources/views/errors/503.blade.php

Maintenance Mode on

php artisan down

Maintenance Mode off

php artisan up

IP based access

Currently only ipv4 and no ipranges

Add ALLOWED_IPS in your .env file

ALLOWED_IPS=192.168.1.2,127.0.0.1,136.22.16.0

Features planned:

  • Ip Ranges,
  • Maintenance without view options
  • Dynamic DNS Ip Filtering

Example view

Laravel 503 blade file(2016): https://github.com/laravel/laravel/blob/696ab5149e6b6169f73b75321eaabf47a4a26645/resources/views/errors/503.blade.php

Default View:

Default View